diff --git a/providers/src/aws/v00.00.00000/provider.yaml b/providers/src/aws/v00.00.00000/provider.yaml index 32aebf31..e0f3f110 100644 --- a/providers/src/aws/v00.00.00000/provider.yaml +++ b/providers/src/aws/v00.00.00000/provider.yaml @@ -20,6 +20,15 @@ providerServices: title: account API version: v00.00.00000 description: AWS Account + account_access: + id: account_access:v00.00.00000 + name: account_access + preferred: true + service: + $ref: aws/v00.00.00000/services/account_access.yaml + title: account_access API + version: v00.00.00000 + description: Account Access acm: id: acm:v00.00.00000 name: acm @@ -38,6 +47,24 @@ providerServices: title: acm_pca API version: v00.00.00000 description: AWS Certificate Manager Private Certificate Authority + agent_registry: + id: agent_registry:v00.00.00000 + name: agent_registry + preferred: true + service: + $ref: aws/v00.00.00000/services/agent_registry.yaml + title: agent_registry API + version: v00.00.00000 + description: Agent Registry + agent_registry_control: + id: agent_registry_control:v00.00.00000 + name: agent_registry_control + preferred: true + service: + $ref: aws/v00.00.00000/services/agent_registry_control.yaml + title: agent_registry_control API + version: v00.00.00000 + description: Agent Registry Control aiops: id: aiops:v00.00.00000 name: aiops @@ -1685,24 +1712,6 @@ providerServices: title: iotdeviceadvisor API version: v00.00.00000 description: AWS IoT Core Device Advisor - iotevents: - id: iotevents:v00.00.00000 - name: iotevents - preferred: true - service: - $ref: aws/v00.00.00000/services/iotevents.yaml - title: iotevents API - version: v00.00.00000 - description: AWS IoT Events - iotevents_data: - id: iotevents_data:v00.00.00000 - name: iotevents_data - preferred: true - service: - $ref: aws/v00.00.00000/services/iotevents_data.yaml - title: iotevents_data API - version: v00.00.00000 - description: AWS IoT Events Data iotfleetwise: id: iotfleetwise:v00.00.00000 name: iotfleetwise @@ -1928,6 +1937,24 @@ providerServices: title: lambda API version: v00.00.00000 description: AWS Lambda + lambda_core: + id: lambda_core:v00.00.00000 + name: lambda_core + preferred: true + service: + $ref: aws/v00.00.00000/services/lambda_core.yaml + title: lambda_core API + version: v00.00.00000 + description: AWS Lambda Core + lambda_microvms: + id: lambda_microvms:v00.00.00000 + name: lambda_microvms + preferred: true + service: + $ref: aws/v00.00.00000/services/lambda_microvms.yaml + title: lambda_microvms API + version: v00.00.00000 + description: Lambda MicroVMs launch_wizard: id: launch_wizard:v00.00.00000 name: launch_wizard @@ -2522,15 +2549,6 @@ providerServices: title: outposts API version: v00.00.00000 description: AWS Outposts - panorama: - id: panorama:v00.00.00000 - name: panorama - preferred: true - service: - $ref: aws/v00.00.00000/services/panorama.yaml - title: panorama API - version: v00.00.00000 - description: AWS Panorama partnercentral_account: id: partnercentral_account:v00.00.00000 name: partnercentral_account @@ -2702,6 +2720,15 @@ providerServices: title: pricing API version: v00.00.00000 description: AWS Price List Service + pricing_plan_manager: + id: pricing_plan_manager:v00.00.00000 + name: pricing_plan_manager + preferred: true + service: + $ref: aws/v00.00.00000/services/pricing_plan_manager.yaml + title: pricing_plan_manager API + version: v00.00.00000 + description: PricingPlanManager proton: id: proton:v00.00.00000 name: proton @@ -2828,6 +2855,15 @@ providerServices: title: resiliencehub API version: v00.00.00000 description: AWS Resilience Hub + resiliencehubv2: + id: resiliencehubv2:v00.00.00000 + name: resiliencehubv2 + preferred: true + service: + $ref: aws/v00.00.00000/services/resiliencehubv2.yaml + title: resiliencehubv2 API + version: v00.00.00000 + description: AWS Resilience Hub V2 resource_explorer_2: id: resource_explorer_2:v00.00.00000 name: resource_explorer_2 @@ -3062,6 +3098,15 @@ providerServices: title: sagemaker_metrics API version: v00.00.00000 description: Amazon SageMaker Metrics Service + sagemakerjobruntime: + id: sagemakerjobruntime:v00.00.00000 + name: sagemakerjobruntime + preferred: true + service: + $ref: aws/v00.00.00000/services/sagemakerjobruntime.yaml + title: sagemakerjobruntime API + version: v00.00.00000 + description: Sagemaker Job Runtime Service savingsplans: id: savingsplans:v00.00.00000 name: savingsplans @@ -3251,15 +3296,6 @@ providerServices: title: simpledbv2 API version: v00.00.00000 description: Amazon SimpleDB v2 - simspaceweaver: - id: simspaceweaver:v00.00.00000 - name: simspaceweaver - preferred: true - service: - $ref: aws/v00.00.00000/services/simspaceweaver.yaml - title: simspaceweaver API - version: v00.00.00000 - description: AWS SimSpace Weaver sms_voice: id: sms_voice:v00.00.00000 name: sms_voice @@ -3449,6 +3485,15 @@ providerServices: title: support_app API version: v00.00.00000 description: AWS Support App + supportauthz: + id: supportauthz:v00.00.00000 + name: supportauthz + preferred: true + service: + $ref: aws/v00.00.00000/services/supportauthz.yaml + title: supportauthz API + version: v00.00.00000 + description: SupportAuthZ sustainability: id: sustainability:v00.00.00000 name: sustainability diff --git a/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml b/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml index 348fc976..c61e1b26 100644 --- a/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml +++ b/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml @@ -241,7 +241,7 @@ paths: type: object properties: analyzerName: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" type: $ref: "#/components/schemas/Type" archiveRules: @@ -300,7 +300,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the created analyzer. requestBody: required: true @@ -329,7 +329,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer to retrieve rules from. - name: nextToken in: query @@ -350,6 +350,35 @@ paths: application/json: schema: $ref: "#/components/schemas/ListArchiveRulesResponse" + /service-linked-analyzer: + put: + operationId: CreateServiceLinkedAnalyzer + description: Creates a service-linked analyzer managed by an Amazon Web Services service. This operation can only be invoked by authorized Amazon Web Services services. Direct customer invocation returns AccessDeniedException. Service-linked analyzers enable Amazon Web Services services to create and manage analyzers on behalf of customers. The lifecycle of these analyzers is managed by the calling service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + type: + $ref: "#/components/schemas/Type" + archiveRules: + $ref: "#/components/schemas/InlineArchiveRulesList" + clientToken: + $ref: "#/components/schemas/String" + configuration: + $ref: "#/components/schemas/AnalyzerConfiguration" + required: + - type + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateServiceLinkedAnalyzerResponse" /analyzer/{analyzer_name}: delete: operationId: DeleteAnalyzer @@ -359,7 +388,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer to delete. - name: clientToken in: query @@ -378,7 +407,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer retrieved. responses: "200": @@ -395,7 +424,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer to modify. requestBody: required: false @@ -422,7 +451,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer that associated with the archive rule to delete. - name: rule_name in: path @@ -447,7 +476,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer to retrieve rules from. - name: rule_name in: path @@ -470,7 +499,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer to update the archive rules for. - name: rule_name in: path @@ -494,6 +523,26 @@ paths: responses: "200": description: Success + /service-linked-analyzer/{analyzer_name}: + delete: + operationId: DeleteServiceLinkedAnalyzer + description: Deletes a service-linked analyzer. This operation can be invoked by both authorized Amazon Web Services services and customers. When invoked by a customer, IAM Access Analyzer performs a callback to the managing service to verify whether the analyzer is still in use and can be deleted. If the service indicates the analyzer is still in use, the deletion is rejected with ConflictException. + parameters: + - name: analyzer_name + in: path + required: true + schema: + $ref: "#/components/schemas/AnalyzerName" + description: The name of the service-linked analyzer to delete. Service-linked analyzer names follow the format _AccessAnalyzerFor{ServiceName}-{Id}. + - name: clientToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: A client token. + responses: + "200": + description: Success /recommendation/{id}: post: operationId: GenerateFindingRecommendation @@ -1229,6 +1278,11 @@ components: AccessPreviewId: type: string pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + AnalyzerName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z_][A-Za-z0-9_.-]*" Type: type: string enum: @@ -1376,6 +1430,13 @@ components: FilterCriteriaMap: type: object properties: {} + CreateServiceLinkedAnalyzerResponse: + description: The response to the request to create a service-linked analyzer. + type: object + properties: + arn: + $ref: "#/components/schemas/AnalyzerArn" + description: The ARN of the service-linked analyzer that was created by the request. The analyzer name follows the format _AccessAnalyzerFor{ServiceName}-{Id} where Id is a randomly generated identifier. GenerateFindingRecommendationRequestIdString: type: string minLength: 1 @@ -1528,7 +1589,7 @@ components: $ref: "#/components/schemas/AnalyzerArn" description: The ARN of the analyzer. name: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/AnalyzerName" description: The name of the analyzer. type_: $ref: "#/components/schemas/Type" @@ -1555,6 +1616,9 @@ components: configuration: $ref: "#/components/schemas/AnalyzerConfiguration" description: Specifies if the analyzer is an external access, unused access, or internal access analyzer. The GetAnalyzer action includes this property in its response if a configuration is specified, while the ListAnalyzers action omits it. + managedBy: + $ref: "#/components/schemas/String" + description: The service principal that manages this analyzer (for example, securityhubv2.amazonaws.com). This field is only present for service-linked analyzers and is not included for customer-managed analyzers. required: - arn - name @@ -2971,6 +3035,17 @@ components: responseToken: key: $.nextToken location: body + create_service_linked_analyzer: + operation: + $ref: "#/paths/~1service-linked-analyzer/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive delete_analyzer: operation: $ref: "#/paths/~1analyzer~1{analyzer_name}/delete" @@ -2996,6 +3071,11 @@ components: config: requestBodyTranslate: algorithm: naive + delete_service_linked_analyzer: + operation: + $ref: "#/paths/~1service-linked-analyzer~1{analyzer_name}/delete" + response: + openAPIDocKey: "200" start_resource_scan: operation: $ref: "#/paths/~1resource~1scan/post" @@ -3012,6 +3092,7 @@ components: - $ref: "#/components/x-stackQL-resources/analyzers/methods/list_analyzers" insert: - $ref: "#/components/x-stackQL-resources/analyzers/methods/create_analyzer" + - $ref: "#/components/x-stackQL-resources/analyzers/methods/create_service_linked_analyzer" update: - $ref: "#/components/x-stackQL-resources/analyzers/methods/update_analyzer" delete: diff --git a/providers/src/aws/v00.00.00000/services/account.yaml b/providers/src/aws/v00.00.00000/services/account.yaml index 7267959e..1735a0ab 100644 --- a/providers/src/aws/v00.00.00000/services/account.yaml +++ b/providers/src/aws/v00.00.00000/services/account.yaml @@ -219,6 +219,27 @@ paths: application/json: schema: $ref: "#/components/schemas/GetPrimaryEmailResponse" + /getPrimaryEmailUpdateStatus: + post: + operationId: GetPrimaryEmailUpdateStatus + description: Retrieves the status of the most recent primary email update for the specified account. For complete details about how to update the primary email address, see Update the primary email address for your AWS account. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + AccountId: + $ref: "#/components/schemas/AccountId" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetPrimaryEmailUpdateStatusResponse" /getRegionOptStatus: post: operationId: GetRegionOptStatus @@ -438,6 +459,8 @@ components: enum: - PENDING - ACCEPTED + - COMPLETED + - FAILED AlternateContactType: type: string enum: @@ -640,6 +663,20 @@ components: PrimaryEmail: $ref: "#/components/schemas/PrimaryEmailAddress" description: Retrieves the primary email address associated with the specified account. + GetPrimaryEmailUpdateStatusResponse: + type: object + properties: + Status: + $ref: "#/components/schemas/PrimaryEmailUpdateStatus" + description: The status of the most recent primary email update request. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the most recent primary email update status was last changed. + required: + - Status + Timestamp: + type: string + format: date-time GetRegionOptStatusResponse: type: object properties: @@ -920,6 +957,28 @@ components: insert: [] update: [] delete: [] + primary_email_update_status: + id: aws.account.primary_email_update_status + name: primary_email_update_status + title: primary_email_update_status + methods: + get_primary_email_update_status: + operation: + $ref: "#/paths/~1getPrimaryEmailUpdateStatus/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/primary_email_update_status/methods/get_primary_email_update_status" + insert: [] + update: [] + delete: [] region_opt_status: id: aws.account.region_opt_status name: region_opt_status diff --git a/providers/src/aws/v00.00.00000/services/account_access.yaml b/providers/src/aws/v00.00.00000/services/account_access.yaml new file mode 100644 index 00000000..edfe2de6 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/account_access.yaml @@ -0,0 +1,865 @@ +openapi: 3.0.0 +info: + version: "2018-05-10" + title: Account Access + description: Account Access + x-serviceName: account-access + x-serviceAlias: account_access + x-protocol: rest-json + x-apiVersion: "2018-05-10" + x-endpointPrefix: account-access +servers: + - url: https://account-access.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for account-access +paths: + /applications: + post: + operationId: CreateApplication + description: Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance. This operation is idempotent; calling it multiple times with the same parameters returns the existing application. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + identitySource: + $ref: "#/components/schemas/IdentitySource" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - identitySource + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateApplicationResponse" + /entitlements: + post: + operationId: CreateEntitlement + description: Creates an entitlement (assignment) in account access manager. An entitlement (assignment) grants a principal (IAM Identity Center user or group) permission to assume a specified IAM role in an Amazon Web Services account. This operation is idempotent. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + applicationArn: + $ref: "#/components/schemas/ApplicationArn" + entitlement: + $ref: "#/components/schemas/Entitlement" + required: + - applicationArn + - entitlement + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateEntitlementResponse" + /applications/{application_arn}: + delete: + operationId: DeleteApplication + description: Deletes an account access manager application. This operation is idempotent; deleting an application that has already been deleted does not return an error. + parameters: + - name: application_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the application to delete. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteApplicationResponse" + get: + operationId: GetApplication + description: Retrieves details about an account access manager application, including its status, identity source, and tags. + parameters: + - name: application_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the application to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetApplicationResponse" + /entitlements/{entitlement_id}: + delete: + operationId: DeleteEntitlement + description: Deletes an entitlement from an account access manager application. This operation is idempotent; deleting an entitlement that has already been deleted does not return an error. + parameters: + - name: applicationArn + in: query + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the application that the entitlement belongs to. + - name: entitlement_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: Specifies the unique identifier of the entitlement to delete. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteEntitlementResponse" + get: + operationId: GetEntitlement + description: Retrieves details about a specific entitlement for an account access manager application, including the principal, IAM role, and target account. + parameters: + - name: applicationArn + in: query + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the application that the entitlement belongs to. + - name: entitlement_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: Specifies the unique identifier of the entitlement to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEntitlementResponse" + /applications-list: + post: + operationId: ListApplications + description: Lists the account access manager applications in your account. Use pagination to ensure that the operation returns quickly and successfully. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/ListApplicationsRequestMaxResultsInteger" + nextToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListApplicationsResponse" + /entitlements-list: + post: + operationId: ListEntitlements + description: Lists the entitlements for a specified account access manager application. You can filter results by principal, IAM role, or account. Use pagination to ensure that the operation returns quickly and successfully. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + applicationArn: + $ref: "#/components/schemas/ApplicationArn" + filter: + $ref: "#/components/schemas/EntitlementFilter" + nextToken: + $ref: "#/components/schemas/String" + maxResults: + $ref: "#/components/schemas/ListEntitlementsRequestMaxResultsInteger" + required: + - applicationArn + - filter + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListEntitlementsResponse" + /tags/{resource_arn}: + get: + operationId: ListTagsForResource + description: Lists the tags associated with an account access manager resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the resource to list tags for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + post: + operationId: TagResource + description: Adds tags to an account access manager resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the resource to add tags to. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tags: + $ref: "#/components/schemas/TagsMap" + required: + - tags + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceResponse" + delete: + operationId: UntagResource + description: Removes tags from an account access manager resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationArn" + description: Specifies the ARN of the resource to remove tags from. + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeys" + description: Specifies the tag keys to remove from the resource. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + IdentitySource: + description: Specifies the identity source for an account access manager application. + type: object + properties: + identityCenter: + $ref: "#/components/schemas/IdentityCenter" + description: The IAM Identity Center instance to use as the identity source. + IdentityCenter: + description: Specifies the IAM Identity Center instance to use as the identity source for an application. + type: object + properties: + instanceArn: + $ref: "#/components/schemas/IdentityCenterInstanceArn" + description: The ARN of the IAM Identity Center instance. + required: + - instanceArn + IdentityCenterInstanceArn: + type: string + minLength: 10 + maxLength: 1224 + pattern: arn:[a-z0-9-]+:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + TagsMap: + type: object + properties: {} + CreateApplicationResponse: + type: object + properties: + applicationArn: + $ref: "#/components/schemas/ApplicationArn" + description: The Amazon Resource Name (ARN) of the created application. + required: + - applicationArn + ApplicationArn: + type: string + minLength: 49 + maxLength: 2048 + pattern: arn:[a-z0-9-]+:account-access:[a-z0-9]+(-[a-z0-9]+)*:[0-9]{12}:application/[a-zA-Z0-9-]+ + Entitlement: + description: Specifies the entitlement configuration for an account access manager application, defining which principal can assume which IAM role. + type: object + properties: + principalRole: + $ref: "#/components/schemas/PrincipalRoleEntitlement" + description: The principal-to-role mapping for the entitlement. + PrincipalRoleEntitlement: + description: Specifies a principal-to-role entitlement that grants an IAM Identity Center principal permission to assume an IAM role. + type: object + properties: + principal: + $ref: "#/components/schemas/Principal" + description: The principal (user or group) that is granted access to assume the IAM role. + roleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role that the principal can assume. + required: + - principal + - roleArn + Principal: + description: Identifies a principal (user or group) that can be granted entitlements. + type: object + properties: + identityCenter: + $ref: "#/components/schemas/IdentityCenterPrincipal" + description: The IAM Identity Center principal (user or group). + IdentityCenterPrincipal: + description: Identifies a user or group from IAM Identity Center. + type: object + properties: + userId: + $ref: "#/components/schemas/UserId" + description: The unique identifier of a user in IAM Identity Center. + groupId: + $ref: "#/components/schemas/GroupId" + description: The unique identifier of a group in IAM Identity Center. + UserId: + type: string + minLength: 1 + maxLength: 47 + pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12} + GroupId: + type: string + minLength: 1 + maxLength: 47 + pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12} + RoleArn: + type: string + pattern: arn:[a-z0-9-]+:iam::[0-9]{12}:role/([a-zA-Z0-9+=,.@_-]+/)*[a-zA-Z0-9+=,.@_-]+ + CreateEntitlementResponse: + type: object + properties: + entitlementId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created entitlement. + required: + - entitlementId + String: + type: string + DeleteApplicationResponse: + type: object + DeleteEntitlementResponse: + type: object + GetApplicationResponse: + type: object + properties: + identitySource: + $ref: "#/components/schemas/IdentitySourceDetails" + description: The identity source details for the application, including the IAM Identity Center instance configuration. + status: + $ref: "#/components/schemas/Status" + description: The current status of the application. + tenantId: + $ref: "#/components/schemas/String" + description: The tenant identifier associated with the application. + createdAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the application was created. + updatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the application was last updated. + tags: + type: object + properties: {} + description: The tags associated with the application. + error: + $ref: "#/components/schemas/ErrorDetails" + description: The error details if the application is in a failed state. + required: + - identitySource + - status + - createdAt + - updatedAt + IdentitySourceDetails: + description: Contains detailed information about the identity source for an application. + type: object + properties: + identityCenter: + $ref: "#/components/schemas/IdentityCenterDetails" + description: The IAM Identity Center configuration details for the identity source. + IdentityCenterDetails: + description: Contains detailed information about the IAM Identity Center configuration for an application. + type: object + properties: + instanceArn: + $ref: "#/components/schemas/IdentityCenterInstanceArn" + description: The ARN of the IAM Identity Center instance. + applicationArn: + $ref: "#/components/schemas/IdentityCenterApplicationArn" + description: The ARN of the IAM Identity Center application created for this account access manager application. + required: + - instanceArn + IdentityCenterApplicationArn: + type: string + minLength: 10 + maxLength: 1224 + pattern: arn:[a-z0-9-]+:sso::[0-9]{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16} + Status: + type: string + enum: + - CREATE_IN_PROGRESS + - ACTIVE + - DELETE_IN_PROGRESS + - CREATE_FAILED + - DELETE_FAILED + DateTime: + type: string + format: date-time + ErrorDetails: + description: Contains information about an error that occurred during application processing. + type: object + properties: + code: + $ref: "#/components/schemas/ErrorCode" + description: The error code that identifies the type of error. + message: + $ref: "#/components/schemas/String" + description: A human-readable message that describes the error. + required: + - code + - message + ErrorCode: + type: string + enum: + - AUTHORIZATION_ERROR + - RESOURCE_NOT_FOUND_ERROR + - SERVICE_QUOTA_EXCEEDED_ERROR + - INTERNAL_SERVICE_ERROR + GetEntitlementResponse: + type: object + properties: + applicationArn: + $ref: "#/components/schemas/ApplicationArn" + description: The ARN of the application that the entitlement belongs to. + entitlementId: + $ref: "#/components/schemas/String" + description: The unique identifier of the entitlement. + entitlement: + $ref: "#/components/schemas/EntitlementDetails" + description: The entitlement details, including the principal, IAM role, and target account. + createdAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the entitlement was created. + required: + - applicationArn + - entitlementId + - entitlement + - createdAt + EntitlementDetails: + description: Contains detailed information about an entitlement, including the principal, IAM role, and target account. + type: object + properties: + principalRole: + $ref: "#/components/schemas/PrincipalRoleEntitlementDetails" + description: The principal-to-role mapping details for the entitlement, including the target account. + PrincipalRoleEntitlementDetails: + description: Contains detailed information about a principal-to-role entitlement, including the target account. + type: object + properties: + principal: + $ref: "#/components/schemas/Principal" + description: The principal (user or group) that is granted access to assume the IAM role. + roleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role that the principal can assume. + account: + $ref: "#/components/schemas/Account" + description: The 12-digit Amazon Web Services account ID where the IAM role resides. + accountName: + $ref: "#/components/schemas/String" + description: The friendly name of the Amazon Web Services account where the IAM role resides. + required: + - principal + - roleArn + - account + Account: + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]{12}" + ListApplicationsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListApplicationsResponse: + type: object + properties: + applications: + $ref: "#/components/schemas/ApplicationList" + description: The list of applications. + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next set of results. This value is null when there are no more results to return. + required: + - applications + ApplicationList: + type: array + items: + $ref: "#/components/schemas/ApplicationSummary" + ApplicationSummary: + description: Contains summary information about an account access manager application. + type: object + properties: + applicationArn: + $ref: "#/components/schemas/ApplicationArn" + description: The ARN of the application. + tenantId: + $ref: "#/components/schemas/String" + description: The tenant identifier associated with the application. + createdAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the application was created. + updatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the application was last updated. + required: + - applicationArn + - createdAt + - updatedAt + EntitlementFilter: + description: Specifies filter criteria for listing entitlements. + type: object + properties: + principalRole: + $ref: "#/components/schemas/PrincipalRoleEntitlementFilter" + description: The principal-to-role filter criteria for narrowing entitlement results. + PrincipalRoleEntitlementFilter: + description: Specifies filter criteria for principal-to-role entitlements. All specified criteria must match for an entitlement to be returned. + type: object + properties: + principal: + $ref: "#/components/schemas/PrincipalFilter" + description: The principal to filter entitlements by. + roleArn: + $ref: "#/components/schemas/RoleArn" + description: The IAM role ARN to filter entitlements by. + account: + $ref: "#/components/schemas/Account" + description: The 12-digit Amazon Web Services account ID to filter entitlements by. + PrincipalFilter: + description: Specifies filter criteria for a principal. + type: object + properties: + identityCenter: + $ref: "#/components/schemas/IdentityCenterPrincipalFilter" + description: The IAM Identity Center principal filter criteria. + IdentityCenterPrincipalFilter: + description: Specifies filter criteria for an IAM Identity Center principal. + type: object + properties: + userId: + $ref: "#/components/schemas/UserId" + description: The unique identifier of a user in IAM Identity Center to filter by. + groupId: + $ref: "#/components/schemas/GroupId" + description: The unique identifier of a group in IAM Identity Center to filter by. + ListEntitlementsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListEntitlementsResponse: + type: object + properties: + entitlements: + $ref: "#/components/schemas/EntitlementsList" + description: The list of entitlements for the specified application. + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next set of results. This value is null when there are no more results to return. + required: + - entitlements + EntitlementsList: + type: array + items: + $ref: "#/components/schemas/EntitlementsListMember" + EntitlementsListMember: + description: Contains information about an entitlement in a list result. + type: object + properties: + entitlementId: + $ref: "#/components/schemas/String" + description: The unique identifier of the entitlement. + entitlement: + $ref: "#/components/schemas/EntitlementSummary" + description: The summary information for the entitlement. + createdAt: + $ref: "#/components/schemas/DateTime" + description: The date and time when the entitlement was created. + required: + - entitlementId + - entitlement + - createdAt + EntitlementSummary: + description: Contains summary information about an entitlement. + type: object + properties: + principalRole: + $ref: "#/components/schemas/PrincipalRoleEntitlementSummary" + description: The principal-to-role mapping summary for the entitlement. + PrincipalRoleEntitlementSummary: + description: Contains summary information about a principal-to-role entitlement. + type: object + properties: + principal: + $ref: "#/components/schemas/Principal" + description: The principal (user or group) that is granted access to assume the IAM role. + roleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role that the principal can assume. + account: + $ref: "#/components/schemas/Account" + description: The 12-digit Amazon Web Services account ID where the IAM role resides. + accountName: + $ref: "#/components/schemas/String" + description: The friendly name of the Amazon Web Services account where the IAM role resides. + required: + - principal + - roleArn + - account + ListTagsForResourceResponse: + type: object + properties: + tags: + type: object + properties: {} + description: The tags associated with the resource. + TagResourceResponse: + type: object + TagKeys: + type: array + items: + $ref: "#/components/schemas/String" + UntagResourceResponse: + type: object + x-stackQL-resources: + applications: + id: aws.account_access.applications + name: applications + title: applications + methods: + create_application: + operation: + $ref: "#/paths/~1applications/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_application: + operation: + $ref: "#/paths/~1applications~1{application_arn}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + get_application: + operation: + $ref: "#/paths/~1applications~1{application_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_applications: + operation: + $ref: "#/paths/~1applications-list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.applications + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/applications/methods/get_application" + - $ref: "#/components/x-stackQL-resources/applications/methods/list_applications" + insert: + - $ref: "#/components/x-stackQL-resources/applications/methods/create_application" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/applications/methods/delete_application" + entitlements: + id: aws.account_access.entitlements + name: entitlements + title: entitlements + methods: + create_entitlement: + operation: + $ref: "#/paths/~1entitlements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_entitlement: + operation: + $ref: "#/paths/~1entitlements~1{entitlement_id}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + get_entitlement: + operation: + $ref: "#/paths/~1entitlements~1{entitlement_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + list_entitlements: + operation: + $ref: "#/paths/~1entitlements-list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.entitlements + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/entitlements/methods/get_entitlement" + - $ref: "#/components/x-stackQL-resources/entitlements/methods/list_entitlements" + insert: + - $ref: "#/components/x-stackQL-resources/entitlements/methods/create_entitlement" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/entitlements/methods/delete_entitlement" + tags: + id: aws.account_access.tags + name: tags + title: tags + methods: + list_tags_for_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/acm.yaml b/providers/src/aws/v00.00.00000/services/acm.yaml index 75f97800..b54ff344 100644 --- a/providers/src/aws/v00.00.00000/services/acm.yaml +++ b/providers/src/aws/v00.00.00000/services/acm.yaml @@ -21,7 +21,7 @@ paths: /AddTagsToCertificate: post: operationId: AddTagsToCertificate - description: Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action. + description: Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. This action applies only to the certificate resource type. For all other ACM resource types, use TagResource instead. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action. parameters: - name: X-Amz-Target in: header @@ -50,10 +50,10 @@ paths: responses: "200": description: Success - /DeleteCertificate: + /CreateAcmeDomainValidation: post: - operationId: DeleteCertificate - description: Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide. + operationId: CreateAcmeDomainValidation + description: Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership. parameters: - name: X-Amz-Target in: header @@ -62,8 +62,8 @@ paths: schema: type: string enum: - - CertificateManager.DeleteCertificate - default: CertificateManager.DeleteCertificate + - CertificateManager.CreateAcmeDomainValidation + default: CertificateManager.CreateAcmeDomainValidation requestBody: required: true content: @@ -71,18 +71,36 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "String that contains the ARN of the ACM certificate to be deleted. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + IdempotencyToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure idempotency of the request. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + DomainName: + $ref: "#/components/schemas/DomainName" + description: The domain name to validate. + PrevalidationOptions: + $ref: "#/components/schemas/PrevalidationOptions" + description: The prevalidation options for the domain. + Tags: + $ref: "#/components/schemas/TagList" + description: One or more tags to associate with the domain validation. required: - - CertificateArn + - AcmeEndpointArn + - DomainName + - PrevalidationOptions responses: "200": description: Success - /DescribeCertificate: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAcmeDomainValidationResponse" + /CreateAcmeEndpoint: post: - operationId: DescribeCertificate - description: Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it. + operationId: CreateAcmeEndpoint + description: Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol. parameters: - name: X-Amz-Target in: header @@ -91,8 +109,8 @@ paths: schema: type: string enum: - - CertificateManager.DescribeCertificate - default: CertificateManager.DescribeCertificate + - CertificateManager.CreateAcmeEndpoint + default: CertificateManager.CreateAcmeEndpoint requestBody: required: true content: @@ -100,22 +118,38 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + IdempotencyToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure idempotency of the request. + AuthorizationBehavior: + $ref: "#/components/schemas/AcmeAuthorizationBehavior" + description: The authorization behavior for the ACME endpoint. + Contact: + $ref: "#/components/schemas/AcmeContact" + description: Specifies whether ACME clients must provide contact information during account registration. + CertificateAuthority: + $ref: "#/components/schemas/CertificateAuthority" + description: The type of certificate authority to use for issuing certificates through this ACME endpoint. + Tags: + $ref: "#/components/schemas/TagList" + description: One or more tags to associate with the ACME endpoint. + CertificateTags: + $ref: "#/components/schemas/TagList" + description: Tags to apply to certificates issued through this ACME endpoint. required: - - CertificateArn + - AuthorizationBehavior + - CertificateAuthority responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DescribeCertificateResponse" - /ExportCertificate: + $ref: "#/components/schemas/CreateAcmeEndpointResponse" + /CreateAcmeExternalAccountBinding: post: - operationId: ExportCertificate - description: Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate. ACM public certificates created prior to June 17, 2025 cannot be exported. + operationId: CreateAcmeExternalAccountBinding + description: Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform. parameters: - name: X-Amz-Target in: header @@ -124,8 +158,8 @@ paths: schema: type: string enum: - - CertificateManager.ExportCertificate - default: CertificateManager.ExportCertificate + - CertificateManager.CreateAcmeExternalAccountBinding + default: CertificateManager.CreateAcmeExternalAccountBinding requestBody: required: true content: @@ -133,47 +167,35 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012" - Passphrase: - $ref: "#/components/schemas/PassphraseBlob" - description: "Passphrase to associate with the encrypted exported private key. When creating your passphrase, you can use any ASCII character except #, $, or %. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase. openssl rsa -in encrypted_key.pem -out decrypted_key.pem" + IdempotencyToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure idempotency of the request. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding. + Expiration: + $ref: "#/components/schemas/Expiration" + description: The expiration configuration for the external account binding. + Tags: + $ref: "#/components/schemas/TagList" + description: One or more tags to associate with the external account binding. required: - - CertificateArn - - Passphrase - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ExportCertificateResponse" - /GetAccountConfiguration: - post: - operationId: GetAccountConfiguration - description: Returns the account configuration options associated with an Amazon Web Services account. - parameters: - - name: X-Amz-Target - in: header - description: Action Header - required: false - schema: - type: string - enum: - - CertificateManager.GetAccountConfiguration - default: CertificateManager.GetAccountConfiguration + - AcmeEndpointArn + - RoleArn responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/GetAccountConfigurationResponse" - /GetCertificate: + $ref: "#/components/schemas/CreateAcmeExternalAccountBindingResponse" + /DeleteAcmeDomainValidation: post: - operationId: GetCertificate - description: Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields. + operationId: DeleteAcmeDomainValidation + description: Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain. parameters: - name: X-Amz-Target in: header @@ -182,8 +204,8 @@ paths: schema: type: string enum: - - CertificateManager.GetCertificate - default: CertificateManager.GetCertificate + - CertificateManager.DeleteAcmeDomainValidation + default: CertificateManager.DeleteAcmeDomainValidation requestBody: required: true content: @@ -191,22 +213,18 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "String that contains a certificate ARN in the following format: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the ACME domain validation to delete. required: - - CertificateArn + - AcmeDomainValidationArn responses: "200": description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/GetCertificateResponse" - /ImportCertificate: + /DeleteAcmeEndpoint: post: - operationId: ImportCertificate - description: "Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate." + operationId: DeleteAcmeEndpoint + description: Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted. parameters: - name: X-Amz-Target in: header @@ -215,8 +233,8 @@ paths: schema: type: string enum: - - CertificateManager.ImportCertificate - default: CertificateManager.ImportCertificate + - CertificateManager.DeleteAcmeEndpoint + default: CertificateManager.DeleteAcmeEndpoint requestBody: required: true content: @@ -224,34 +242,18 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field. - Certificate: - $ref: "#/components/schemas/CertificateBodyBlob" - description: The certificate to import. - PrivateKey: - $ref: "#/components/schemas/PrivateKeyBlob" - description: The private key that matches the public key in the certificate. - CertificateChain: - $ref: "#/components/schemas/CertificateChainBlob" - description: The PEM encoded certificate chain. - Tags: - $ref: "#/components/schemas/TagList" - description: "One or more resource tags to associate with the imported certificate. Note: You cannot apply tags when reimporting a certificate." + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint to delete. required: - - PrivateKey + - AcmeEndpointArn responses: "200": description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ImportCertificateResponse" - /ListCertificates: + /DeleteAcmeExternalAccountBinding: post: - operationId: ListCertificates - description: Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters. + operationId: DeleteAcmeExternalAccountBinding + description: Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered. parameters: - name: X-Amz-Target in: header @@ -260,8 +262,8 @@ paths: schema: type: string enum: - - CertificateManager.ListCertificates - default: CertificateManager.ListCertificates + - CertificateManager.DeleteAcmeExternalAccountBinding + default: CertificateManager.DeleteAcmeExternalAccountBinding requestBody: required: true content: @@ -269,35 +271,18 @@ paths: schema: type: object properties: - CertificateStatuses: - $ref: "#/components/schemas/CertificateStatuses" - description: Filter the certificate list by status value. - Includes: - $ref: "#/components/schemas/Filters" - description: Filter the certificate list. For more information, see the Filters structure. - NextToken: - $ref: "#/components/schemas/NextToken" - description: Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received. - MaxItems: - $ref: "#/components/schemas/MaxItems" - 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. - SortBy: - $ref: "#/components/schemas/SortBy" - description: Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder. - SortOrder: - $ref: "#/components/schemas/SortOrder" - description: Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy. + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding to delete. + required: + - AcmeExternalAccountBindingArn responses: "200": description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListCertificatesResponse" - /ListTagsForCertificate: + /DeleteCertificate: post: - operationId: ListTagsForCertificate - description: Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action. + operationId: DeleteCertificate + description: Deletes a certificate and its associated private key. If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide. You cannot delete a certificate with a CertificateKeyPairOrigin of ACME. ACM automatically deletes these certificates 1 year after they expire. Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide. parameters: - name: X-Amz-Target in: header @@ -306,8 +291,8 @@ paths: schema: type: string enum: - - CertificateManager.ListTagsForCertificate - default: CertificateManager.ListTagsForCertificate + - CertificateManager.DeleteCertificate + default: CertificateManager.DeleteCertificate requestBody: required: true content: @@ -317,20 +302,16 @@ paths: properties: CertificateArn: $ref: "#/components/schemas/Arn" - description: "String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + description: "String that contains the ARN of the ACM certificate to be deleted. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." required: - CertificateArn responses: "200": description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListTagsForCertificateResponse" - /PutAccountConfiguration: + /DescribeAcmeAccount: post: - operationId: PutAccountConfiguration - description: Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration. + operationId: DescribeAcmeAccount + description: Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding. parameters: - name: X-Amz-Target in: header @@ -339,8 +320,8 @@ paths: schema: type: string enum: - - CertificateManager.PutAccountConfiguration - default: CertificateManager.PutAccountConfiguration + - CertificateManager.DescribeAcmeAccount + default: CertificateManager.DescribeAcmeAccount requestBody: required: true content: @@ -348,21 +329,26 @@ paths: schema: type: object properties: - ExpiryEvents: - $ref: "#/components/schemas/ExpiryEventsConfiguration" - description: Specifies expiration events associated with an account. - IdempotencyToken: - $ref: "#/components/schemas/IdempotencyToken" - description: Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + AccountUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME account. required: - - IdempotencyToken + - AcmeEndpointArn + - AccountUrl responses: "200": description: Success - /RemoveTagsFromCertificate: + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAcmeAccountResponse" + /DescribeAcmeDomainValidation: post: - operationId: RemoveTagsFromCertificate - description: Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action. + operationId: DescribeAcmeDomainValidation + description: Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation. parameters: - name: X-Amz-Target in: header @@ -371,8 +357,8 @@ paths: schema: type: string enum: - - CertificateManager.RemoveTagsFromCertificate - default: CertificateManager.RemoveTagsFromCertificate + - CertificateManager.DescribeAcmeDomainValidation + default: CertificateManager.DescribeAcmeDomainValidation requestBody: required: true content: @@ -380,21 +366,22 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." - Tags: - $ref: "#/components/schemas/TagList" - description: The key-value pair that defines the tag to remove. + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the ACME domain validation. required: - - CertificateArn + - AcmeDomainValidationArn responses: "200": description: Success - /RenewCertificate: + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAcmeDomainValidationResponse" + /DescribeAcmeEndpoint: post: - operationId: RenewCertificate - description: Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. + operationId: DescribeAcmeEndpoint + description: Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration. parameters: - name: X-Amz-Target in: header @@ -403,8 +390,8 @@ paths: schema: type: string enum: - - CertificateManager.RenewCertificate - default: CertificateManager.RenewCertificate + - CertificateManager.DescribeAcmeEndpoint + default: CertificateManager.DescribeAcmeEndpoint requestBody: required: true content: @@ -412,18 +399,22 @@ paths: schema: type: object properties: - CertificateArn: - $ref: "#/components/schemas/Arn" - description: "String that contains the ARN of the ACM certificate to be renewed. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. required: - - CertificateArn + - AcmeEndpointArn responses: "200": description: Success - /RequestCertificate: + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAcmeEndpointResponse" + /DescribeAcmeExternalAccountBinding: post: - operationId: RequestCertificate - description: Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate. + operationId: DescribeAcmeExternalAccountBinding + description: Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history. parameters: - name: X-Amz-Target in: header @@ -432,8 +423,8 @@ paths: schema: type: string enum: - - CertificateManager.RequestCertificate - default: CertificateManager.RequestCertificate + - CertificateManager.DescribeAcmeExternalAccountBinding + default: CertificateManager.DescribeAcmeExternalAccountBinding requestBody: required: true content: @@ -441,49 +432,22 @@ paths: schema: type: object properties: - DomainName: - $ref: "#/components/schemas/DomainNameString" - description: Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length. - ValidationMethod: - $ref: "#/components/schemas/ValidationMethod" - description: The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation. - SubjectAlternativeNames: - $ref: "#/components/schemas/DomainList" - description: "Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas. The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets." - IdempotencyToken: - $ref: "#/components/schemas/IdempotencyToken" - description: Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates. - DomainValidationOptions: - $ref: "#/components/schemas/DomainValidationOptionList" - description: The domain name that you want ACM to use to send you emails so that you can validate domain ownership. - Options: - $ref: "#/components/schemas/CertificateOptions" - description: You can use this parameter to specify whether to add the certificate to a certificate transparency log and export your certificate. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging. You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate. - CertificateAuthorityArn: - $ref: "#/components/schemas/PcaArn" - description: "The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012" - Tags: - $ref: "#/components/schemas/TagList" - description: One or more resource tags to associate with the certificate. - KeyAlgorithm: - $ref: "#/components/schemas/KeyAlgorithm" - description: "Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms. Algorithms supported for an ACM certificate request include: RSA_2048 EC_prime256v1 EC_secp384r1 Other listed algorithms are for imported certificates only. When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key. Default: RSA_2048" - ManagedBy: - $ref: "#/components/schemas/CertificateManagedBy" - description: Identifies the Amazon Web Services service that manages the certificate issued by ACM. + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding. required: - - DomainName + - AcmeExternalAccountBindingArn responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/RequestCertificateResponse" - /ResendValidationEmail: + $ref: "#/components/schemas/DescribeAcmeExternalAccountBindingResponse" + /DescribeCertificate: post: - operationId: ResendValidationEmail - description: Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain. + operationId: DescribeCertificate + description: Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it. parameters: - name: X-Amz-Target in: header @@ -492,8 +456,8 @@ paths: schema: type: string enum: - - CertificateManager.ResendValidationEmail - default: CertificateManager.ResendValidationEmail + - CertificateManager.DescribeCertificate + default: CertificateManager.DescribeCertificate requestBody: required: true content: @@ -503,24 +467,20 @@ paths: properties: CertificateArn: $ref: "#/components/schemas/Arn" - description: "String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" - Domain: - $ref: "#/components/schemas/DomainNameString" - description: The fully qualified domain name (FQDN) of the certificate that needs to be validated. - ValidationDomain: - $ref: "#/components/schemas/DomainNameString" - description: "The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the the following five addresses: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com" + description: "The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." required: - CertificateArn - - Domain - - ValidationDomain responses: "200": description: Success - /RevokeCertificate: + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeCertificateResponse" + /ExportCertificate: post: - operationId: RevokeCertificate - description: Revokes a public ACM certificate. You can only revoke certificates that have been previously exported. Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent. + operationId: ExportCertificate + description: Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate. ACM public certificates created prior to June 17, 2025 cannot be exported. parameters: - name: X-Amz-Target in: header @@ -529,8 +489,734 @@ paths: schema: type: string enum: - - CertificateManager.RevokeCertificate - default: CertificateManager.RevokeCertificate + - CertificateManager.ExportCertificate + default: CertificateManager.ExportCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012" + Passphrase: + $ref: "#/components/schemas/PassphraseBlob" + description: "Passphrase to associate with the encrypted exported private key. When creating your passphrase, you can use any ASCII character except #, $, or %. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase. openssl rsa -in encrypted_key.pem -out decrypted_key.pem" + required: + - CertificateArn + - Passphrase + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExportCertificateResponse" + /GetAccountConfiguration: + post: + operationId: GetAccountConfiguration + description: Returns the account configuration options associated with an Amazon Web Services account. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.GetAccountConfiguration + default: CertificateManager.GetAccountConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAccountConfigurationResponse" + /GetAcmeExternalAccountBindingCredentials: + post: + operationId: GetAcmeExternalAccountBindingCredentials + description: Retrieves the key ID and MAC key credentials for an external account binding. These credentials are used by ACME clients during account registration to bind to the endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.GetAcmeExternalAccountBindingCredentials + default: CertificateManager.GetAcmeExternalAccountBindingCredentials + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding. + required: + - AcmeExternalAccountBindingArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAcmeExternalAccountBindingCredentialsResponse" + /GetCertificate: + post: + operationId: GetCertificate + description: Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.GetCertificate + default: CertificateManager.GetCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "String that contains a certificate ARN in the following format: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + required: + - CertificateArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCertificateResponse" + /ImportCertificate: + post: + operationId: ImportCertificate + description: "Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ImportCertificate + default: CertificateManager.ImportCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field. + Certificate: + $ref: "#/components/schemas/CertificateBodyBlob" + description: The certificate to import. + PrivateKey: + $ref: "#/components/schemas/PrivateKeyBlob" + description: The private key that matches the public key in the certificate. + CertificateChain: + $ref: "#/components/schemas/CertificateChainBlob" + description: The PEM encoded certificate chain. + Tags: + $ref: "#/components/schemas/TagList" + description: "One or more resource tags to associate with the imported certificate. Note: You cannot apply tags when reimporting a certificate." + required: + - PrivateKey + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ImportCertificateResponse" + /ListAcmeAccounts: + post: + operationId: ListAcmeAccounts + description: Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListAcmeAccounts + default: CertificateManager.ListAcmeAccounts + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + MaxResults: + $ref: "#/components/schemas/ListAcmeAccountsRequestMaxResultsInteger" + description: The maximum number of results to return. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + required: + - AcmeEndpointArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAcmeAccountsResponse" + /ListAcmeDomainValidations: + post: + operationId: ListAcmeDomainValidations + description: Retrieves a list of domain validations for the specified ACME endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListAcmeDomainValidations + default: CertificateManager.ListAcmeDomainValidations + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + MaxResults: + $ref: "#/components/schemas/ListAcmeDomainValidationsRequestMaxResultsInteger" + description: The maximum number of results to return. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + required: + - AcmeEndpointArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAcmeDomainValidationsResponse" + /ListAcmeEndpoints: + post: + operationId: ListAcmeEndpoints + description: Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListAcmeEndpoints + default: CertificateManager.ListAcmeEndpoints + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + MaxResults: + $ref: "#/components/schemas/ListAcmeEndpointsRequestMaxResultsInteger" + description: The maximum number of results to return. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAcmeEndpointsResponse" + /ListAcmeExternalAccountBindings: + post: + operationId: ListAcmeExternalAccountBindings + description: Retrieves a list of external account bindings for the specified ACME endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListAcmeExternalAccountBindings + default: CertificateManager.ListAcmeExternalAccountBindings + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + MaxResults: + $ref: "#/components/schemas/ListAcmeExternalAccountBindingsRequestMaxResultsInteger" + description: The maximum number of results to return. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + required: + - AcmeEndpointArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAcmeExternalAccountBindingsResponse" + /ListCertificateDomainValidations: + post: + operationId: ListCertificateDomainValidations + description: Returns per-domain validation summaries for an ACM certificate. Each summary includes the domain name, the active validation configuration, and the requested validation configuration when a validation method migration is in progress. You can use the results to monitor the progress of an email-to-DNS validation migration and to retrieve the CNAME records required for DNS validation. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListCertificateDomainValidations + default: CertificateManager.ListCertificateDomainValidations + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/CertificateArn" + description: The Amazon Resource Name (ARN) of the certificate for which to list domain validation summaries. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token returned by a previous call to ListCertificateDomainValidations. If the number of results exceeds MaxItems, use this token to retrieve the next page of results. + MaxItems: + $ref: "#/components/schemas/MaxItems" + description: The maximum number of domain validation summaries to return. If you don't specify a value, the default is 1000. + required: + - CertificateArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListCertificateDomainValidationsResponse" + /ListCertificates: + post: + operationId: ListCertificates + description: Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters. By default, this action does not return certificates with a CertificateKeyPairOrigin of ACME. To include ACME certificates, specify ACME in the CertificateKeyPairOrigins filter. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListCertificates + default: CertificateManager.ListCertificates + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateStatuses: + $ref: "#/components/schemas/CertificateStatuses" + description: Filter the certificate list by status value. + CertificateKeyPairOrigins: + $ref: "#/components/schemas/CertificateKeyPairOrigins" + description: Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED. + Includes: + $ref: "#/components/schemas/Filters" + description: Filter the certificate list. For more information, see the Filters structure. + NextToken: + $ref: "#/components/schemas/NextToken" + description: Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received. + MaxItems: + $ref: "#/components/schemas/MaxItems" + 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. + SortBy: + $ref: "#/components/schemas/SortBy" + description: Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder. + SortOrder: + $ref: "#/components/schemas/SortOrder" + description: Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListCertificatesResponse" + /ListTagsForCertificate: + post: + operationId: ListTagsForCertificate + description: Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action. This action applies only to the certificate resource type. For all other ACM resource types, use ListTagsForResource instead. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListTagsForCertificate + default: CertificateManager.ListTagsForCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + required: + - CertificateArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForCertificateResponse" + /ListTagsForResource: + post: + operationId: ListTagsForResource + description: Lists the tags associated with an ACM resource. Use this action for all ACM resource types except the certificate resource type. For certificate resources, use ListTagsForCertificate instead. To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ListTagsForResource + default: CertificateManager.ListTagsForResource + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ACM resource for which to list tags. + required: + - ResourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + /PutAccountConfiguration: + post: + operationId: PutAccountConfiguration + description: Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.PutAccountConfiguration + default: CertificateManager.PutAccountConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ExpiryEvents: + $ref: "#/components/schemas/ExpiryEventsConfiguration" + description: Specifies expiration events associated with an account. + IdempotencyToken: + $ref: "#/components/schemas/IdempotencyToken" + description: Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request. + required: + - IdempotencyToken + responses: + "200": + description: Success + /RemoveTagsFromCertificate: + post: + operationId: RemoveTagsFromCertificate + description: Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. This action applies only to the certificate resource type. For all other ACM resource types, use UntagResource instead. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RemoveTagsFromCertificate + default: CertificateManager.RemoveTagsFromCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + Tags: + $ref: "#/components/schemas/TagList" + description: The key-value pair that defines the tag to remove. + required: + - CertificateArn + responses: + "200": + description: Success + /RenewCertificate: + post: + operationId: RenewCertificate + description: Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RenewCertificate + default: CertificateManager.RenewCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "String that contains the ARN of the ACM certificate to be renewed. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs)." + required: + - CertificateArn + responses: + "200": + description: Success + /RequestCertificate: + post: + operationId: RequestCertificate + description: Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RequestCertificate + default: CertificateManager.RequestCertificate + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + DomainName: + $ref: "#/components/schemas/DomainNameString" + description: Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length. + ValidationMethod: + $ref: "#/components/schemas/ValidationMethod" + description: The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation. + SubjectAlternativeNames: + $ref: "#/components/schemas/DomainList" + description: "Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas. The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets." + IdempotencyToken: + $ref: "#/components/schemas/IdempotencyToken" + description: Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates. + DomainValidationOptions: + $ref: "#/components/schemas/DomainValidationOptionList" + description: The domain name that you want ACM to use to send you emails so that you can validate domain ownership. + Options: + $ref: "#/components/schemas/CertificateOptions" + description: You can use this parameter to specify whether to export your certificate. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. For more information, see Certificate Transparency Logging. You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate. + CertificateAuthorityArn: + $ref: "#/components/schemas/PcaArn" + description: "The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012" + Tags: + $ref: "#/components/schemas/TagList" + description: One or more resource tags to associate with the certificate. + KeyAlgorithm: + $ref: "#/components/schemas/KeyAlgorithm" + description: "Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms. Algorithms supported for an ACM certificate request include: RSA_2048 EC_prime256v1 EC_secp384r1 Other listed algorithms are for imported certificates only. When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key. Default: RSA_2048" + ManagedBy: + $ref: "#/components/schemas/CertificateManagedBy" + description: Identifies the Amazon Web Services service that manages the certificate issued by ACM. + required: + - DomainName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RequestCertificateResponse" + /ResendValidationEmail: + post: + operationId: ResendValidationEmail + description: Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.ResendValidationEmail + default: CertificateManager.ResendValidationEmail + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CertificateArn: + $ref: "#/components/schemas/Arn" + description: "String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" + Domain: + $ref: "#/components/schemas/DomainNameString" + description: The fully qualified domain name (FQDN) of the certificate that needs to be validated. + ValidationDomain: + $ref: "#/components/schemas/DomainNameString" + description: "The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the the following five addresses: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com" + required: + - CertificateArn + - Domain + - ValidationDomain + responses: + "200": + description: Success + /RevokeAcmeAccount: + post: + operationId: RevokeAcmeAccount + description: Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RevokeAcmeAccount + default: CertificateManager.RevokeAcmeAccount + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + AccountUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME account to revoke. + required: + - AcmeEndpointArn + - AccountUrl + responses: + "200": + description: Success + /RevokeAcmeExternalAccountBinding: + post: + operationId: RevokeAcmeExternalAccountBinding + description: Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RevokeAcmeExternalAccountBinding + default: CertificateManager.RevokeAcmeExternalAccountBinding + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding to revoke. + required: + - AcmeExternalAccountBindingArn + responses: + "200": + description: Success + /RevokeCertificate: + post: + operationId: RevokeCertificate + description: Revokes a public ACM certificate. You can only revoke certificates that have been previously exported. Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.RevokeCertificate + default: CertificateManager.RevokeCertificate requestBody: required: true content: @@ -597,10 +1283,145 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchCertificatesResponse" + /TagResource: + post: + operationId: TagResource + description: Adds one or more tags to an ACM resource. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. Use this action for all ACM resource types except the certificate resource type. For certificate resources, use AddTagsToCertificate instead. To remove one or more tags, use the UntagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.TagResource + default: CertificateManager.TagResource + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ACM resource to which the tag is to be applied. + Tags: + $ref: "#/components/schemas/TagList" + description: The key-value pair that defines the tag to apply. + required: + - ResourceArn + responses: + "200": + description: Success + /UntagResource: + post: + operationId: UntagResource + description: Removes one or more tags from an ACM resource. Use this action for all ACM resource types except the certificate resource type. For certificate resources, use RemoveTagsFromCertificate instead. To add one or more tags, use the TagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.UntagResource + default: CertificateManager.UntagResource + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ACM resource from which the tag is to be removed. + TagKeys: + $ref: "#/components/schemas/TagKeyList" + description: The key of each tag to remove. + required: + - ResourceArn + - TagKeys + responses: + "200": + description: Success + /UpdateAcmeDomainValidation: + post: + operationId: UpdateAcmeDomainValidation + description: Updates the prevalidation configuration of an existing domain validation. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.UpdateAcmeDomainValidation + default: CertificateManager.UpdateAcmeDomainValidation + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the ACME domain validation to update. + PrevalidationOptions: + $ref: "#/components/schemas/PrevalidationOptions" + description: The updated prevalidation options. + required: + - AcmeDomainValidationArn + responses: + "200": + description: Success + /UpdateAcmeEndpoint: + post: + operationId: UpdateAcmeEndpoint + description: Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CertificateManager.UpdateAcmeEndpoint + default: CertificateManager.UpdateAcmeEndpoint + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint to update. + AuthorizationBehavior: + $ref: "#/components/schemas/AcmeAuthorizationBehavior" + description: The updated authorization behavior. + Contact: + $ref: "#/components/schemas/AcmeContact" + description: The updated contact requirement. + CertificateAuthority: + $ref: "#/components/schemas/CertificateAuthority" + description: The updated certificate authority configuration. + required: + - AcmeEndpointArn + responses: + "200": + description: Success /UpdateCertificateOptions: post: operationId: UpdateCertificateOptions - description: Updates a certificate. You can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log and exporting. For more information, see Opting Out of Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates. + description: Updates certificate options. You can use this operation to change the domain validation method or specify whether to export your certificate. For more information, see Migrate from email to DNS validation and Certificate Manager Exportable Managed Certificates. parameters: - name: X-Amz-Target in: header @@ -623,7 +1444,7 @@ paths: description: "ARN of the requested certificate to update. This must be of the form: arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012" Options: $ref: "#/components/schemas/CertificateOptions" - description: Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log or export your certificate. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. + description: Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see Migrate from email to DNS validation. required: - CertificateArn - Options @@ -700,12 +1521,388 @@ components: type: string minLength: 1 maxLength: 128 - pattern: "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*" + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) TagValue: type: string - minLength: 0 - maxLength: 256 - pattern: "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*" + minLength: 0 + maxLength: 256 + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) + String: + type: string + AcmeEndpointArn: + type: string + minLength: 1 + maxLength: 200 + pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+ + DomainName: + type: string + minLength: 1 + maxLength: 253 + pattern: ([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)*[a-z0-9]([a-z0-9-]*[a-z0-9])? + PrevalidationOptions: + description: Specifies prevalidation options for domain validation. + type: object + properties: + DnsPrevalidation: + $ref: "#/components/schemas/DnsPrevalidationOptions" + description: DNS-based prevalidation options. + DnsPrevalidationOptions: + description: DNS prevalidation options for domain validation. + type: object + properties: + DomainScope: + $ref: "#/components/schemas/DomainScope" + description: The scope of domains covered by this prevalidation. + HostedZoneId: + $ref: "#/components/schemas/HostedZoneId" + description: The Route 53 hosted zone ID for DNS validation. + DomainScope: + description: Specifies the scope of domain validation. + type: object + properties: + ExactDomain: + $ref: "#/components/schemas/DomainScopeOption" + description: Whether validation applies to the exact domain. + Subdomains: + $ref: "#/components/schemas/DomainScopeOption" + description: Whether validation applies to subdomains. + Wildcards: + $ref: "#/components/schemas/DomainScopeOption" + description: Whether validation applies to wildcard domains. + DomainScopeOption: + type: string + enum: + - ENABLED + - DISABLED + HostedZoneId: + type: string + minLength: 1 + maxLength: 32 + pattern: Z[A-Z0-9]+ + CreateAcmeDomainValidationResponse: + type: object + properties: + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the created domain validation. + required: + - AcmeDomainValidationArn + AcmeDomainValidationArn: + type: string + minLength: 1 + maxLength: 200 + pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+ + AcmeAuthorizationBehavior: + type: string + enum: + - PRE_APPROVED + AcmeContact: + type: string + enum: + - REQUIRED + - NOT_REQUIRED + CertificateAuthority: + description: Defines the certificate authority to use for an ACME endpoint. + type: object + properties: + PublicCertificateAuthority: + $ref: "#/components/schemas/PublicCertificateAuthority" + description: Configuration for using a public certificate authority. + PublicCertificateAuthority: + description: Configuration for a public certificate authority. + type: object + properties: + AllowedKeyAlgorithms: + $ref: "#/components/schemas/PublicKeyAlgorithmList" + description: The key algorithms allowed for certificates issued by this certificate authority. + PublicKeyAlgorithmList: + type: array + items: + $ref: "#/components/schemas/PublicKeyAlgorithm" + PublicKeyAlgorithm: + type: string + enum: + - RSA_2048 + - EC_prime256v1 + - EC_secp384r1 + CreateAcmeEndpointResponse: + type: object + properties: + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the created ACME endpoint. + RoleArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws[a-z-]*:iam::[0-9]{12}:role/.+ + Expiration: + description: Specifies an expiration configuration. + type: object + properties: + Value: + $ref: "#/components/schemas/ExpirationValueLong" + description: The numeric value of the expiration. + Type: + $ref: "#/components/schemas/TimeType" + description: The time unit for the expiration value. + required: + - Value + - Type + ExpirationValueLong: + type: integer + format: int64 + minimum: 1 + TimeType: + type: string + enum: + - MINUTES + - HOURS + - DAYS + CreateAcmeExternalAccountBindingResponse: + type: object + properties: + ExternalAccountBinding: + $ref: "#/components/schemas/AcmeExternalAccountBinding" + description: The created external account binding. + AcmeExternalAccountBinding: + description: Contains detailed information about an ACME external account binding. + type: object + properties: + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the IAM role associated with the external account binding. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding expires. + RevokedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was revoked. + LastUsedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was last used. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was last updated. + AcmeExternalAccountBindingArn: + type: string + minLength: 1 + maxLength: 200 + pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-external-account-binding/[a-zA-Z0-9-]+ + Timestamp: + type: string + format: date-time + DescribeAcmeAccountResponse: + type: object + properties: + AcmeAccount: + $ref: "#/components/schemas/AcmeAccount" + description: The ACME account details. + AcmeAccount: + description: Contains detailed information about an ACME account. + type: object + properties: + AccountUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME account. + PublicKeyThumbprint: + $ref: "#/components/schemas/String" + description: The thumbprint of the public key associated with the ACME account. + Status: + $ref: "#/components/schemas/AcmeAccountStatus" + description: The status of the ACME account. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME account was created. + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the external account binding associated with this ACME account. + Contacts: + $ref: "#/components/schemas/ContactList" + description: The contact information for the ACME account. + AcmeAccountStatus: + type: string + enum: + - VALID + - DEACTIVATED + - REVOKED + ContactList: + type: array + items: + $ref: "#/components/schemas/String" + DescribeAcmeDomainValidationResponse: + type: object + properties: + AcmeDomainValidation: + $ref: "#/components/schemas/AcmeDomainValidation" + description: The ACME domain validation details. + AcmeDomainValidation: + description: Contains detailed information about an ACME domain validation. + type: object + properties: + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the ACME domain validation. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + DomainName: + $ref: "#/components/schemas/DomainName" + description: The domain name being validated. + PrevalidationType: + $ref: "#/components/schemas/PrevalidationType" + description: The type of prevalidation used. + PrevalidationDetails: + $ref: "#/components/schemas/PrevalidationDetails" + description: Details about the prevalidation configuration. + Status: + $ref: "#/components/schemas/AcmeDomainValidationStatus" + description: The status of the domain validation. + FailureDetails: + $ref: "#/components/schemas/FailureDetails" + description: Details about the failure, if the validation failed. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the domain validation was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the domain validation was last updated. + PrevalidationType: + type: string + enum: + - DNS_PREVALIDATION + PrevalidationDetails: + description: Contains details about the prevalidation configuration. + type: object + properties: + DnsPrevalidation: + $ref: "#/components/schemas/DnsPrevalidationDetails" + description: DNS-based prevalidation details. + DnsPrevalidationDetails: + description: DNS prevalidation details including the resource record for validation. + type: object + properties: + DomainScope: + $ref: "#/components/schemas/DomainScope" + description: The scope of domains covered by this prevalidation. + HostedZoneId: + $ref: "#/components/schemas/HostedZoneId" + description: The Route 53 hosted zone ID for DNS validation. + ResourceRecord: + $ref: "#/components/schemas/ResourceRecord" + description: The DNS resource record to create for domain validation. + ResourceRecord: + description: Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action. + type: object + properties: + Name: + $ref: "#/components/schemas/String" + description: The name of the DNS record to create in your domain. This is supplied by ACM. + Type: + $ref: "#/components/schemas/RecordType" + description: The type of DNS record. Currently this can be CNAME. + Value: + $ref: "#/components/schemas/String" + description: The value of the CNAME record to add to your DNS database. This is supplied by ACM. + required: + - Name + - Type + - Value + RecordType: + type: string + enum: + - CNAME + AcmeDomainValidationStatus: + type: string + enum: + - VALIDATING + - VALID + - INVALID + - DELETING + FailureDetails: + description: Contains details about a failure. + type: object + properties: + Reason: + $ref: "#/components/schemas/AcmeDomainValidationFailureReason" + description: The reason for the failure. + Message: + $ref: "#/components/schemas/String" + description: A message describing the failure. + AcmeDomainValidationFailureReason: + type: string + enum: + - ACCESS_DENIED + - DOMAIN_MISMATCH + - DOMAIN_NOT_ALLOWED + - ENDPOINT_NOT_ACTIVE + - HOSTED_ZONE_NOT_FOUND + - INTERNAL_FAILURE + - INVALID_CHANGE_BATCH + - INVALID_PUBLIC_DOMAIN + - TIMED_OUT + DescribeAcmeEndpointResponse: + type: object + properties: + AcmeEndpoint: + $ref: "#/components/schemas/AcmeEndpoint" + description: The ACME endpoint details. + AcmeEndpoint: + description: Contains detailed information about an ACME endpoint. + type: object + properties: + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + EndpointUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME endpoint. + Status: + $ref: "#/components/schemas/AcmeEndpointStatus" + description: The status of the ACME endpoint. + FailureReason: + $ref: "#/components/schemas/String" + description: The reason the ACME endpoint failed, if applicable. + AuthorizationBehavior: + $ref: "#/components/schemas/AcmeAuthorizationBehavior" + description: The authorization behavior of the ACME endpoint. + Contact: + $ref: "#/components/schemas/AcmeContact" + description: Whether ACME clients must provide contact information during account registration. + CertificateAuthority: + $ref: "#/components/schemas/CertificateAuthority" + description: The certificate authority configuration for the ACME endpoint. + CertificateTags: + $ref: "#/components/schemas/TagList" + description: Tags applied to certificates issued through this ACME endpoint. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME endpoint was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME endpoint was last updated. + AcmeEndpointStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + DescribeAcmeExternalAccountBindingResponse: + type: object + properties: + ExternalAccountBinding: + $ref: "#/components/schemas/AcmeExternalAccountBinding" + description: The external account binding details. DescribeCertificateResponse: type: object properties: @@ -796,7 +1993,19 @@ components: description: Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command. Options: $ref: "#/components/schemas/CertificateOptions" - description: Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure. + description: Contains the certificate options. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. + UpdateSummary: + $ref: "#/components/schemas/UpdateSummary" + description: Contains information about the most recent update to the certificate. This field exists only when the certificate type is AMAZON_ISSUED and a certificate update has been requested. + CertificateKeyPairOrigin: + $ref: "#/components/schemas/CertificateKeyPairOrigin" + description: The origin of the certificate's key pair. + AcmeEndpointArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ACME endpoint used to issue the certificate. + AcmeAccountId: + $ref: "#/components/schemas/AcmeAccountId" + description: The ACME account identifier associated with the certificate. DomainNameString: type: string minLength: 1 @@ -845,35 +2054,12 @@ components: type: array items: $ref: "#/components/schemas/String" - String: - type: string DomainStatus: type: string enum: - PENDING_VALIDATION - SUCCESS - FAILED - ResourceRecord: - description: Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action. - type: object - properties: - Name: - $ref: "#/components/schemas/String" - description: The name of the DNS record to create in your domain. This is supplied by ACM. - Type: - $ref: "#/components/schemas/RecordType" - description: The type of DNS record. Currently this can be CNAME. - Value: - $ref: "#/components/schemas/String" - description: The value of the CNAME record to add to your DNS database. This is supplied by ACM. - required: - - Name - - Type - - Value - RecordType: - type: string - enum: - - CNAME HttpRedirect: description: Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP. type: object @@ -1044,15 +2230,18 @@ components: - ELIGIBLE - INELIGIBLE CertificateOptions: - description: Structure that contains options for your certificate. You can use this structure to specify whether to opt in to or out of certificate transparency logging and export your certificate. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging. You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate. + description: Structure that contains options for your certificate. You can use this structure to change the domain validation method or specify whether to export your certificate. All public certificates are recorded in a certificate transparency log. For general information, see Certificate Transparency Logging. You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate. type: object properties: CertificateTransparencyLoggingPreference: $ref: "#/components/schemas/CertificateTransparencyLoggingPreference" - description: You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED. + description: This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. Export: $ref: "#/components/schemas/CertificateExport" description: You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created. + ValidationMethod: + $ref: "#/components/schemas/ValidationMethod" + description: The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS. CertificateTransparencyLoggingPreference: type: string enum: @@ -1063,6 +2252,58 @@ components: enum: - ENABLED - DISABLED + UpdateSummary: + description: Contains information about the most recent certificate update, such as a domain validation method migration. This structure is returned as part of the CertificateDetail response from DescribeCertificate. + type: object + properties: + Status: + $ref: "#/components/schemas/UpdateStatus" + description: "The status of the certificate update. The following are valid values: PENDING_DOMAIN_VALIDATION – The certificate update is waiting for domain ownership validation to complete. SUCCESS – The certificate was updated successfully. FAILED – The certificate update failed." + Type: + $ref: "#/components/schemas/UpdateType" + description: "The type of update that was requested for the certificate. The following are valid values: DOMAIN_VALIDATION_METHOD – The update changes the domain validation method for the certificate." + DomainValidationMethodUpdateSummary: + $ref: "#/components/schemas/DomainValidationMethodUpdateSummary" + description: Contains information about a domain validation method migration, including the previous and target validation methods. + RequestedAt: + $ref: "#/components/schemas/TStamp" + description: The time at which the certificate update was requested. + UpdatedAt: + $ref: "#/components/schemas/TStamp" + description: The time at which the certificate update status was last changed. + UpdateStatus: + description: "The status of a certificate update. Possible values: PENDING_DOMAIN_VALIDATION – The update is waiting for domain validation to complete. SUCCESS – The update completed successfully. FAILED – The update failed." + type: string + enum: + - PENDING_DOMAIN_VALIDATION + - SUCCESS + - FAILED + UpdateType: + description: "The type of certificate update. Valid values: DOMAIN_VALIDATION_METHOD – A change to the domain validation method for the certificate." + type: string + enum: + - DOMAIN_VALIDATION_METHOD + DomainValidationMethodUpdateSummary: + description: Contains information about a domain validation method migration, including the previous validation method and the target validation method. + type: object + properties: + From: + $ref: "#/components/schemas/ValidationMethod" + description: The validation method that the certificate was using before the update. + To: + $ref: "#/components/schemas/ValidationMethod" + description: The target validation method for the update. + CertificateKeyPairOrigin: + description: The origin of the certificate's key pair. + type: string + enum: + - AWS_MANAGED + - ACME + - CUSTOMER_PROVIDED + AcmeAccountId: + type: string + minLength: 36 + maxLength: 36 PassphraseBlob: type: string format: byte @@ -1111,6 +2352,17 @@ components: PositiveInteger: type: integer minimum: 1 + GetAcmeExternalAccountBindingCredentialsResponse: + type: object + properties: + KeyId: + $ref: "#/components/schemas/String" + description: The key identifier for the external account binding credentials. + MacKey: + $ref: "#/components/schemas/MacKey" + description: The MAC key for the external account binding credentials. + MacKey: + type: string GetCertificateResponse: type: object properties: @@ -1141,10 +2393,278 @@ components: CertificateArn: $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) of the imported certificate. + ListAcmeAccountsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAcmeAccountsResponse: + type: object + properties: + AcmeAccounts: + $ref: "#/components/schemas/AcmeAccountList" + description: The list of ACME accounts. + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + AcmeAccountList: + type: array + items: + $ref: "#/components/schemas/AcmeAccountSummary" + AcmeAccountSummary: + description: Contains summary information about an ACME account. + type: object + properties: + AccountUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME account. + PublicKeyThumbprint: + $ref: "#/components/schemas/String" + description: The thumbprint of the public key associated with the ACME account. + Status: + $ref: "#/components/schemas/AcmeAccountStatus" + description: The status of the ACME account. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME account was created. + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the external account binding associated with this ACME account. + Contacts: + $ref: "#/components/schemas/ContactList" + description: The contact information for the ACME account. + ListAcmeDomainValidationsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAcmeDomainValidationsResponse: + type: object + properties: + AcmeDomainValidations: + $ref: "#/components/schemas/AcmeDomainValidationList" + description: The list of domain validations. + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + AcmeDomainValidationList: + type: array + items: + $ref: "#/components/schemas/AcmeDomainValidationSummary" + AcmeDomainValidationSummary: + description: Contains summary information about an ACME domain validation. + type: object + properties: + AcmeDomainValidationArn: + $ref: "#/components/schemas/AcmeDomainValidationArn" + description: The Amazon Resource Name (ARN) of the ACME domain validation. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + DomainName: + $ref: "#/components/schemas/DomainName" + description: The domain name being validated. + PrevalidationType: + $ref: "#/components/schemas/PrevalidationType" + description: The type of prevalidation used. + PrevalidationDetails: + $ref: "#/components/schemas/PrevalidationDetails" + description: Details about the prevalidation configuration. + Status: + $ref: "#/components/schemas/AcmeDomainValidationStatus" + description: The status of the domain validation. + FailureDetails: + $ref: "#/components/schemas/FailureDetails" + description: Details about the failure, if the validation failed. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the domain validation was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the domain validation was last updated. + ListAcmeEndpointsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAcmeEndpointsResponse: + type: object + properties: + AcmeEndpoints: + $ref: "#/components/schemas/AcmeEndpointList" + description: The list of ACME endpoints. + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + AcmeEndpointList: + type: array + items: + $ref: "#/components/schemas/AcmeEndpointSummary" + AcmeEndpointSummary: + description: Contains summary information about an ACME endpoint. + type: object + properties: + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + EndpointUrl: + $ref: "#/components/schemas/String" + description: The URL of the ACME endpoint. + Status: + $ref: "#/components/schemas/AcmeEndpointStatus" + description: The status of the ACME endpoint. + FailureReason: + $ref: "#/components/schemas/String" + description: The reason the ACME endpoint failed, if applicable. + AuthorizationBehavior: + $ref: "#/components/schemas/AcmeAuthorizationBehavior" + description: The authorization behavior of the ACME endpoint. + Contact: + $ref: "#/components/schemas/AcmeContact" + description: Whether ACME clients must provide contact information during account registration. + CertificateAuthority: + $ref: "#/components/schemas/CertificateAuthority" + description: The certificate authority configuration for the ACME endpoint. + CertificateTags: + $ref: "#/components/schemas/TagList" + description: Tags applied to certificates issued through this ACME endpoint. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME endpoint was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the ACME endpoint was last updated. + ListAcmeExternalAccountBindingsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAcmeExternalAccountBindingsResponse: + type: object + properties: + ExternalAccountBindings: + $ref: "#/components/schemas/AcmeExternalAccountBindingList" + description: The list of external account bindings. + NextToken: + $ref: "#/components/schemas/String" + description: A token for pagination. + AcmeExternalAccountBindingList: + type: array + items: + $ref: "#/components/schemas/AcmeExternalAccountBindingSummary" + AcmeExternalAccountBindingSummary: + description: Contains summary information about an ACME external account binding. + type: object + properties: + AcmeExternalAccountBindingArn: + $ref: "#/components/schemas/AcmeExternalAccountBindingArn" + description: The Amazon Resource Name (ARN) of the ACME external account binding. + AcmeEndpointArn: + $ref: "#/components/schemas/AcmeEndpointArn" + description: The Amazon Resource Name (ARN) of the ACME endpoint. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the IAM role associated with the external account binding. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding expires. + RevokedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was revoked. + LastUsedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was last used. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the external account binding was last updated. + CertificateArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:certificate/[\w+=,.@-]+.* + NextToken: + type: string + minLength: 1 + maxLength: 10000 + pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" + MaxItems: + type: integer + minimum: 1 + maximum: 1000 + ListCertificateDomainValidationsResponse: + type: object + properties: + DomainValidationSummaryList: + $ref: "#/components/schemas/DomainValidationSummaryList" + description: A list of DomainValidationSummary objects, one for each domain on the certificate. Each object contains the domain name and its active and requested validation configurations. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If the number of results exceeds MaxItems, this token is included in the response. Use this token in a subsequent ListCertificateDomainValidations request to retrieve the next page of results. + DomainValidationSummaryList: + type: array + items: + $ref: "#/components/schemas/DomainValidationSummary" + DomainValidationSummary: + description: Contains per-domain validation information for a certificate. This structure is returned as a member of the ListCertificateDomainValidations response. + type: object + properties: + DomainName: + $ref: "#/components/schemas/DomainNameString" + description: The fully qualified domain name (FQDN) in the certificate for which this validation summary applies. + ActiveValidationConfiguration: + $ref: "#/components/schemas/ValidationConfiguration" + description: The validation configuration currently in effect for this domain. This reflects the validation method that ACM is currently using to validate domain ownership (for example, email or DNS). + RequestedValidationConfiguration: + $ref: "#/components/schemas/ValidationConfiguration" + description: The validation configuration for a pending validation method migration. This field is present only when a migration is in progress (for example, from email to DNS validation). It contains the target validation method, the current validation status, and the validation challenge details (such as the CNAME record to add to your DNS configuration). + required: + - DomainName + ValidationConfiguration: + description: Contains the validation method, validation status, and validation challenge details for a domain. This structure appears in DomainValidationSummary as both the active and requested validation configuration. + type: object + properties: + ValidationMethod: + $ref: "#/components/schemas/ValidationMethod" + description: "The validation method for this configuration. Valid values: DNS – Validation using a CNAME record added to your DNS configuration. EMAIL – Validation using an approval email sent to domain contacts. HTTP – Validation using an HTTP resource placed on your web server." + ValidationChallenge: + $ref: "#/components/schemas/ValidationChallenge" + description: "The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses." + ValidationStatus: + $ref: "#/components/schemas/DomainStatus" + description: "The validation status for this domain. Valid values: PENDING_VALIDATION – The domain is waiting for validation to complete. SUCCESS – Validation completed successfully. FAILED – Validation failed." + ValidationChallenge: + description: Contains the challenge details that you use to prove domain ownership. Only one member is set, depending on the validation method. + type: object + properties: + EmailValidationChallenge: + $ref: "#/components/schemas/EmailValidationChallenge" + DnsValidationChallenge: + $ref: "#/components/schemas/DnsValidationChallenge" + EmailValidationChallenge: + description: Contains the email addresses used for email-based domain validation. + type: object + properties: + ValidationEmails: + $ref: "#/components/schemas/ValidationEmailList" + description: A list of email addresses that ACM uses to send domain validation emails. + ValidationDomain: + $ref: "#/components/schemas/DomainNameString" + description: The domain name that ACM uses to send validation emails. + DnsValidationChallenge: + description: Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation. + type: object + properties: + ResourceRecord: + $ref: "#/components/schemas/ResourceRecord" + description: The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain. CertificateStatuses: type: array items: $ref: "#/components/schemas/CertificateStatus" + CertificateKeyPairOrigins: + description: A list of CertificateKeyPairOrigin values used to filter certificates. + type: array + items: + $ref: "#/components/schemas/CertificateKeyPairOrigin" Filters: description: This structure can be used in the ListCertificates action to filter the output of the certificate list. type: object @@ -1176,15 +2696,6 @@ components: type: array items: $ref: "#/components/schemas/KeyAlgorithm" - NextToken: - type: string - minLength: 1 - maxLength: 10000 - pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" - MaxItems: - type: integer - minimum: 1 - maximum: 1000 SortBy: type: string enum: @@ -1246,7 +2757,7 @@ components: description: Indicates whether the certificate is currently in use by any Amazon Web Services resources. Exported: $ref: "#/components/schemas/NullableBoolean" - description: Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE. + description: Indicates whether the certificate has been exported. RenewalEligibility: $ref: "#/components/schemas/RenewalEligibility" description: Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command. @@ -1271,6 +2782,9 @@ components: ManagedBy: $ref: "#/components/schemas/CertificateManagedBy" description: Identifies the Amazon Web Services service that manages the certificate issued by ACM. + CertificateKeyPairOrigin: + $ref: "#/components/schemas/CertificateKeyPairOrigin" + description: The origin of the certificate's key pair. NullableBoolean: type: boolean KeyUsageNames: @@ -1287,6 +2801,12 @@ components: Tags: $ref: "#/components/schemas/TagList" description: The key-value pairs that define the applied tags. + ListTagsForResourceResponse: + type: object + properties: + Tags: + $ref: "#/components/schemas/TagList" + description: The tags associated with the resource. IdempotencyToken: type: string minLength: 1 @@ -1481,6 +3001,15 @@ components: ValidationMethod: $ref: "#/components/schemas/ValidationMethod" description: Filter by validation method. + CertificateKeyPairOrigin: + $ref: "#/components/schemas/CertificateKeyPairOrigin" + description: Filter by certificate key pair origin. + AcmeEndpointArn: + $ref: "#/components/schemas/Arn" + description: Filter by ACME endpoint ARN. + AcmeAccountId: + $ref: "#/components/schemas/AcmeAccountId" + description: Filter by ACME account identifier. SearchMaxResults: type: integer minimum: 1 @@ -1507,6 +3036,9 @@ components: - EXPORT_OPTION - VALIDATION_METHOD - IMPORTED_AT + - ACME_ENDPOINT_ARN + - ACME_ACCOUNT_ID + - CERTIFICATE_KEY_PAIR_ORIGIN SearchCertificatesSortOrder: description: The order to sort search results. type: string @@ -1733,17 +3265,120 @@ components: ValidationMethod: $ref: "#/components/schemas/ValidationMethod" description: Specifies the domain validation method. + CertificateKeyPairOrigin: + $ref: "#/components/schemas/CertificateKeyPairOrigin" + description: The origin of the certificate's key pair. + AcmeEndpointArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ACME endpoint used to issue the certificate. + AcmeAccountId: + $ref: "#/components/schemas/AcmeAccountId" + description: The ACME account identifier associated with the certificate. + TagKeyList: + type: array + items: + $ref: "#/components/schemas/TagKey" x-stackQL-resources: tags: id: aws.acm.tags name: tags title: tags methods: - add_tags_to_certificate: + add_tags_to_certificate: + operation: + $ref: "#/paths/~1AddTagsToCertificate/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_tags_for_certificate: + operation: + $ref: "#/paths/~1ListTagsForCertificate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_tags_for_resource: + operation: + $ref: "#/paths/~1ListTagsForResource/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + remove_tags_from_certificate: + operation: + $ref: "#/paths/~1RemoveTagsFromCertificate/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + tag_resource: + operation: + $ref: "#/paths/~1TagResource/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1UntagResource/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_certificate" + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/add_tags_to_certificate" + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + delete: [] + acme_domain_validations: + id: aws.acm.acme_domain_validations + name: acme_domain_validations + title: acme_domain_validations + methods: + create_acme_domain_validation: operation: - $ref: "#/paths/~1AddTagsToCertificate/post" + $ref: "#/paths/~1CreateAcmeDomainValidation/post" response: openAPIDocKey: "200" + mediaType: application/json request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -1751,12 +3386,25 @@ components: config: requestBodyTranslate: algorithm: naive - list_tags_for_certificate: + delete_acme_domain_validation: operation: - $ref: "#/paths/~1ListTagsForCertificate/post" + $ref: "#/paths/~1DeleteAcmeDomainValidation/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_acme_domain_validation: + operation: + $ref: "#/paths/~1DescribeAcmeDomainValidation/post" response: openAPIDocKey: "200" mediaType: application/json + objectKey: $.AcmeDomainValidation request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -1764,9 +3412,30 @@ components: config: requestBodyTranslate: algorithm: naive - remove_tags_from_certificate: + list_acme_domain_validations: operation: - $ref: "#/paths/~1RemoveTagsFromCertificate/post" + $ref: "#/paths/~1ListAcmeDomainValidations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AcmeDomainValidations + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_acme_domain_validation: + operation: + $ref: "#/paths/~1UpdateAcmeDomainValidation/post" response: openAPIDocKey: "200" request: @@ -1778,11 +3447,188 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_certificate" - insert: [] + - $ref: "#/components/x-stackQL-resources/acme_domain_validations/methods/describe_acme_domain_validation" + - $ref: "#/components/x-stackQL-resources/acme_domain_validations/methods/list_acme_domain_validations" + insert: + - $ref: "#/components/x-stackQL-resources/acme_domain_validations/methods/create_acme_domain_validation" update: - - $ref: "#/components/x-stackQL-resources/tags/methods/add_tags_to_certificate" - delete: [] + - $ref: "#/components/x-stackQL-resources/acme_domain_validations/methods/update_acme_domain_validation" + delete: + - $ref: "#/components/x-stackQL-resources/acme_domain_validations/methods/delete_acme_domain_validation" + acme_endpoints: + id: aws.acm.acme_endpoints + name: acme_endpoints + title: acme_endpoints + methods: + create_acme_endpoint: + operation: + $ref: "#/paths/~1CreateAcmeEndpoint/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_acme_endpoint: + operation: + $ref: "#/paths/~1DeleteAcmeEndpoint/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_acme_endpoint: + operation: + $ref: "#/paths/~1DescribeAcmeEndpoint/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AcmeEndpoint + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_acme_endpoints: + operation: + $ref: "#/paths/~1ListAcmeEndpoints/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AcmeEndpoints + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_acme_endpoint: + operation: + $ref: "#/paths/~1UpdateAcmeEndpoint/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/acme_endpoints/methods/describe_acme_endpoint" + - $ref: "#/components/x-stackQL-resources/acme_endpoints/methods/list_acme_endpoints" + insert: + - $ref: "#/components/x-stackQL-resources/acme_endpoints/methods/create_acme_endpoint" + update: + - $ref: "#/components/x-stackQL-resources/acme_endpoints/methods/update_acme_endpoint" + delete: + - $ref: "#/components/x-stackQL-resources/acme_endpoints/methods/delete_acme_endpoint" + acme_external_account_bindings: + id: aws.acm.acme_external_account_bindings + name: acme_external_account_bindings + title: acme_external_account_bindings + methods: + create_acme_external_account_binding: + operation: + $ref: "#/paths/~1CreateAcmeExternalAccountBinding/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_acme_external_account_binding: + operation: + $ref: "#/paths/~1DeleteAcmeExternalAccountBinding/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_acme_external_account_binding: + operation: + $ref: "#/paths/~1DescribeAcmeExternalAccountBinding/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ExternalAccountBinding + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_acme_external_account_bindings: + operation: + $ref: "#/paths/~1ListAcmeExternalAccountBindings/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ExternalAccountBindings + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + revoke_acme_external_account_binding: + operation: + $ref: "#/paths/~1RevokeAcmeExternalAccountBinding/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/acme_external_account_bindings/methods/describe_acme_external_account_binding" + - $ref: "#/components/x-stackQL-resources/acme_external_account_bindings/methods/list_acme_external_account_bindings" + insert: + - $ref: "#/components/x-stackQL-resources/acme_external_account_bindings/methods/create_acme_external_account_binding" + update: + - $ref: "#/components/x-stackQL-resources/acme_external_account_bindings/methods/revoke_acme_external_account_binding" + delete: + - $ref: "#/components/x-stackQL-resources/acme_external_account_bindings/methods/delete_acme_external_account_binding" certificates: id: aws.acm.certificates name: certificates @@ -1916,6 +3762,66 @@ components: - $ref: "#/components/x-stackQL-resources/certificates/methods/update_certificate_options" delete: - $ref: "#/components/x-stackQL-resources/certificates/methods/delete_certificate" + acme_accounts: + id: aws.acm.acme_accounts + name: acme_accounts + title: acme_accounts + methods: + describe_acme_account: + operation: + $ref: "#/paths/~1DescribeAcmeAccount/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AcmeAccount + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_acme_accounts: + operation: + $ref: "#/paths/~1ListAcmeAccounts/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AcmeAccounts + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + revoke_acme_account: + operation: + $ref: "#/paths/~1RevokeAcmeAccount/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/acme_accounts/methods/describe_acme_account" + - $ref: "#/components/x-stackQL-resources/acme_accounts/methods/list_acme_accounts" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/acme_accounts/methods/revoke_acme_account" + delete: [] account_configurations: id: aws.acm.account_configurations name: account_configurations @@ -1951,3 +3857,59 @@ components: replace: - $ref: "#/components/x-stackQL-resources/account_configurations/methods/put_account_configuration" delete: [] + acme_external_account_binding_credentials: + id: aws.acm.acme_external_account_binding_credentials + name: acme_external_account_binding_credentials + title: acme_external_account_binding_credentials + methods: + get_acme_external_account_binding_credentials: + operation: + $ref: "#/paths/~1GetAcmeExternalAccountBindingCredentials/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/acme_external_account_binding_credentials/methods/get_acme_external_account_binding_credentials" + insert: [] + update: [] + delete: [] + certificate_domain_validations: + id: aws.acm.certificate_domain_validations + name: certificate_domain_validations + title: certificate_domain_validations + methods: + list_certificate_domain_validations: + operation: + $ref: "#/paths/~1ListCertificateDomainValidations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.DomainValidationSummaryList + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/certificate_domain_validations/methods/list_certificate_domain_validations" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/acm_pca.yaml b/providers/src/aws/v00.00.00000/services/acm_pca.yaml index 3e03b9ee..771a77b5 100644 --- a/providers/src/aws/v00.00.00000/services/acm_pca.yaml +++ b/providers/src/aws/v00.00.00000/services/acm_pca.yaml @@ -912,7 +912,7 @@ components: description: Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. SigningAlgorithm: $ref: "#/components/schemas/SigningAlgorithm" - description: Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued. + description: Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the SigningAlgorithm parameter of the IssueCertificate API action, which is used to sign certificates when they are issued. Subject: $ref: "#/components/schemas/ASN1Subject" description: Structure that contains X.500 distinguished name information for your private CA. @@ -945,6 +945,9 @@ components: - SHA256WITHRSA - SHA384WITHRSA - SHA512WITHRSA + - SHA256WITHRSA_PSS + - SHA384WITHRSA_PSS + - SHA512WITHRSA_PSS - SM3WITHSM2 - ML_DSA_44 - ML_DSA_65 @@ -1263,7 +1266,7 @@ components: properties: OmitExtension: $ref: "#/components/schemas/Boolean" - description: Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger This configuration cannot be enabled with a custom CNAME set. + description: Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger This configuration cannot be enabled with a custom CNAME set. required: - OmitExtension CrlType: @@ -1275,7 +1278,7 @@ components: type: string minLength: 0 maxLength: 253 - pattern: "[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+(/[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+)*" + pattern: (/|[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+(/[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+)*) OcspConfiguration: description: Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. type: object diff --git a/providers/src/aws/v00.00.00000/services/agent_registry.yaml b/providers/src/aws/v00.00.00000/services/agent_registry.yaml new file mode 100644 index 00000000..d6744d89 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/agent_registry.yaml @@ -0,0 +1,612 @@ +openapi: 3.0.0 +info: + version: "2025-12-01" + title: Agent Registry + description: Agent Registry + x-serviceName: agent-registry + x-serviceAlias: agent_registry + x-protocol: rest-json + x-apiVersion: "2025-12-01" + x-endpointPrefix: agent-registry +servers: + - url: https://agent-registry.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for agent-registry +paths: + /discoverable-records-batch: + post: + operationId: BatchGetDiscoverableRegistryRecord + description: Retrieves multiple discoverable registry records by ID from a single registry. Records that cannot be retrieved are reported individually in the errors list rather than failing the entire request. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + entries: + $ref: "#/components/schemas/BatchGetDiscoverableRegistryRecordRequestEntriesList" + required: + - entries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetDiscoverableRegistryRecordResponse" + /registries/{registry_id}/discoverable-records-list: + post: + operationId: ListDiscoverableRegistryRecords + description: Lists the discoverable registry records in a registry. You can optionally filter and paginate the results. + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/ListDiscoverableRegistryRecordsRequestMaxResultsInteger" + nextToken: + $ref: "#/components/schemas/ListDiscoverableRegistryRecordsRequestNextTokenString" + filters: + $ref: "#/components/schemas/RegistryRecordFilterList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDiscoverableRegistryRecordsResponse" + /discoverable-records-search: + post: + operationId: SearchDiscoverableRegistryRecords + description: Searches the discoverable registry records in a registry using a natural language query. Returns metadata for the matching records ordered by relevance. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + searchQuery: + $ref: "#/components/schemas/SearchQuery" + registryIds: + $ref: "#/components/schemas/SearchDiscoverableRegistryRecordsRequestRegistryIdsList" + maxResults: + $ref: "#/components/schemas/SearchDiscoverableRegistryRecordsRequestMaxResultsInteger" + filters: + $ref: "#/components/schemas/MetadataFilterExpression" + required: + - searchQuery + - registryIds + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchDiscoverableRegistryRecordsResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + BatchGetDiscoverableRegistryRecordRequestEntriesList: + type: array + items: + $ref: "#/components/schemas/RegistryRecordsEntry" + RegistryRecordsEntry: + description: Binds one registry to the record IDs requested from it. + type: object + properties: + registryId: + $ref: "#/components/schemas/RegistryIdentifier" + recordIds: + $ref: "#/components/schemas/RegistryRecordsEntryRecordIdsList" + description: The record IDs to retrieve from the registry. You can specify 1 through 100 record IDs. + required: + - registryId + - recordIds + RegistryIdentifier: + description: Registry identifier that accepts either ARN or ID format + type: string + minLength: 1 + maxLength: 2048 + pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16} + RegistryRecordsEntryRecordIdsList: + type: array + items: + $ref: "#/components/schemas/RecordIdentifier" + RecordIdentifier: + description: Record identifier that accepts either ARN or ID format + type: string + minLength: 1 + maxLength: 2048 + pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12} + BatchGetDiscoverableRegistryRecordResponse: + type: object + properties: + registryRecords: + $ref: "#/components/schemas/RegistryRecordSummaryList" + description: The records that were successfully retrieved. Each record correlates to the request by its recordId. + errors: + $ref: "#/components/schemas/BatchGetDiscoverableRegistryRecordErrorList" + description: The per-record errors for records that could not be retrieved. This list is empty when all requested records were returned. + required: + - registryRecords + - errors + RegistryRecordSummaryList: + type: array + items: + $ref: "#/components/schemas/RegistryRecordSummary" + RegistryRecordSummary: + description: Summary information about a registry record, including its descriptors. + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + recordId: + $ref: "#/components/schemas/RegistryRecordId" + name: + $ref: "#/components/schemas/RegistryRecordName" + description: + $ref: "#/components/schemas/Description" + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + recordType: + $ref: "#/components/schemas/RecordType" + descriptors: + $ref: "#/components/schemas/Descriptors" + description: The protocol-specific descriptors that describe how to connect to and use the record. + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + status: + $ref: "#/components/schemas/RegistryRecordStatus" + createdAt: + $ref: "#/components/schemas/DateTimestamp" + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + required: + - registryArn + - recordArn + - recordId + - name + - recordType + - descriptors + - recordVersion + - status + - createdAt + - updatedAt + RegistryArn: + description: Registry Amazon Resource Name + type: string + minLength: 46 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16} + RegistryRecordArn: + description: Registry Record Amazon Resource Name + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12} + RegistryRecordId: + description: Registry Record unique identifier - 12-character alphanumeric string + type: string + minLength: 12 + maxLength: 12 + pattern: "[a-zA-Z0-9]{12}" + RegistryRecordName: + description: Registry Record name + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" + Description: + description: Description of the Resource + type: string + minLength: 1 + maxLength: 4096 + RegistryRecordDisplayName: + description: Display name for a registry record + type: string + minLength: 1 + maxLength: 255 + RecordType: + description: Record type enum for registry record classification + type: string + enum: + - MCP + - AGENT + - CUSTOM + - SKILL + Descriptors: + description: The protocol-specific descriptors that describe how to connect to and use the registry record. + type: object + properties: + mcpServer: + $ref: "#/components/schemas/McpServerDescriptor" + a2aAgentCard: + $ref: "#/components/schemas/A2aAgentCardDescriptor" + agentSkillsDefinition: + $ref: "#/components/schemas/AgentSkillsDefinitionDescriptor" + custom: + $ref: "#/components/schemas/CustomDescriptor" + McpServerDescriptor: + description: Base mixin for MCP server descriptor content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + additionalData: + $ref: "#/components/schemas/McpServerAdditionalData" + source: + $ref: "#/components/schemas/DescriptorSource" + description: The source location from which the MCP (Model Context Protocol) server descriptor content was retrieved. + DescriptorData: + description: Descriptor payload data + type: string + minLength: 1 + maxLength: 102400 + DataSchemaVersion: + description: Version of the descriptor type schema + type: string + minLength: 1 + maxLength: 255 + McpServerAdditionalData: + description: Additional data for an MCP server descriptor + type: object + properties: + tools: + $ref: "#/components/schemas/McpToolsDescriptor" + McpToolsDescriptor: + description: MCP tools descriptor containing tool definitions + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + DescriptorSource: + description: The source location from which a descriptor's content was retrieved. + type: object + properties: + fromUrl: + $ref: "#/components/schemas/DescriptorSourceFromUrl" + DescriptorSourceFromUrl: + description: Base mixin for descriptor source from URL + type: object + properties: + url: + $ref: "#/components/schemas/DescriptorSourceUrl" + required: + - url + DescriptorSourceUrl: + description: URL source for descriptor content + type: string + minLength: 1 + maxLength: 2048 + pattern: https://.* + A2aAgentCardDescriptor: + description: Base mixin for A2A agent card descriptor content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + source: + $ref: "#/components/schemas/DescriptorSource" + description: The source location from which the A2A (Agent-to-Agent) agent card descriptor content was retrieved. + AgentSkillsDefinitionDescriptor: + description: Base mixin for agent skills definition descriptor content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + additionalData: + $ref: "#/components/schemas/AgentSkillsAdditionalData" + description: Additional data for the agent skills definition, such as the skills markdown descriptor. + AgentSkillsAdditionalData: + description: Additional data for an agent skills definition descriptor. + type: object + properties: + skillMd: + $ref: "#/components/schemas/AgentSkillsMdDescriptor" + AgentSkillsMdDescriptor: + description: Base mixin for agent skills markdown descriptor content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + source: + $ref: "#/components/schemas/DescriptorSource" + description: The source location from which the agent skills markdown content was retrieved. + CustomDescriptor: + description: Custom descriptor for user-defined content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + RegistryRecordVersion: + description: Version of the registry record + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9.-]+" + RegistryRecordStatus: + description: Registry record status + type: string + enum: + - DRAFT + - PENDING_APPROVAL + - APPROVED + - REJECTED + - DEPRECATED + - CREATING + - UPDATING + - CREATE_FAILED + - UPDATE_FAILED + DateTimestamp: + description: Timestamp in ISO 8601 date-time format + type: string + format: date-time + BatchGetDiscoverableRegistryRecordErrorList: + type: array + items: + $ref: "#/components/schemas/BatchGetDiscoverableRegistryRecordError" + BatchGetDiscoverableRegistryRecordError: + description: Describes why a requested record could not be retrieved. + type: object + properties: + registryId: + $ref: "#/components/schemas/RegistryIdentifier" + recordId: + $ref: "#/components/schemas/RecordIdentifier" + errorCode: + $ref: "#/components/schemas/BatchGetDiscoverableRegistryRecordErrorCode" + description: The machine-readable reason that the record could not be retrieved. + message: + $ref: "#/components/schemas/String" + description: An optional human-readable detail about the error. Do not parse this value programmatically. + required: + - registryId + - recordId + - errorCode + BatchGetDiscoverableRegistryRecordErrorCode: + type: string + enum: + - RESOURCE_NOT_FOUND + - ACCESS_DENIED + - INTERNAL_ERROR + String: + type: string + ListDiscoverableRegistryRecordsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListDiscoverableRegistryRecordsRequestNextTokenString: + type: string + minLength: 1 + maxLength: 4096 + RegistryRecordFilterList: + description: The list of filters applied to a ListDiscoverableRegistryRecords request. + type: array + items: + $ref: "#/components/schemas/RegistryRecordFilter" + RegistryRecordFilter: + description: A single filter applied to a ListDiscoverableRegistryRecords request. + type: object + properties: + name: + $ref: "#/components/schemas/RegistryRecordFilterName" + description: The attribute to filter on. + values: + $ref: "#/components/schemas/DiscoverableFilterValues" + description: The values to match for the attribute. + required: + - name + - values + RegistryRecordFilterName: + description: The attribute to filter registry records on. + type: string + enum: + - recordType + - descriptorType + DiscoverableFilterValues: + type: array + items: + $ref: "#/components/schemas/FilterValue" + FilterValue: + description: A single filter value. Constrained by length only; the accepted set of values is filter-specific and validated server-side so enum-style values such as READY or AWS_IAM are accepted. + type: string + minLength: 1 + maxLength: 255 + ListDiscoverableRegistryRecordsResponse: + type: object + properties: + registryRecords: + $ref: "#/components/schemas/DiscoverableRegistryRecordSummaryList" + description: The page of discoverable registry record summaries. + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to pass to a subsequent request to retrieve the next page of results. This field is absent when there are no more results. + required: + - registryRecords + DiscoverableRegistryRecordSummaryList: + type: array + items: + $ref: "#/components/schemas/DiscoverableRegistryRecordSummary" + DiscoverableRegistryRecordSummary: + description: Summary information about a discoverable registry record returned by ListDiscoverableRegistryRecords. This summary does not include descriptors. + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + recordId: + $ref: "#/components/schemas/RegistryRecordId" + name: + $ref: "#/components/schemas/RegistryRecordName" + description: + $ref: "#/components/schemas/Description" + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + recordType: + $ref: "#/components/schemas/RecordType" + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + status: + $ref: "#/components/schemas/RegistryRecordStatus" + createdAt: + $ref: "#/components/schemas/DateTimestamp" + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + required: + - registryArn + - recordArn + - recordId + - name + - recordType + - recordVersion + - status + - createdAt + - updatedAt + SearchQuery: + type: string + minLength: 0 + maxLength: 256 + SearchDiscoverableRegistryRecordsRequestRegistryIdsList: + type: array + items: + $ref: "#/components/schemas/RegistryIdentifier" + SearchDiscoverableRegistryRecordsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 20 + MetadataFilterExpression: + type: object + SearchDiscoverableRegistryRecordsResponse: + type: object + properties: + registryRecords: + $ref: "#/components/schemas/RegistryRecordSummaryList" + description: The registry records that match the search query, ordered by relevance. + required: + - registryRecords + x-stackQL-resources: + discoverable_registry_records: + id: aws.agent_registry.discoverable_registry_records + name: discoverable_registry_records + title: discoverable_registry_records + methods: + batch_get_discoverable_registry_record: + operation: + $ref: "#/paths/~1discoverable-records-batch/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_discoverable_registry_records: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1discoverable-records-list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.registryRecords + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + search_discoverable_registry_records: + operation: + $ref: "#/paths/~1discoverable-records-search/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/discoverable_registry_records/methods/search_discoverable_registry_records" + - $ref: "#/components/x-stackQL-resources/discoverable_registry_records/methods/batch_get_discoverable_registry_record" + - $ref: "#/components/x-stackQL-resources/discoverable_registry_records/methods/list_discoverable_registry_records" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/agent_registry_control.yaml b/providers/src/aws/v00.00.00000/services/agent_registry_control.yaml new file mode 100644 index 00000000..4b4083a5 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/agent_registry_control.yaml @@ -0,0 +1,2007 @@ +openapi: 3.0.0 +info: + version: "2025-12-01" + title: Agent Registry Control + description: Agent Registry Control + x-serviceName: agent-registry + x-serviceAlias: agent_registry_control + x-protocol: rest-json + x-apiVersion: "2025-12-01" + x-endpointPrefix: agent-registry-control +servers: + - url: https://agent-registry-control.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for agent-registry-control +paths: + /registries: + post: + operationId: CreateRegistry + description: "Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/RegistryName" + description: + $ref: "#/components/schemas/Description" + discoveryConfiguration: + $ref: "#/components/schemas/DiscoveryConfiguration" + clientToken: + $ref: "#/components/schemas/ClientToken" + tags: + $ref: "#/components/schemas/TagsMap" + approvalConfiguration: + $ref: "#/components/schemas/ApprovalConfiguration" + required: + - name + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateRegistryResponse" + /registries/{registry_id}/records: + post: + operationId: CreateRegistryRecord + description: "Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed." + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry in which to create the record (ARN or ID) + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/RegistryRecordName" + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + description: + $ref: "#/components/schemas/Description" + recordType: + $ref: "#/components/schemas/RecordType" + descriptors: + $ref: "#/components/schemas/Descriptors" + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + clientToken: + $ref: "#/components/schemas/ClientToken" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - name + - recordType + - descriptors + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateRegistryRecordResponse" + /registries/{registry_id}: + delete: + operationId: DeleteRegistry + description: "Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records." + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry to delete (ARN or ID) + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRegistryResponse" + get: + operationId: GetRegistry + description: Gets a registry by identifier (ARN or ID) + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry to retrieve (ARN or ID) + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRegistryResponse" + patch: + operationId: UpdateRegistry + description: "Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed." + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry to update (ARN or ID) + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/RegistryName" + description: + $ref: "#/components/schemas/UpdatedDescription" + discoveryConfiguration: + $ref: "#/components/schemas/UpdatedDiscoveryConfiguration" + approvalConfiguration: + $ref: "#/components/schemas/UpdatedApprovalConfiguration" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRegistryResponse" + /registries/{registry_id}/records/{record_id}: + delete: + operationId: DeleteRegistryRecord + description: Deletes a registry record + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry containing the record (ARN or ID) + - name: record_id + in: path + required: true + schema: + $ref: "#/components/schemas/RecordIdentifier" + description: The identifier of the registry record to delete (ARN or ID) + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRegistryRecordResponse" + get: + operationId: GetRegistryRecord + description: Retrieves the details of a registry record + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry containing the record (ARN or ID) + - name: record_id + in: path + required: true + schema: + $ref: "#/components/schemas/RecordIdentifier" + description: The identifier of the registry record to retrieve (ARN or ID) + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRegistryRecordResponse" + patch: + operationId: UpdateRegistryRecord + description: "Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged." + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry containing the record (ARN or ID) + - name: record_id + in: path + required: true + schema: + $ref: "#/components/schemas/RecordIdentifier" + description: The identifier of the registry record to update (ARN or ID) + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/RegistryRecordName" + displayName: + $ref: "#/components/schemas/UpdatedDisplayName" + description: + $ref: "#/components/schemas/UpdatedDescription" + recordType: + $ref: "#/components/schemas/RecordType" + descriptors: + $ref: "#/components/schemas/UpdatedDescriptors" + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + triggerSynchronization: + $ref: "#/components/schemas/Boolean" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRegistryRecordResponse" + /registries-list: + post: + operationId: ListRegistries + description: Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/MaxResults" + nextToken: + $ref: "#/components/schemas/NextToken" + filters: + $ref: "#/components/schemas/RegistryFilterList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRegistriesResponse" + /registries/{registry_id}/records-list: + post: + operationId: ListRegistryRecords + description: Lists the registry records within a registry, with optional filtering by name, status, and record type + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry to list records from (ARN or ID) + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/MaxResults" + nextToken: + $ref: "#/components/schemas/NextToken" + filters: + $ref: "#/components/schemas/RegistryRecordFilterList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRegistryRecordsResponse" + /tags/{resource_arn}: + get: + operationId: ListTagsForResource + description: List the tags on a resource + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceArn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + post: + operationId: TagResource + description: Tag a resource with key-value pairs + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceArn" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tags: + $ref: "#/components/schemas/TagsMap" + required: + - tags + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceResponse" + delete: + operationId: UntagResource + description: Remove tags from a resource by key + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceArn" + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeyList" + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceResponse" + /registries/{registry_id}/records/{record_id}/submit-for-approval: + post: + operationId: SubmitRegistryRecordForApproval + description: Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject. + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry containing the record (ARN or ID) + - name: record_id + in: path + required: true + schema: + $ref: "#/components/schemas/RecordIdentifier" + description: The identifier of the registry record to submit for approval (ARN or ID) + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SubmitRegistryRecordForApprovalResponse" + /registries/{registry_id}/records/{record_id}/status: + patch: + operationId: UpdateRegistryRecordStatus + description: Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable + parameters: + - name: registry_id + in: path + required: true + schema: + $ref: "#/components/schemas/RegistryIdentifier" + description: The identifier of the registry containing the record (ARN or ID) + - name: record_id + in: path + required: true + schema: + $ref: "#/components/schemas/RecordIdentifier" + description: The identifier of the registry record to update the status of (ARN or ID) + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + $ref: "#/components/schemas/RegistryRecordStatus" + statusReason: + $ref: "#/components/schemas/UpdateRegistryRecordStatusRequestStatusReasonString" + required: + - status + - statusReason + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRegistryRecordStatusResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + RegistryName: + description: Registry name with validation pattern + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" + Description: + description: Description of the Resource + type: string + minLength: 1 + maxLength: 4096 + DiscoveryConfiguration: + description: Discovery configuration for the registry. Controls how consumers are authorized to search the registry and invoke its MCP endpoint. + type: object + properties: + authorizerConfiguration: + $ref: "#/components/schemas/AuthorizerConfiguration" + description: The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT. + authorizerType: + $ref: "#/components/schemas/RegistryAuthorizerType" + description: The type of authorizer that controls how consumers access the registry's search and MCP invoke operations. + AuthorizerConfiguration: + description: The authorizer configuration for a registry. Exactly one member is set. + type: object + properties: + customJWTAuthorizer: + $ref: "#/components/schemas/CustomJWTAuthorizerConfiguration" + description: Configuration for a custom JWT authorizer. + CustomJWTAuthorizerConfiguration: + description: Configuration for a custom JWT authorizer that validates inbound bearer tokens against an OpenID Connect identity provider. + type: object + properties: + discoveryUrl: + $ref: "#/components/schemas/DiscoveryUrl" + description: The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys. + allowedAudience: + $ref: "#/components/schemas/AllowedAudienceList" + description: The audience values accepted during JWT validation. A token is rejected if none of its audience claims match. + allowedClients: + $ref: "#/components/schemas/AllowedClientsList" + description: The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients. + allowedScopes: + $ref: "#/components/schemas/AllowedScopesType" + description: The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes. + customClaims: + $ref: "#/components/schemas/CustomClaimValidationsType" + description: Additional custom claim validations applied to the inbound JWT. + privateEndpoint: + $ref: "#/components/schemas/PrivateEndpoint" + description: The private endpoint used to reach the identity provider's discovery URL over a private network path. + privateEndpointOverrides: + $ref: "#/components/schemas/PrivateEndpointOverrides" + description: Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints. + required: + - discoveryUrl + DiscoveryUrl: + description: The OpenID Connect discovery URL, ending in /.well-known/openid-configuration, used to retrieve the identity provider's metadata and signing keys. + type: string + minLength: 1 + maxLength: 2048 + pattern: .+/\.well-known/openid-configuration + AllowedAudienceList: + description: The list of audience values accepted during JWT validation. + type: array + items: + $ref: "#/components/schemas/AllowedAudience" + AllowedAudience: + description: An audience value that an inbound JWT must contain to be authorized. + type: string + minLength: 1 + maxLength: 255 + AllowedClientsList: + description: The list of client identifiers accepted during JWT validation. + type: array + items: + $ref: "#/components/schemas/AllowedClient" + AllowedClient: + description: A client identifier that an inbound JWT must be issued to in order to be authorized. + type: string + minLength: 1 + maxLength: 255 + AllowedScopesType: + description: The list of scopes accepted during JWT validation. + type: array + items: + $ref: "#/components/schemas/AllowedScopeType" + AllowedScopeType: + description: A scope value that an inbound JWT must carry to be authorized. + type: string + minLength: 1 + maxLength: 255 + pattern: "[\\x21\\x23-\\x5B\\x5D-\\x7E]+" + CustomClaimValidationsType: + description: The list of custom claim validations applied to an inbound JWT. + type: array + items: + $ref: "#/components/schemas/CustomClaimValidationType" + CustomClaimValidationType: + description: A validation rule applied to a single claim of an inbound JWT. + type: object + properties: + inboundTokenClaimName: + $ref: "#/components/schemas/InboundTokenClaimNameType" + description: The name of the claim in the inbound token to validate. + inboundTokenClaimValueType: + $ref: "#/components/schemas/InboundTokenClaimValueType" + description: The value type of the claim in the inbound token, either a string or an array of strings. + authorizingClaimMatchValue: + $ref: "#/components/schemas/AuthorizingClaimMatchValueType" + description: The value and match operator used to authorize the claim. + required: + - inboundTokenClaimName + - inboundTokenClaimValueType + - authorizingClaimMatchValue + InboundTokenClaimNameType: + description: The name of a claim in an inbound JWT. + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9_.-:]+" + InboundTokenClaimValueType: + description: The value type of a claim in an inbound JWT. + type: string + enum: + - STRING + - STRING_ARRAY + AuthorizingClaimMatchValueType: + description: The value and match operator used to authorize a claim during JWT validation. + type: object + properties: + claimMatchValue: + $ref: "#/components/schemas/ClaimMatchValueType" + description: The expected value or values that the claim is compared against. + claimMatchOperator: + $ref: "#/components/schemas/ClaimMatchOperatorType" + description: The operator used to compare the claim value against the expected value. + required: + - claimMatchValue + - claimMatchOperator + ClaimMatchValueType: + description: The expected value used to match a claim. Exactly one member is set. + type: object + properties: + matchValueString: + $ref: "#/components/schemas/MatchValueString" + description: A single string value to match the claim against. + matchValueStringList: + $ref: "#/components/schemas/MatchValueStringList" + description: A list of string values to match the claim against. + MatchValueString: + description: A single value used to match a claim during JWT validation. + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9_.:/-]+" + MatchValueStringList: + description: A list of values used to match a claim during JWT validation. + type: array + items: + $ref: "#/components/schemas/MatchValueString" + ClaimMatchOperatorType: + description: The operator used to compare a claim value against the expected value during JWT validation. + type: string + enum: + - EQUALS + - CONTAINS + - CONTAINS_ANY + PrivateEndpoint: + description: A private network endpoint used to reach a resource over a private path. Exactly one member is set. + type: object + properties: + selfManagedLatticeResource: + $ref: "#/components/schemas/SelfManagedLatticeResource" + description: A private endpoint backed by a self-managed VPC Lattice resource configuration. + managedVpcResource: + $ref: "#/components/schemas/ManagedVpcResource" + description: A private endpoint backed by a service-managed VPC resource. + SelfManagedLatticeResource: + description: A self-managed private endpoint backed by a VPC Lattice resource configuration. Exactly one member is set. + type: object + properties: + resourceConfigurationIdentifier: + $ref: "#/components/schemas/ResourceConfigurationIdentifier" + description: The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN. + ResourceConfigurationIdentifier: + description: The identifier of a VPC Lattice resource configuration, specified as a resource configuration ID or ARN. + type: string + minLength: 20 + maxLength: 2048 + pattern: ((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17})) + ManagedVpcResource: + description: A service-managed private endpoint provisioned within a customer VPC. + type: object + properties: + vpcIdentifier: + $ref: "#/components/schemas/VpcIdentifier" + description: The identifier of the VPC in which the private endpoint is provisioned. + subnetIds: + $ref: "#/components/schemas/SubnetIds" + description: The identifiers of the subnets in which the private endpoint network interfaces are placed. + endpointIpAddressType: + $ref: "#/components/schemas/EndpointIpAddressType" + description: The IP address type used by the private endpoint, either IPV4 or IPV6. + securityGroupIds: + $ref: "#/components/schemas/SecurityGroupIds" + description: The identifiers of the security groups associated with the private endpoint network interfaces. + tags: + type: object + properties: {} + routingDomain: + $ref: "#/components/schemas/RoutingDomain" + description: The routing domain used to resolve traffic through the private endpoint. + required: + - vpcIdentifier + - subnetIds + - endpointIpAddressType + VpcIdentifier: + description: The identifier of a VPC. + type: string + minLength: 10 + maxLength: 48 + pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17})) + SubnetIds: + description: The list of subnet identifiers in which the private endpoint network interfaces are placed. + type: array + items: + $ref: "#/components/schemas/SubnetId" + SubnetId: + description: Subnet identifier + type: string + minLength: 15 + maxLength: 24 + pattern: subnet-[0-9a-zA-Z]{8,17} + EndpointIpAddressType: + description: The IP address type used by a private endpoint. + type: string + enum: + - IPV4 + - IPV6 + SecurityGroupIds: + description: The list of security group identifiers associated with a private endpoint. + type: array + items: + $ref: "#/components/schemas/SecurityGroupIdentifier" + SecurityGroupIdentifier: + description: The identifier of a security group. + type: string + minLength: 10 + maxLength: 48 + pattern: sg-(([0-9a-z]{8})|([0-9a-z]{17})) + RoutingDomain: + description: The routing domain used to resolve traffic through a private endpoint. + type: string + minLength: 3 + maxLength: 255 + PrivateEndpointOverrides: + description: The list of per-domain private endpoint overrides. + type: array + items: + $ref: "#/components/schemas/PrivateEndpointOverride" + PrivateEndpointOverride: + description: A mapping of a domain to the private endpoint used to reach it. + type: object + properties: + domain: + $ref: "#/components/schemas/PrivateEndpointOverrideDomain" + description: The domain name to which this private endpoint override applies. + privateEndpoint: + $ref: "#/components/schemas/PrivateEndpoint" + description: The private endpoint used to reach the specified domain. + required: + - domain + - privateEndpoint + PrivateEndpointOverrideDomain: + description: A domain name for which a specific private endpoint override applies. + type: string + minLength: 1 + maxLength: 253 + RegistryAuthorizerType: + type: string + enum: + - CUSTOM_JWT + - AWS_IAM + ClientToken: + description: Client specified token used for idempotency checks + type: string + minLength: 33 + maxLength: 256 + pattern: "[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" + TagsMap: + description: A map of tag keys to tag values. + type: object + properties: {} + ApprovalConfiguration: + description: Configuration for the registry's record approval workflow. Controls whether records submitted for approval require manual review before they become approved and discoverable, or are auto-approved. When no auto-approval rules are configured, submitted records require manual review. + type: object + properties: + autoApprovalRules: + $ref: "#/components/schemas/AutoApprovalRuleList" + description: The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review. + AutoApprovalRuleList: + type: array + items: + $ref: "#/components/schemas/AutoApprovalRule" + AutoApprovalRule: + type: string + enum: + - APPROVE_ALL + CreateRegistryResponse: + description: Response structure for creating a registry + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The ARN of the created registry + required: + - registryArn + RegistryArn: + description: Registry Amazon Resource Name + type: string + minLength: 46 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16} + RegistryIdentifier: + description: Registry identifier that accepts either ARN or ID format + type: string + minLength: 1 + maxLength: 2048 + pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16} + RegistryRecordName: + description: Registry Record name + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" + RegistryRecordDisplayName: + description: Display name for a registry record + type: string + minLength: 1 + maxLength: 255 + RecordType: + description: Record type enum for registry record classification + type: string + enum: + - MCP + - AGENT + - CUSTOM + - SKILL + Descriptors: + description: The typed set of descriptors for a registry record. Exactly one descriptor field is populated based on the record type. + type: object + properties: + mcpServer: + $ref: "#/components/schemas/McpServerDescriptor" + description: The MCP server descriptor, populated when the record type is MCP. + a2aAgentCard: + $ref: "#/components/schemas/A2aAgentCardDescriptor" + description: The A2A agent card descriptor, populated when the record type is AGENT. + agentSkillsDefinition: + $ref: "#/components/schemas/AgentSkillsDefinitionDescriptor" + description: The agent skills definition descriptor, populated when the record type is SKILL. + custom: + $ref: "#/components/schemas/CustomDescriptor" + description: The custom descriptor, populated when the record type is CUSTOM. + McpServerDescriptor: + description: Descriptor that defines the content of an MCP (Model Context Protocol) server registry record, including the server definition and its tool definitions. The content is validated against the MCP protocol schema. + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + description: The MCP server descriptor content, serialized as descriptor payload data. + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + description: The schema version of the descriptor payload. + additionalData: + $ref: "#/components/schemas/McpServerAdditionalData" + description: Additional data associated with the MCP server descriptor, such as tool definitions. + source: + $ref: "#/components/schemas/DescriptorSource" + description: The optional source configuration used to synchronize the MCP server descriptor content. + DescriptorData: + description: Descriptor payload data + type: string + minLength: 1 + maxLength: 102400 + DataSchemaVersion: + description: Version of the descriptor type schema + type: string + minLength: 1 + maxLength: 255 + McpServerAdditionalData: + description: Additional data for an MCP server descriptor + type: object + properties: + tools: + $ref: "#/components/schemas/McpToolsDescriptor" + McpToolsDescriptor: + description: MCP tools descriptor containing tool definitions + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + DescriptorSource: + description: The source configuration that defines where descriptor content is retrieved from. + type: object + properties: + fromUrl: + $ref: "#/components/schemas/DescriptorSourceFromUrl" + description: URL-based descriptor source, populated when descriptor content is synchronized from a URL. + DescriptorSourceFromUrl: + description: URL-based descriptor source configuration, with credential provider configurations for authenticated URL retrieval. + type: object + properties: + url: + $ref: "#/components/schemas/DescriptorSourceUrl" + description: The URL from which the descriptor content is retrieved. + credentialProviderConfigurations: + $ref: "#/components/schemas/RegistryRecordCredentialProviderConfigurationList" + description: The credential providers used to authenticate when fetching descriptor content from the source URL. + required: + - url + DescriptorSourceUrl: + description: URL source for descriptor content + type: string + minLength: 1 + maxLength: 2048 + pattern: https://.* + RegistryRecordCredentialProviderConfigurationList: + type: array + items: + $ref: "#/components/schemas/RegistryRecordCredentialProviderConfiguration" + RegistryRecordCredentialProviderConfiguration: + description: A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL. + type: object + properties: + credentialProviderType: + $ref: "#/components/schemas/RegistryRecordCredentialProviderType" + description: The type of credential provider. + credentialProvider: + $ref: "#/components/schemas/RegistryRecordCredentialProviderUnion" + description: The credential provider details corresponding to the specified credential provider type. + required: + - credentialProviderType + - credentialProvider + RegistryRecordCredentialProviderType: + type: string + enum: + - OAUTH + - IAM + RegistryRecordCredentialProviderUnion: + description: The credential provider details for a registry record. Exactly one member is populated, matching the configured credential provider type. + type: object + properties: + oauthCredentialProvider: + $ref: "#/components/schemas/RegistryRecordOAuthCredentialProvider" + description: The OAuth 2.0 credential provider details. + iamCredentialProvider: + $ref: "#/components/schemas/RegistryRecordIamCredentialProvider" + description: The IAM role credential provider details. + RegistryRecordOAuthCredentialProvider: + description: The configuration for an OAuth 2.0 credential provider that authenticates requests to a registry record's source. + type: object + properties: + providerArn: + $ref: "#/components/schemas/CredentialProviderArn" + description: The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity. + grantType: + $ref: "#/components/schemas/RegistryRecordOAuthGrantType" + description: The OAuth 2.0 grant type used to obtain access tokens. + scopes: + $ref: "#/components/schemas/ScopeList" + description: The OAuth 2.0 scopes to request when obtaining access tokens. + customParameters: + type: object + properties: {} + description: Additional parameters to include in the OAuth 2.0 token request. + required: + - providerArn + CredentialProviderArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.* + RegistryRecordOAuthGrantType: + type: string + enum: + - CLIENT_CREDENTIALS + ScopeList: + type: array + items: + $ref: "#/components/schemas/String" + String: + type: string + RegistryRecordIamCredentialProvider: + description: The configuration for an IAM role credential provider that signs requests to a registry record's source with AWS Signature Version 4 (SigV4). + type: object + properties: + roleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The &ARN; of the IAM role to assume for request signing. + service: + $ref: "#/components/schemas/IamSigningServiceName" + description: The service name to use for request signing, such as execute-api. + region: + $ref: "#/components/schemas/IamSigningRegion" + description: The AWS Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry. + IamRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ + IamSigningServiceName: + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + IamSigningRegion: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-z0-9-]+" + A2aAgentCardDescriptor: + description: Descriptor that defines the content of an A2A (Agent-to-Agent) agent card registry record. The content is validated against the A2A protocol schema. + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + description: The A2A agent card content, serialized as descriptor payload data. + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + description: The schema version of the descriptor payload. + source: + $ref: "#/components/schemas/DescriptorSource" + description: The optional source configuration used to synchronize the A2A agent card descriptor content. + AgentSkillsDefinitionDescriptor: + description: Descriptor that defines an agent skills registry record and its associated content. + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + description: The agent skills definition content, serialized as descriptor payload data. + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + description: The schema version of the descriptor payload. + additionalData: + $ref: "#/components/schemas/AgentSkillsAdditionalData" + description: Additional data associated with the agent skills definition descriptor. + AgentSkillsAdditionalData: + description: Additional data associated with an agent skills definition descriptor. + type: object + properties: + skillMd: + $ref: "#/components/schemas/AgentSkillsMdDescriptor" + description: The markdown skill content associated with an agent skills definition. + AgentSkillsMdDescriptor: + description: Markdown-format descriptor containing an agent skills document. + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + description: The agent skills markdown content, serialized as descriptor payload data. + dataSchemaVersion: + $ref: "#/components/schemas/DataSchemaVersion" + description: The schema version of the descriptor payload. + source: + $ref: "#/components/schemas/DescriptorSource" + description: The optional source configuration used to synchronize the agent skills markdown content. + CustomDescriptor: + description: Custom descriptor for user-defined content + type: object + properties: + data: + $ref: "#/components/schemas/DescriptorData" + RegistryRecordVersion: + description: Version of the registry record + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9.-]+" + CreateRegistryRecordResponse: + description: Response structure for creating a registry record + type: object + properties: + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The ARN of the created registry record + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The status of the registry record, set to CREATING while the asynchronous workflow is in progress + required: + - recordArn + - status + RegistryRecordArn: + description: Registry Record Amazon Resource Name + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12} + RegistryRecordStatus: + description: Registry record status + type: string + enum: + - DRAFT + - PENDING_APPROVAL + - APPROVED + - REJECTED + - DEPRECATED + - CREATING + - UPDATING + - CREATE_FAILED + - UPDATE_FAILED + DeleteRegistryResponse: + description: Response structure for deleting a registry + type: object + properties: + status: + $ref: "#/components/schemas/RegistryStatus" + description: Current status of the registry, set to DELETING when deletion is initiated + required: + - status + RegistryStatus: + type: string + enum: + - CREATING + - READY + - UPDATING + - CREATE_FAILED + - UPDATE_FAILED + - DELETING + - DELETE_FAILED + RecordIdentifier: + description: Record identifier that accepts either ARN or ID format + type: string + minLength: 1 + maxLength: 2048 + pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12} + DeleteRegistryRecordResponse: + description: Response structure for deleting a registry record + type: object + GetRegistryResponse: + description: Response structure for getting a registry + type: object + properties: + name: + $ref: "#/components/schemas/RegistryName" + description: The name of the registry + description: + $ref: "#/components/schemas/Description" + description: The description of the registry + registryId: + $ref: "#/components/schemas/RegistryId" + description: The unique identifier of the registry + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The ARN of the registry + discoveryConfiguration: + $ref: "#/components/schemas/DiscoveryConfiguration" + description: Discovery configuration for the registry + approvalConfiguration: + $ref: "#/components/schemas/ApprovalConfiguration" + description: Approval configuration for registry records + status: + $ref: "#/components/schemas/RegistryStatus" + description: Current status of the registry + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status. Typically populated when the status indicates a failure state. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was created + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was last updated + required: + - name + - registryId + - registryArn + - status + - createdAt + - updatedAt + RegistryId: + description: Registry unique identifier - 12-character alphanumeric string + type: string + minLength: 12 + maxLength: 16 + pattern: "[a-zA-Z0-9]{12,16}" + DateTimestamp: + description: Timestamp in ISO 8601 date-time format + type: string + format: date-time + GetRegistryRecordResponse: + description: Response structure for retrieving a registry record + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The &ARN; of the parent registry that owns the record. + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The &ARN; of the registry record. + recordId: + $ref: "#/components/schemas/RegistryRecordId" + description: The unique identifier of the registry record. + name: + $ref: "#/components/schemas/RegistryRecordName" + description: The name of the registry record. Names are unique within a registry. + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + description: The human-readable display name of the registry record. + description: + $ref: "#/components/schemas/Description" + description: A description of the registry record. + recordType: + $ref: "#/components/schemas/RecordType" + description: The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM. + descriptors: + $ref: "#/components/schemas/Descriptors" + description: The typed descriptors that define the content of the registry record. + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + description: The version identifier of the registry record. + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The lifecycle status of the registry record. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was last updated. + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status. Typically populated when the status indicates a failure state. + required: + - registryArn + - recordArn + - recordId + - name + - recordType + - status + - createdAt + - updatedAt + RegistryRecordId: + description: Registry Record unique identifier - 12-character alphanumeric string + type: string + minLength: 12 + maxLength: 12 + pattern: "[a-zA-Z0-9]{12}" + MaxResults: + description: Maximum number of items to be listed + type: integer + minimum: 1 + maximum: 100 + NextToken: + description: Opaque continuation token of previous paginated response + type: string + minLength: 1 + maxLength: 2048 + pattern: \S* + RegistryFilterList: + type: array + items: + $ref: "#/components/schemas/RegistryFilter" + RegistryFilter: + description: A single filter applied to a ListRegistries request. + type: object + properties: + name: + $ref: "#/components/schemas/RegistryFilterName" + description: The attribute to filter on + values: + $ref: "#/components/schemas/FilterValues" + description: The values to match for the attribute + required: + - name + - values + RegistryFilterName: + type: string + enum: + - status + - discoveryConfiguration.authorizerType + FilterValues: + description: The values supplied for a single filter. + type: array + items: + $ref: "#/components/schemas/FilterValue" + FilterValue: + description: A single filter value. Constrained by length only; the accepted set of values is filter-specific and validated server-side so enum-style values such as READY or AWS_IAM are accepted. + type: string + minLength: 1 + maxLength: 255 + ListRegistriesResponse: + description: Response structure for listing registries + type: object + properties: + registries: + $ref: "#/components/schemas/RegistrySummaryList" + description: List of registry summaries + nextToken: + $ref: "#/components/schemas/NextToken" + description: Token for next page of results + required: + - registries + RegistrySummaryList: + type: array + items: + $ref: "#/components/schemas/RegistrySummary" + RegistrySummary: + description: Registry summary for list operations + type: object + properties: + name: + $ref: "#/components/schemas/RegistryName" + description: Registry name + description: + $ref: "#/components/schemas/Description" + description: Registry description + registryId: + $ref: "#/components/schemas/RegistryId" + description: Unique registry identifier + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: Registry Amazon Resource Name + discoveryConfiguration: + $ref: "#/components/schemas/DiscoveryConfiguration" + description: Discovery configuration for the registry + status: + $ref: "#/components/schemas/RegistryStatus" + description: Current status of the registry + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status. Typically populated when the status indicates a failure state. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was created + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was last updated + required: + - name + - registryId + - registryArn + - status + - createdAt + - updatedAt + RegistryRecordFilterList: + type: array + items: + $ref: "#/components/schemas/RegistryRecordFilter" + RegistryRecordFilter: + description: A single filter applied to a ListRegistryRecords request. + type: object + properties: + name: + $ref: "#/components/schemas/RegistryRecordFilterName" + description: The attribute to filter on + values: + $ref: "#/components/schemas/FilterValues" + description: The values to match for the attribute + required: + - name + - values + RegistryRecordFilterName: + type: string + enum: + - name + - status + - recordType + ListRegistryRecordsResponse: + description: Response structure for listing registry records + type: object + properties: + registryRecords: + $ref: "#/components/schemas/RegistryRecordSummaryList" + description: List of registry record summaries + nextToken: + $ref: "#/components/schemas/NextToken" + description: Token for next page of results + required: + - registryRecords + RegistryRecordSummaryList: + type: array + items: + $ref: "#/components/schemas/RegistryRecordSummary" + RegistryRecordSummary: + description: A summary of a registry record returned by list operations. Contains identifying and lifecycle fields but omits descriptor content. + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The &ARN; of the parent registry that owns the record. + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The &ARN; of the registry record. + recordId: + $ref: "#/components/schemas/RegistryRecordId" + description: The unique identifier of the registry record. + name: + $ref: "#/components/schemas/RegistryRecordName" + description: The name of the registry record. Names are unique within a registry. + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + description: The human-readable display name of the registry record. + description: + $ref: "#/components/schemas/Description" + description: A description of the registry record. + recordType: + $ref: "#/components/schemas/RecordType" + description: The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM. + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + description: The version identifier of the registry record. + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The lifecycle status of the registry record. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was last updated. + required: + - registryArn + - recordArn + - recordId + - name + - recordType + - recordVersion + - status + - createdAt + - updatedAt + ResourceArn: + description: ARN of a taggable Agent Registry resource. + type: string + minLength: 1 + maxLength: 1011 + ListTagsForResourceResponse: + type: object + properties: + tags: + type: object + properties: {} + SubmitRegistryRecordForApprovalResponse: + description: Response structure for submitting a registry record for approval + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The ARN of the registry + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The ARN of the registry record + recordId: + $ref: "#/components/schemas/RegistryRecordId" + description: The ID of the registry record + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The resulting status of the registry record + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the record was last updated + required: + - registryArn + - recordArn + - recordId + - status + - updatedAt + TagResourceResponse: + type: object + TagKeyList: + description: A list of tag keys. + type: array + items: + $ref: "#/components/schemas/TagKey" + TagKey: + description: Key of a tag. + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9\\s._:/=+@-]*" + UntagResourceResponse: + type: object + UpdatedDescription: + description: Wrapper for updating an optional Description field with PATCH semantics + type: object + properties: + optionalValue: + $ref: "#/components/schemas/Description" + UpdatedDiscoveryConfiguration: + description: The discovery configuration fields to update on a registry. Omit this structure to leave the discovery configuration unchanged. + type: object + properties: + authorizerConfiguration: + $ref: "#/components/schemas/UpdatedAuthorizerConfiguration" + description: Authorization configuration for the registry, with PATCH semantics + UpdatedAuthorizerConfiguration: + description: Wrapper for updating an optional authorizer configuration with PATCH semantics. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/AuthorizerConfiguration" + description: The new authorizer configuration to set. Omit to leave the existing configuration unchanged. + UpdatedApprovalConfiguration: + description: A wrapper for updating the approval configuration of a registry. Include this wrapper to replace the approval configuration with the specified value; omit it to leave the approval configuration unchanged. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/ApprovalConfiguration" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdateRegistryResponse: + description: Response structure for updating a registry + type: object + properties: + name: + $ref: "#/components/schemas/RegistryName" + description: The name of the registry + description: + $ref: "#/components/schemas/Description" + description: The description of the registry + registryId: + $ref: "#/components/schemas/RegistryId" + description: The unique identifier of the registry + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The ARN of the registry + discoveryConfiguration: + $ref: "#/components/schemas/DiscoveryConfiguration" + description: Discovery configuration for the registry + approvalConfiguration: + $ref: "#/components/schemas/ApprovalConfiguration" + description: Approval configuration for registry records + status: + $ref: "#/components/schemas/RegistryStatus" + description: Current status of the registry + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status. Typically populated when the status indicates a failure state. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was created + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry was last updated + required: + - name + - registryId + - registryArn + - status + - createdAt + - updatedAt + UpdatedDisplayName: + description: Leaf patch wrapper for a registry record's display name. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/RegistryRecordDisplayName" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedDescriptors: + description: The top-level descriptors patch wrapper used in UpdateRegistryRecord. Omit to leave the current descriptors unchanged; supply an empty object to clear them; supply optionalValue to apply a per-field patch. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedDescriptorsFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedDescriptorsFields: + description: The patchable descriptor fields applied during an UpdateRegistryRecord call. Each field is independently patchable. + type: object + properties: + mcpServer: + $ref: "#/components/schemas/UpdatedMcpServerDescriptor" + description: The patch for the MCP server descriptor. + a2aAgentCard: + $ref: "#/components/schemas/UpdatedA2aAgentCardDescriptor" + description: The patch for the A2A agent card descriptor. + agentSkillsDefinition: + $ref: "#/components/schemas/UpdatedAgentSkillsDefinitionDescriptor" + description: The patch for the agent skills definition descriptor. + custom: + $ref: "#/components/schemas/UpdatedCustomDescriptor" + description: The patch for the custom descriptor. + UpdatedMcpServerDescriptor: + description: The MCP server descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedMcpServerDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedMcpServerDescriptorFields: + description: The set of MCP server descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + dataSchemaVersion: + $ref: "#/components/schemas/UpdatedDataSchemaVersion" + description: The patch for the descriptor's data schema version field. + source: + $ref: "#/components/schemas/UpdatedDescriptorSource" + description: The patch for the descriptor's source field. + additionalData: + $ref: "#/components/schemas/UpdatedMcpServerAdditionalData" + description: The patch for the descriptor's additional data field. + UpdatedDescriptorData: + description: Leaf patch wrapper for descriptor data. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/DescriptorData" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedDataSchemaVersion: + description: Leaf patch wrapper for a descriptor's data schema version. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/DataSchemaVersion" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedDescriptorSource: + description: Leaf patch wrapper for a descriptor's source configuration. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/DescriptorSource" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedMcpServerAdditionalData: + description: The MCP server additional-data patch wrapper. Omit to leave the additional data unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedMcpServerAdditionalDataFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedMcpServerAdditionalDataFields: + description: The set of MCP server additional-data fields that can be individually updated. + type: object + properties: + tools: + $ref: "#/components/schemas/UpdatedMcpToolsDescriptor" + description: The patch for the MCP tools descriptor field. + UpdatedMcpToolsDescriptor: + description: The MCP tools descriptor patch wrapper. Omit to leave the tools descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedMcpToolsDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedMcpToolsDescriptorFields: + description: The set of MCP tools descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + dataSchemaVersion: + $ref: "#/components/schemas/UpdatedDataSchemaVersion" + description: The patch for the descriptor's data schema version field. + UpdatedA2aAgentCardDescriptor: + description: The A2A agent card descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedA2aAgentCardDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedA2aAgentCardDescriptorFields: + description: The set of A2A agent card descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + dataSchemaVersion: + $ref: "#/components/schemas/UpdatedDataSchemaVersion" + description: The patch for the descriptor's data schema version field. + source: + $ref: "#/components/schemas/UpdatedDescriptorSource" + description: The patch for the descriptor's source field. + UpdatedAgentSkillsDefinitionDescriptor: + description: The agent skills definition descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedAgentSkillsDefinitionDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedAgentSkillsDefinitionDescriptorFields: + description: The set of agent skills definition descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + dataSchemaVersion: + $ref: "#/components/schemas/UpdatedDataSchemaVersion" + description: The patch for the descriptor's data schema version field. + additionalData: + $ref: "#/components/schemas/UpdatedAgentSkillsAdditionalData" + description: The patch for the descriptor's additional data field. + UpdatedAgentSkillsAdditionalData: + description: The agent skills additional-data patch wrapper. Omit to leave the additional data unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedAgentSkillsAdditionalDataFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedAgentSkillsAdditionalDataFields: + description: The set of agent skills additional-data fields that can be individually updated. + type: object + properties: + skillMd: + $ref: "#/components/schemas/UpdatedAgentSkillsMdDescriptor" + description: The patch for the agent skills markdown descriptor field. + UpdatedAgentSkillsMdDescriptor: + description: The agent skills markdown descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedAgentSkillsMdDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedAgentSkillsMdDescriptorFields: + description: The set of agent skills markdown descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + dataSchemaVersion: + $ref: "#/components/schemas/UpdatedDataSchemaVersion" + description: The patch for the descriptor's data schema version field. + source: + $ref: "#/components/schemas/UpdatedDescriptorSource" + description: The patch for the descriptor's source field. + UpdatedCustomDescriptor: + description: The custom descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/UpdatedCustomDescriptorFields" + description: The value to set for this field. Omit the wrapper to leave the field unchanged. + UpdatedCustomDescriptorFields: + description: The set of custom descriptor fields that can be individually updated. + type: object + properties: + data: + $ref: "#/components/schemas/UpdatedDescriptorData" + description: The patch for the descriptor's data field. + Boolean: + type: boolean + UpdateRegistryRecordResponse: + description: Response structure for updating a registry record + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The &ARN; of the parent registry that owns the record. + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The &ARN; of the registry record. + recordId: + $ref: "#/components/schemas/RegistryRecordId" + description: The unique identifier of the registry record. + name: + $ref: "#/components/schemas/RegistryRecordName" + description: The name of the registry record. Names are unique within a registry. + displayName: + $ref: "#/components/schemas/RegistryRecordDisplayName" + description: The human-readable display name of the registry record. + description: + $ref: "#/components/schemas/Description" + description: A description of the registry record. + recordType: + $ref: "#/components/schemas/RecordType" + description: The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM. + descriptors: + $ref: "#/components/schemas/Descriptors" + description: The typed descriptors that define the content of the registry record. + recordVersion: + $ref: "#/components/schemas/RegistryRecordVersion" + description: The version identifier of the registry record. + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The lifecycle status of the registry record. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the registry record was last updated. + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status. Typically populated when the status indicates a failure state. + required: + - registryArn + - recordArn + - recordId + - name + - recordType + - status + - createdAt + - updatedAt + UpdateRegistryRecordStatusRequestStatusReasonString: + type: string + minLength: 0 + maxLength: 255 + UpdateRegistryRecordStatusResponse: + description: Response structure for updating a registry record status + type: object + properties: + registryArn: + $ref: "#/components/schemas/RegistryArn" + description: The ARN of the registry + recordArn: + $ref: "#/components/schemas/RegistryRecordArn" + description: The ARN of the registry record + recordId: + $ref: "#/components/schemas/RegistryRecordId" + description: The ID of the registry record + status: + $ref: "#/components/schemas/RegistryRecordStatus" + description: The resulting status of the registry record + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the status change + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the record was last updated + required: + - registryArn + - recordArn + - recordId + - status + - statusReason + - updatedAt + x-stackQL-resources: + registries: + id: aws.agent_registry_control.registries + name: registries + title: registries + methods: + create_registry: + operation: + $ref: "#/paths/~1registries/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_registry: + operation: + $ref: "#/paths/~1registries~1{registry_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + get_registry: + operation: + $ref: "#/paths/~1registries~1{registry_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_registry: + operation: + $ref: "#/paths/~1registries~1{registry_id}/patch" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_registries: + operation: + $ref: "#/paths/~1registries-list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.registries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/registries/methods/get_registry" + - $ref: "#/components/x-stackQL-resources/registries/methods/list_registries" + insert: + - $ref: "#/components/x-stackQL-resources/registries/methods/create_registry" + update: + - $ref: "#/components/x-stackQL-resources/registries/methods/update_registry" + delete: + - $ref: "#/components/x-stackQL-resources/registries/methods/delete_registry" + registry_records: + id: aws.agent_registry_control.registry_records + name: registry_records + title: registry_records + methods: + create_registry_record: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_registry_record: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records~1{record_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_registry_record: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records~1{record_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_registry_record: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records~1{record_id}/patch" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_registry_records: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records-list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.registryRecords + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + submit_registry_record_for_approval: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records~1{record_id}~1submit-for-approval/post" + response: + openAPIDocKey: "202" + mediaType: application/json + update_registry_record_status: + operation: + $ref: "#/paths/~1registries~1{registry_id}~1records~1{record_id}~1status/patch" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/registry_records/methods/get_registry_record" + - $ref: "#/components/x-stackQL-resources/registry_records/methods/list_registry_records" + insert: + - $ref: "#/components/x-stackQL-resources/registry_records/methods/create_registry_record" + update: + - $ref: "#/components/x-stackQL-resources/registry_records/methods/update_registry_record_status" + - $ref: "#/components/x-stackQL-resources/registry_records/methods/update_registry_record" + delete: + - $ref: "#/components/x-stackQL-resources/registry_records/methods/delete_registry_record" + tags: + id: aws.agent_registry_control.tags + name: tags + title: tags + methods: + list_tags_for_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/post" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/amp.yaml b/providers/src/aws/v00.00.00000/services/amp.yaml index 6bfa4dc5..a6d95dc3 100644 --- a/providers/src/aws/v00.00.00000/services/amp.yaml +++ b/providers/src/aws/v00.00.00000/services/amp.yaml @@ -458,7 +458,7 @@ paths: /scrapers: post: operationId: CreateScraper - description: The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources and sends them to your Amazon Managed Service for Prometheus workspace. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more. An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide. The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper. When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics. For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide. + description: Creates a scraper to collect metrics from Prometheus-compatible sources. The scraper sends the collected metrics to Amazon Managed Service for Prometheus workspaces or CloudWatch datasets. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible. You can configure a scraper to control which metrics to collect, the frequency of collection, which transformations to apply to the metrics, and more. An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide. The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper. When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics. For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide. parameters: [] requestBody: required: true @@ -481,6 +481,8 @@ paths: $ref: "#/components/schemas/IdempotencyToken" tags: $ref: "#/components/schemas/TagMap" + exporters: + $ref: "#/components/schemas/ExporterList" required: - scrapeConfiguration - source @@ -896,6 +898,8 @@ paths: $ref: "#/components/schemas/RoleConfiguration" clientToken: $ref: "#/components/schemas/IdempotencyToken" + exporters: + $ref: "#/components/schemas/ExporterList" responses: "202": description: Success @@ -1048,6 +1052,10 @@ paths: $ref: "#/components/schemas/LimitsPerLabelSetList" retentionPeriodInDays: $ref: "#/components/schemas/UpdateWorkspaceConfigurationRequestRetentionPeriodInDaysInteger" + outOfOrderTimeWindowInSeconds: + $ref: "#/components/schemas/UpdateWorkspaceConfigurationRequestOutOfOrderTimeWindowInSecondsInteger" + ruleQueryOffsetInSeconds: + $ref: "#/components/schemas/UpdateWorkspaceConfigurationRequestRuleQueryOffsetInSecondsInteger" responses: "202": description: Success @@ -1638,6 +1646,9 @@ components: ampConfiguration: $ref: "#/components/schemas/AmpConfiguration" description: The Amazon Managed Service for Prometheus workspace to send metrics to. + cloudWatchConfiguration: + $ref: "#/components/schemas/CloudWatchConfiguration" + description: The CloudWatch dataset to send metrics to. AmpConfiguration: description: The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to. type: object @@ -1651,6 +1662,19 @@ components: description: An ARN identifying a Workspace. type: string pattern: arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+ + CloudWatchConfiguration: + description: The configuration identifies the CloudWatch dataset used as a scraper destination. + type: object + properties: + datasetArn: + $ref: "#/components/schemas/CloudWatchDatasetArn" + description: The Amazon Resource Name (ARN) of the CloudWatch dataset. To use the default dataset, specify arn:aws:cloudwatch:``:``:dataset/default. + required: + - datasetArn + CloudWatchDatasetArn: + description: An Amazon Resource Name (ARN) that identifies a dataset in CloudWatch. + type: string + pattern: arn:aws[-a-z]*:cloudwatch:[-a-z0-9]+:[0-9]{12}:dataset\/.+ RoleConfiguration: description: Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts. type: object @@ -1665,6 +1689,31 @@ components: description: An ARN identifying an IAM role used by the scraper. type: string pattern: arn:aws[-a-z]*:iam::[0-9]{12}:role/.+ + ExporterList: + description: A list of exporter configurations for a scraper. You can configure at most one Amazon OpenSearch Service domain. + type: array + items: + $ref: "#/components/schemas/ExporterConfiguration" + ExporterConfiguration: + description: Contains the configuration for an exporter managed by the scraper. + type: object + properties: + openSearchConfiguration: + $ref: "#/components/schemas/OpenSearchExporterConfiguration" + description: The configuration that the scraper uses to export metrics to an Amazon OpenSearch Service domain. + OpenSearchExporterConfiguration: + description: The configuration for exporting metrics to an Amazon OpenSearch Service domain. + type: object + properties: + domainArn: + $ref: "#/components/schemas/OpenSearchDomainArn" + description: The Amazon Resource Name (ARN) of the Amazon OpenSearch Service domain. + required: + - domainArn + OpenSearchDomainArn: + description: An Amazon Resource Name (ARN) that identifies an Amazon OpenSearch Service domain. + type: string + pattern: arn:aws[-a-z]*:es:[-a-z0-9]+:[0-9]{12}:domain\/.+ CreateScraperResponse: description: Represents the output of a CreateScraper operation. type: object @@ -2049,10 +2098,13 @@ components: description: The Amazon EKS cluster from which the scraper collects metrics. destination: $ref: "#/components/schemas/Destination" - description: The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. + description: The destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets. roleConfiguration: $ref: "#/components/schemas/RoleConfiguration" description: This structure displays information about the IAM roles used for cross-account scraping configuration. + exporters: + $ref: "#/components/schemas/ExporterList" + description: The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain. required: - scraperId - arn @@ -2218,6 +2270,12 @@ components: retentionPeriodInDays: $ref: "#/components/schemas/WorkspaceConfigurationDescriptionRetentionPeriodInDaysInteger" description: This field displays how many days that metrics are retained in the workspace. + outOfOrderTimeWindowInSeconds: + $ref: "#/components/schemas/WorkspaceConfigurationDescriptionOutOfOrderTimeWindowInSecondsInteger" + description: This field displays the out of order time window in seconds for accepting out of order samples. + ruleQueryOffsetInSeconds: + $ref: "#/components/schemas/WorkspaceConfigurationDescriptionRuleQueryOffsetInSecondsInteger" + description: This field displays the duration in seconds that rule evaluation queries are offset into the past. required: - status WorkspaceConfigurationStatus: @@ -2270,6 +2328,12 @@ components: WorkspaceConfigurationDescriptionRetentionPeriodInDaysInteger: type: integer minimum: 1 + WorkspaceConfigurationDescriptionOutOfOrderTimeWindowInSecondsInteger: + type: integer + minimum: 0 + WorkspaceConfigurationDescriptionRuleQueryOffsetInSecondsInteger: + type: integer + minimum: 0 GetDefaultScraperConfigurationResponse: description: Represents the output of a GetDefaultScraperConfiguration operation. type: object @@ -2448,10 +2512,13 @@ components: description: The Amazon EKS cluster from which the scraper collects metrics. destination: $ref: "#/components/schemas/Destination" - description: The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. + description: The destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets. roleConfiguration: $ref: "#/components/schemas/RoleConfiguration" description: This structure displays information about the IAM roles used for cross-account scraping configuration. + exporters: + $ref: "#/components/schemas/ExporterList" + description: The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain. required: - scraperId - arn @@ -2646,6 +2713,12 @@ components: UpdateWorkspaceConfigurationRequestRetentionPeriodInDaysInteger: type: integer minimum: 1 + UpdateWorkspaceConfigurationRequestOutOfOrderTimeWindowInSecondsInteger: + type: integer + minimum: 0 + UpdateWorkspaceConfigurationRequestRuleQueryOffsetInSecondsInteger: + type: integer + minimum: 0 UpdateWorkspaceConfigurationResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/amplify.yaml b/providers/src/aws/v00.00.00000/services/amplify.yaml index a94c3f28..6d4a894c 100644 --- a/providers/src/aws/v00.00.00000/services/amplify.yaml +++ b/providers/src/aws/v00.00.00000/services/amplify.yaml @@ -1286,7 +1286,7 @@ components: pattern: (?s).* OauthToken: type: string - maxLength: 1000 + maxLength: 4096 pattern: (?s).* AccessToken: type: string diff --git a/providers/src/aws/v00.00.00000/services/appconfig.yaml b/providers/src/aws/v00.00.00000/services/appconfig.yaml index 66647a86..f22485eb 100644 --- a/providers/src/aws/v00.00.00000/services/appconfig.yaml +++ b/providers/src/aws/v00.00.00000/services/appconfig.yaml @@ -74,7 +74,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. requestBody: required: true @@ -116,7 +116,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: max_results in: query @@ -213,7 +213,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. requestBody: required: true @@ -245,7 +245,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: max_results in: query @@ -266,6 +266,58 @@ paths: application/json: schema: $ref: "#/components/schemas/Environments" + /applications/{application_identifier}/experimentdefinitions: + post: + operationId: CreateExperimentDefinition + description: Creates an experiment definition in AppConfig. An experiment definition describes the purpose, scope, and operational configuration of an experiment, including the target audience, feature flag, and treatment configurations. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/NameWithReservedAwsPrefix" + ConfigurationProfileIdentifier: + $ref: "#/components/schemas/Identifier" + EnvironmentIdentifier: + $ref: "#/components/schemas/Identifier" + FlagKey: + $ref: "#/components/schemas/FlagKey" + Treatments: + $ref: "#/components/schemas/TreatmentInputList" + Control: + $ref: "#/components/schemas/TreatmentInput" + AudienceRule: + $ref: "#/components/schemas/Rule" + Hypothesis: + $ref: "#/components/schemas/Description" + AudienceDescription: + $ref: "#/components/schemas/Description" + LaunchCriteria: + $ref: "#/components/schemas/Description" + Tags: + $ref: "#/components/schemas/TagMap" + required: + - ConfigurationProfileIdentifier + - EnvironmentIdentifier + - FlagKey + - AudienceRule + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentDefinition" /extensions: post: operationId: CreateExtension @@ -412,20 +464,20 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The configuration profile ID. - name: Description in: header required: false schema: $ref: "#/components/schemas/Description" - description: A description of the configuration. + description: A description of the configuration. Due to HTTP limitations, this field only supports ASCII characters. - name: Content-Type in: header required: true @@ -468,13 +520,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The configuration profile ID. - name: max_results in: query @@ -510,7 +562,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the application to delete. responses: "204": @@ -523,7 +575,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the application you want to get. responses: "200": @@ -540,7 +592,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. requestBody: required: false @@ -569,13 +621,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID that includes the configuration profile you want to delete. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The ID of the configuration profile you want to delete. - name: x-amzn-deletion-protection-check in: header @@ -594,13 +646,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the application that includes the configuration profile you want to get. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The ID of the configuration profile that you want to get. responses: "200": @@ -617,13 +669,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The ID of the configuration profile. requestBody: required: false @@ -672,13 +724,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the environment that you want to delete. - name: application_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID that includes the environment that you want to delete. - name: x-amzn-deletion-protection-check in: header @@ -697,13 +749,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the application that includes the environment you want to get. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the environment that you want to get. responses: "200": @@ -720,13 +772,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The environment ID. requestBody: required: false @@ -748,6 +800,97 @@ paths: application/json: schema: $ref: "#/components/schemas/Environment" + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}: + delete: + operationId: DeleteExperimentDefinition + description: Deletes an experiment definition. You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: delete_type + in: query + required: false + schema: + $ref: "#/components/schemas/DeleteType" + description: The type of deletion to perform. Valid values include archive (hide but preserve) and permanent (delete permanently). + responses: + "204": + description: Success + get: + operationId: GetExperimentDefinition + description: Retrieves information about an experiment definition. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentDefinition" + patch: + operationId: UpdateExperimentDefinition + description: Updates an experiment definition. You can update treatments, the control, audience rules, and other properties. You cannot update an experiment definition while an experiment run is active. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Treatments: + $ref: "#/components/schemas/TreatmentInputList" + Control: + $ref: "#/components/schemas/TreatmentInput" + Hypothesis: + $ref: "#/components/schemas/Description" + AudienceRule: + $ref: "#/components/schemas/Rule" + AudienceDescription: + $ref: "#/components/schemas/Description" + LaunchCriteria: + $ref: "#/components/schemas/Description" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentDefinition" /extensions/{extension_identifier}: delete: operationId: DeleteExtension @@ -889,13 +1032,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The configuration profile ID. - name: version_number in: path @@ -914,13 +1057,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The configuration profile ID. - name: version_number in: path @@ -960,6 +1103,8 @@ paths: properties: DeletionProtection: $ref: "#/components/schemas/DeletionProtectionSettings" + VendedMetrics: + $ref: "#/components/schemas/VendedMetricsSettings" responses: "200": description: Success @@ -1018,13 +1163,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the application that includes the deployment you want to get. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The ID of the environment that includes the deployment you want to get. - name: deployment_number in: path @@ -1047,13 +1192,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The environment ID. - name: deployment_number in: path @@ -1126,6 +1271,36 @@ paths: application/json: schema: $ref: "#/components/schemas/DeploymentStrategy" + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}/experimentruns/{run}: + get: + operationId: GetExperimentRun + description: Retrieves information about an experiment run, including its status, start time, and exposure settings. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: run + in: path + required: true + schema: + $ref: "#/components/schemas/PositiveInteger" + description: The run number to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRun" /applications/{application_id}/environments/{environment_id}/deployments: get: operationId: ListDeployments @@ -1135,13 +1310,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The environment ID. - name: max_results in: query @@ -1164,19 +1339,19 @@ paths: $ref: "#/components/schemas/Deployments" post: operationId: StartDeployment - description: Starts a deployment. + description: Starts a deployment. AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see Using AppConfig Agent for user-based or entity-based gradual deployments parameters: - name: application_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: environment_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The environment ID. requestBody: required: true @@ -1188,7 +1363,7 @@ paths: DeploymentStrategyId: $ref: "#/components/schemas/DeploymentStrategyId" ConfigurationProfileId: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" ConfigurationVersion: $ref: "#/components/schemas/Version" Description: @@ -1199,6 +1374,8 @@ paths: $ref: "#/components/schemas/KmsKeyIdentifier" DynamicExtensionParameters: $ref: "#/components/schemas/DynamicParameterMap" + LatestDeploymentNumber: + $ref: "#/components/schemas/Integer" required: - DeploymentStrategyId - ConfigurationProfileId @@ -1210,6 +1387,178 @@ paths: application/json: schema: $ref: "#/components/schemas/Deployment" + /experimentdefinitions: + get: + operationId: ListExperimentDefinitions + description: Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status. + parameters: + - name: application_identifier + in: query + required: false + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name to filter results. + - name: configuration_profile_identifier + in: query + required: false + schema: + $ref: "#/components/schemas/Identifier" + description: The configuration profile ID or name to filter results. + - name: environment_identifier + in: query + required: false + schema: + $ref: "#/components/schemas/Identifier" + description: The environment ID or name to filter results. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/ExperimentDefinitionStatus" + description: A filter for the experiment definition status. + - name: max_results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of items to return for this call. + - name: next_token + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: A token to start the list from a previously truncated response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentDefinitions" + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}/experimentruns/{run}/events: + get: + operationId: ListExperimentRunEvents + description: Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: run + in: path + required: true + schema: + $ref: "#/components/schemas/PositiveInteger" + description: The run number. + - name: max_results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of items to return. + - name: next_token + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: A token to start the list from a previously truncated response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRunEvents" + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}/experimentruns: + get: + operationId: ListExperimentRuns + description: Lists the experiment runs for a specified experiment definition. You can filter by status. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: max_results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of items to return. + - name: next_token + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: A token to start the list from a previously truncated response. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/ExperimentRunStatus" + description: A filter for the experiment run status. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRuns" + post: + operationId: StartExperimentRun + description: Starts an experiment run for the specified experiment definition. An experiment run delivers treatments to the target audience and collects metrics. You can start multiple experiment runs from the same experiment definition. Billing for this experiment begins when you call this operation and continues until the experiment is stopped. For pricing details, see AppConfig pricing. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Description: + $ref: "#/components/schemas/Description" + ExposurePercentage: + $ref: "#/components/schemas/NullablePercentage" + TreatmentOverrides: + $ref: "#/components/schemas/TreatmentOverrides" + Tags: + $ref: "#/components/schemas/TagMap" + DeploymentParameters: + $ref: "#/components/schemas/DeploymentParameters" + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRun" /tags/{resource_arn}: get: operationId: ListTagsForResource @@ -1269,6 +1618,92 @@ paths: responses: "204": description: Success + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}/experimentruns/{run}/stop: + patch: + operationId: StopExperimentRun + description: Stops a running experiment. Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: run + in: path + required: true + schema: + $ref: "#/components/schemas/PositiveInteger" + description: The run number to stop. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Result: + $ref: "#/components/schemas/ExperimentRunResult" + DeploymentParameters: + $ref: "#/components/schemas/DeploymentParameters" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRun" + /applications/{application_identifier}/experimentdefinitions/{experiment_definition_identifier}/experimentruns/{run}/update: + patch: + operationId: UpdateExperimentRun + description: Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased. + parameters: + - name: application_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The application ID or name. + - name: experiment_definition_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: The experiment definition ID or name. + - name: run + in: path + required: true + schema: + $ref: "#/components/schemas/PositiveInteger" + description: The run number to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Description: + $ref: "#/components/schemas/Description" + ExposurePercentage: + $ref: "#/components/schemas/NullablePercentage" + TreatmentOverrides: + $ref: "#/components/schemas/TreatmentOverrides" + DeploymentParameters: + $ref: "#/components/schemas/DeploymentParameters" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExperimentRun" /applications/{application_id}/configurationprofiles/{configuration_profile_id}/validators: post: operationId: ValidateConfiguration @@ -1278,13 +1713,13 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/Name" description: The application ID. - name: configuration_profile_id in: path required: true schema: - $ref: "#/components/schemas/Id" + $ref: "#/components/schemas/LongName" description: The configuration profile ID. - name: configuration_version in: query @@ -1407,7 +1842,7 @@ components: maxLength: 32768 ConfigurationProfileType: type: string - pattern: ^[a-zA-Z\.]+ + pattern: ^[a-zA-Z0-9\.\-]+ KmsKeyIdentifier: type: string minLength: 1 @@ -1550,6 +1985,146 @@ components: - ROLLING_BACK - ROLLED_BACK - REVERTED + Identifier: + type: string + minLength: 1 + maxLength: 2048 + NameWithReservedAwsPrefix: + type: string + pattern: ^(?!AWS\.).{1,64}$ + FlagKey: + type: string + pattern: ^[a-z][a-zA-Z0-9_-]{1,64} + TreatmentInputList: + type: array + items: + $ref: "#/components/schemas/TreatmentInput" + TreatmentInput: + description: Input structure for defining a treatment when creating or updating an experiment definition. + type: object + properties: + Weight: + $ref: "#/components/schemas/Weight" + description: The traffic allocation weight for this treatment. + Description: + $ref: "#/components/schemas/Description" + description: A description of the treatment. + FlagValue: + $ref: "#/components/schemas/FlagValue" + description: The feature flag value to serve to users assigned to this treatment. + required: + - Weight + - FlagValue + Weight: + type: number + format: float + minimum: 0 + FlagValue: + description: The feature flag value configuration for a treatment, including the enabled state and attribute values. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the feature flag is enabled for this treatment. + AttributeValues: + type: object + properties: {} + description: The attribute values associated with this flag value. + required: + - Enabled + Boolean: + type: boolean + Rule: + type: string + minLength: 1 + maxLength: 16384 + ExperimentDefinition: + description: Describes an experiment definition, including the target audience, feature flag, treatments, and current status. + type: object + properties: + ApplicationId: + $ref: "#/components/schemas/Id" + description: The application ID. + Id: + $ref: "#/components/schemas/Id" + description: The experiment definition ID. + Name: + $ref: "#/components/schemas/Name" + description: The name of the experiment definition. + Hypothesis: + $ref: "#/components/schemas/Description" + description: The hypothesis that the experiment is designed to validate. + Status: + $ref: "#/components/schemas/ExperimentDefinitionStatus" + description: "The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED." + ConfigurationProfileId: + $ref: "#/components/schemas/Id" + description: The configuration profile ID associated with the experiment. + EnvironmentId: + $ref: "#/components/schemas/Id" + description: The environment ID where the experiment runs. + FlagKey: + $ref: "#/components/schemas/FlagKey" + description: The key of the feature flag used by the experiment. + AudienceRule: + $ref: "#/components/schemas/Rule" + description: The rule that defines which users are eligible to be assigned to treatments. + AudienceDescription: + $ref: "#/components/schemas/Description" + description: A description of the intended audience for the experiment. + LaunchCriteria: + $ref: "#/components/schemas/Description" + description: The conditions under which the winning treatment should be launched. + Treatments: + $ref: "#/components/schemas/TreatmentList" + description: The list of treatments defined for the experiment. + Control: + $ref: "#/components/schemas/Treatment" + description: The control treatment used as the baseline for comparison. + CreatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment definition was created, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment definition was last updated, in ISO 8601 format. + KmsKeyIdentifier: + $ref: "#/components/schemas/KmsKeyIdentifier" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data. + ExperimentDefinitionStatus: + type: string + enum: + - ACTIVE + - IDLE + - ARCHIVED + TreatmentList: + type: array + items: + $ref: "#/components/schemas/Treatment" + Treatment: + description: Describes a treatment in an experiment, including its traffic allocation weight and feature flag value. + type: object + properties: + Key: + $ref: "#/components/schemas/TreatmentKey" + description: The unique key that identifies this treatment. + Weight: + $ref: "#/components/schemas/Weight" + description: The traffic allocation weight for this treatment. + Description: + $ref: "#/components/schemas/Description" + description: A description of the treatment. + FlagValue: + $ref: "#/components/schemas/FlagValue" + description: The feature flag value served to users assigned to this treatment. + required: + - Weight + - FlagValue + TreatmentKey: + type: string + pattern: ^[a-zA-Z0-9]{1,8} + Iso8601DateTime: + type: string + format: date-time Integer: type: integer ExtensionOrParameterName: @@ -1587,10 +2162,6 @@ components: type: object properties: {} description: The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object. - Identifier: - type: string - minLength: 1 - maxLength: 2048 ParameterValueMap: type: object properties: {} @@ -1664,12 +2235,20 @@ components: DeploymentStrategyId: type: string pattern: (^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$) + DeleteType: + type: string + enum: + - ARCHIVE + - DESTROY AccountSettings: type: object properties: DeletionProtection: $ref: "#/components/schemas/DeletionProtectionSettings" description: A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60. + VendedMetrics: + $ref: "#/components/schemas/VendedMetricsSettings" + description: The configuration for vended metrics in the account. DeletionProtectionSettings: description: A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval specified by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour. type: object @@ -1680,12 +2259,17 @@ components: ProtectionPeriodInMinutes: $ref: "#/components/schemas/DeletionProtectionDuration" description: The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or . - Boolean: - type: boolean DeletionProtectionDuration: type: integer minimum: 15 maximum: 1440 + VendedMetricsSettings: + description: The configuration settings for vended metrics in your AppConfig account. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether vended metrics are enabled for the account. StringWithLengthBetween1And64: type: string minLength: 1 @@ -1856,9 +2440,6 @@ components: InvocationId: $ref: "#/components/schemas/Id" description: A system-generated ID for this invocation. - Iso8601DateTime: - type: string - format: date-time AppliedExtensions: type: array items: @@ -1880,6 +2461,120 @@ components: type: object properties: {} description: One or more parameters for the actions called by the extension. + PositiveInteger: + type: integer + minimum: 1 + ExperimentRun: + description: Describes an experiment run, including its status, exposure settings, and treatment overrides. + type: object + properties: + ApplicationId: + $ref: "#/components/schemas/Id" + description: The application ID. + ExperimentDefinitionId: + $ref: "#/components/schemas/Id" + description: The experiment definition ID. + Run: + $ref: "#/components/schemas/Integer" + description: The experiment run number. + Description: + $ref: "#/components/schemas/Description" + description: A description of the experiment run. + Status: + $ref: "#/components/schemas/ExperimentRunStatus" + description: "The current status of the experiment run. Valid values: RUNNING, DONE." + ExposurePercentage: + $ref: "#/components/schemas/NullablePercentage" + description: The percentage of the target audience exposed to treatments. + TreatmentOverrides: + $ref: "#/components/schemas/TreatmentOverrides" + description: Treatment assignment overrides that assign specific entity IDs to treatments. + Result: + $ref: "#/components/schemas/ExperimentRunResult" + description: The result of the experiment run, including the executive summary and launch decision rationale. + StartedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run started, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run was last updated, in ISO 8601 format. + EndedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run ended, in ISO 8601 format. + ExperimentDefinitionSnapshot: + $ref: "#/components/schemas/ExperimentDefinitionSnapshot" + description: A snapshot of the experiment definition at the time the run was started. + ExperimentRunStatus: + type: string + enum: + - RUNNING + - DONE + NullablePercentage: + type: number + format: float + minimum: 0 + maximum: 100 + TreatmentOverrides: + description: Treatment assignment overrides that assign specific entity IDs to treatments, bypassing random assignment. + type: object + properties: + Inline: + type: object + properties: {} + description: A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment. + ExperimentRunResult: + description: The result of an experiment run, including the executive summary and launch decision rationale. + type: object + properties: + ExecutiveSummary: + $ref: "#/components/schemas/Description" + description: A summary of the experiment outcome and key findings. + ReasonsToLaunch: + $ref: "#/components/schemas/Description" + description: Evidence in favor of launching the winning treatment. + ReasonsNotToLaunch: + $ref: "#/components/schemas/Description" + description: Evidence against launching the treatment. + ExperimentDefinitionSnapshot: + description: A snapshot of the experiment definition captured at the time an experiment run was started. This preserves the configuration that was active during the run. + type: object + properties: + ApplicationId: + $ref: "#/components/schemas/Id" + description: The application ID at the time the run was started. + Id: + $ref: "#/components/schemas/Id" + description: The experiment definition ID. + Name: + $ref: "#/components/schemas/Name" + description: The name of the experiment definition at the time the run was started. + Hypothesis: + $ref: "#/components/schemas/Description" + description: The hypothesis at the time the run was started. + ConfigurationProfileId: + $ref: "#/components/schemas/Id" + description: The configuration profile ID at the time the run was started. + EnvironmentId: + $ref: "#/components/schemas/Id" + description: The environment ID at the time the run was started. + FlagKey: + $ref: "#/components/schemas/FlagKey" + description: The feature flag key at the time the run was started. + AudienceRule: + $ref: "#/components/schemas/Rule" + description: The audience rule at the time the run was started. + AudienceDescription: + $ref: "#/components/schemas/Description" + description: The audience description at the time the run was started. + LaunchCriteria: + $ref: "#/components/schemas/Description" + description: The launch criteria at the time the run was started. + Treatments: + $ref: "#/components/schemas/TreatmentList" + description: The treatments at the time the run was started. + Control: + $ref: "#/components/schemas/Treatment" + description: The control treatment at the time the run was started. MaxResults: type: integer minimum: 1 @@ -1973,6 +2668,9 @@ components: DeploymentNumber: $ref: "#/components/schemas/Integer" description: The sequence number of the deployment. + ConfigurationProfileId: + $ref: "#/components/schemas/Id" + description: The ID of the configuration profile that was deployed. ConfigurationName: $ref: "#/components/schemas/Name" description: The name of the configuration. @@ -2006,6 +2704,14 @@ components: VersionLabel: $ref: "#/components/schemas/VersionLabel" description: A user-defined label for an AppConfig hosted configuration version. + Type: + $ref: "#/components/schemas/DeploymentType" + description: The type of deployment. + DeploymentType: + type: string + enum: + - USER + - MANAGED Environments: type: object properties: @@ -2019,6 +2725,139 @@ components: type: array items: $ref: "#/components/schemas/Environment" + ExperimentDefinitions: + description: The response for a list experiment definitions request. + type: object + properties: + Items: + $ref: "#/components/schemas/ExperimentDefinitionList" + description: The list of experiment definitions. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for the next set of results. + ExperimentDefinitionList: + type: array + items: + $ref: "#/components/schemas/ExperimentDefinitionSummary" + ExperimentDefinitionSummary: + description: Summary information about an experiment definition. + type: object + properties: + ApplicationId: + $ref: "#/components/schemas/Id" + description: The application ID. + Id: + $ref: "#/components/schemas/Id" + description: The experiment definition ID. + Name: + $ref: "#/components/schemas/Name" + description: The name of the experiment definition. + Hypothesis: + $ref: "#/components/schemas/Description" + description: The hypothesis that the experiment is designed to validate. + Status: + $ref: "#/components/schemas/ExperimentDefinitionStatus" + description: The current status of the experiment definition. + ConfigurationProfileId: + $ref: "#/components/schemas/Id" + description: The configuration profile ID associated with the experiment. + EnvironmentId: + $ref: "#/components/schemas/Id" + description: The environment ID where the experiment runs. + FlagKey: + $ref: "#/components/schemas/FlagKey" + description: The key of the feature flag used by the experiment. + CreatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment definition was created, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment definition was last updated, in ISO 8601 format. + ExperimentRunEvents: + description: The response for a list experiment run events request. + type: object + properties: + Items: + $ref: "#/components/schemas/ExperimentRunEventList" + description: The list of experiment run events. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for the next set of results. + ExperimentRunEventList: + type: array + items: + $ref: "#/components/schemas/ExperimentRunEvent" + ExperimentRunEvent: + description: Describes an event that occurred during an experiment run. + type: object + properties: + Description: + $ref: "#/components/schemas/Description" + description: A description of the event. + AssociatedDeployment: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the deployment associated with this event. + EventType: + $ref: "#/components/schemas/ExperimentRunEventType" + description: "The type of event. Valid values: RUN_STARTED, EXPOSURE_UPDATED, OVERRIDES_UPDATED, RUN_STOPPED." + OccurredAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the event occurred, in ISO 8601 format. + TriggeredBy: + $ref: "#/components/schemas/TriggeredBy" + description: The principal that triggered the event. + ExposurePercentage: + $ref: "#/components/schemas/NullablePercentage" + description: The exposure percentage at the time of the event. + TreatmentOverrides: + $ref: "#/components/schemas/TreatmentOverrides" + description: The treatment overrides at the time of the event. + ExperimentRunEventType: + type: string + enum: + - RUN_STARTED + - EXPOSURE_UPDATED + - OVERRIDES_UPDATED + - RUN_STOPPED + ExperimentRuns: + description: The response for a list experiment runs request. + type: object + properties: + Items: + $ref: "#/components/schemas/ExperimentRunSummaryList" + description: The list of experiment runs. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for the next set of results. + ExperimentRunSummaryList: + type: array + items: + $ref: "#/components/schemas/ExperimentRunSummary" + ExperimentRunSummary: + description: Summary information about an experiment run. + type: object + properties: + ExperimentDefinitionId: + $ref: "#/components/schemas/Id" + description: The experiment definition ID. + Run: + $ref: "#/components/schemas/Integer" + description: The experiment run number. + Description: + $ref: "#/components/schemas/Description" + description: A description of the experiment run. + Status: + $ref: "#/components/schemas/ExperimentRunStatus" + description: The current status of the experiment run. + StartedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run started, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run was last updated, in ISO 8601 format. + EndedAt: + $ref: "#/components/schemas/Iso8601DateTime" + description: The date and time the experiment run ended, in ISO 8601 format. ExtensionAssociations: type: object properties: @@ -2129,6 +2968,18 @@ components: DynamicParameterMap: type: object properties: {} + DeploymentParameters: + description: The deployment parameters for an experiment run, including dynamic extension parameters and tags. + type: object + properties: + DynamicExtensionParameters: + type: object + properties: {} + description: A map of extension parameters for the deployment. + Tags: + type: object + properties: {} + description: The tags to assign to the deployment. TagKeyList: type: array items: @@ -2424,6 +3275,95 @@ components: - $ref: "#/components/x-stackQL-resources/environments/methods/update_environment" delete: - $ref: "#/components/x-stackQL-resources/environments/methods/delete_environment" + experiment_definitions: + id: aws.appconfig.experiment_definitions + name: experiment_definitions + title: experiment_definitions + methods: + create_experiment_definition: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_experiment_definition: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}/delete" + response: + openAPIDocKey: "204" + request: + nativeCasing: pascal + get_experiment_definition: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_experiment_definition: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_experiment_definitions: + operation: + $ref: "#/paths/~1experimentdefinitions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next_token + location: query + responseToken: + key: $.NextToken + location: body + start_experiment_run: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + stop_experiment_run: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns~1{run}~1stop/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/experiment_definitions/methods/get_experiment_definition" + - $ref: "#/components/x-stackQL-resources/experiment_definitions/methods/list_experiment_definitions" + insert: + - $ref: "#/components/x-stackQL-resources/experiment_definitions/methods/create_experiment_definition" + update: + - $ref: "#/components/x-stackQL-resources/experiment_definitions/methods/update_experiment_definition" + delete: + - $ref: "#/components/x-stackQL-resources/experiment_definitions/methods/delete_experiment_definition" extensions: id: aws.appconfig.extensions name: extensions @@ -2695,6 +3635,81 @@ components: insert: [] update: [] delete: [] + experiment_runs: + id: aws.appconfig.experiment_runs + name: experiment_runs + title: experiment_runs + methods: + get_experiment_run: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns~1{run}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_experiment_runs: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next_token + location: query + responseToken: + key: $.NextToken + location: body + update_experiment_run: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns~1{run}~1update/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/experiment_runs/methods/get_experiment_run" + - $ref: "#/components/x-stackQL-resources/experiment_runs/methods/list_experiment_runs" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/experiment_runs/methods/update_experiment_run" + delete: [] + experiment_run_events: + id: aws.appconfig.experiment_run_events + name: experiment_run_events + title: experiment_run_events + methods: + list_experiment_run_events: + operation: + $ref: "#/paths/~1applications~1{application_identifier}~1experimentdefinitions~1{experiment_definition_identifier}~1experimentruns~1{run}~1events/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next_token + location: query + responseToken: + key: $.NextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/experiment_run_events/methods/list_experiment_run_events" + insert: [] + update: [] + delete: [] tags: id: aws.appconfig.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/appflow.yaml b/providers/src/aws/v00.00.00000/services/appflow.yaml index 3dc88a4c..8c994f4e 100644 --- a/providers/src/aws/v00.00.00000/services/appflow.yaml +++ b/providers/src/aws/v00.00.00000/services/appflow.yaml @@ -2271,7 +2271,7 @@ components: description: The properties required to query Amazon Honeycode. CustomerProfiles: $ref: "#/components/schemas/CustomerProfilesDestinationProperties" - description: The properties required to query Amazon Connect Customer Profiles. + description: The properties required to query Connect Customer Customer Profiles. Zendesk: $ref: "#/components/schemas/ZendeskDestinationProperties" description: The properties required to query Zendesk. @@ -2524,15 +2524,15 @@ components: required: - object CustomerProfilesDestinationProperties: - description: The properties that are applied when Amazon Connect Customer Profiles is used as a destination. + description: The properties that are applied when Connect Customer Customer Profiles is used as a destination. type: object properties: domainName: $ref: "#/components/schemas/DomainName" - description: The unique name of the Amazon Connect Customer Profiles domain. + description: The unique name of the Connect Customer Customer Profiles domain. objectTypeName: $ref: "#/components/schemas/ObjectTypeName" - description: The object specified in the Amazon Connect Customer Profiles flow destination. + description: The object specified in the Connect Customer Customer Profiles flow destination. required: - domainName DomainName: @@ -3277,7 +3277,7 @@ components: description: The connector metadata specific to Upsolver. CustomerProfiles: $ref: "#/components/schemas/CustomerProfilesMetadata" - description: The connector metadata specific to Amazon Connect Customer Profiles. + description: The connector metadata specific to Connect Customer Customer Profiles. Honeycode: $ref: "#/components/schemas/HoneycodeMetadata" description: The connector metadata specific to Amazon Honeycode. @@ -3379,7 +3379,7 @@ components: description: The connector metadata specific to Upsolver. type: object CustomerProfilesMetadata: - description: The connector metadata specific to Amazon Connect Customer Profiles. + description: The connector metadata specific to Connect Customer Customer Profiles. type: object HoneycodeMetadata: description: The connector metadata specific to Amazon Honeycode. diff --git a/providers/src/aws/v00.00.00000/services/application_autoscaling.yaml b/providers/src/aws/v00.00.00000/services/application_autoscaling.yaml index 0b5b7565..daf0095e 100644 --- a/providers/src/aws/v00.00.00000/services/application_autoscaling.yaml +++ b/providers/src/aws/v00.00.00000/services/application_autoscaling.yaml @@ -1111,7 +1111,7 @@ components: properties: PredefinedMetricType: $ref: "#/components/schemas/MetricType" - description: The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. + description: "The metric type. The following are notes about specific metric types: ALBRequestCountPerTarget - This metric type applies only to Spot Fleets and ECS services. ECSServiceAverageCPUUtilizationHighResolution - The high-resolution version of ECSServiceAverageCPUUtilization that uses 20-second CloudWatch metrics. Use this metric for target tracking scaling policies that evaluate metrics every 20 seconds. You must enable high-resolution metrics in Amazon ECS before creating a scaling policy with this metric type. ECSServiceAverageMemoryUtilizationHighResolution - The high-resolution version of ECSServiceAverageMemoryUtilization that uses 20-second CloudWatch metrics. Use this metric for target tracking scaling policies that evaluate metrics every 20 seconds. You must enable high-resolution metrics in Amazon ECS before creating a scaling policy with this metric type." ResourceLabel: $ref: "#/components/schemas/ResourceLabel" description: "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where: app/``/`` is the final portion of the load balancer ARN targetgroup/``/`` is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation." @@ -1149,6 +1149,8 @@ components: - WorkSpacesAverageUserSessionsCapacityUtilization - SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution - SageMakerVariantConcurrentRequestsPerModelHighResolution + - ECSServiceAverageCPUUtilizationHighResolution + - ECSServiceAverageMemoryUtilizationHighResolution ResourceLabel: type: string minLength: 1 diff --git a/providers/src/aws/v00.00.00000/services/application_signals.yaml b/providers/src/aws/v00.00.00000/services/application_signals.yaml index a2329729..7f781e13 100644 --- a/providers/src/aws/v00.00.00000/services/application_signals.yaml +++ b/providers/src/aws/v00.00.00000/services/application_signals.yaml @@ -16,6 +16,29 @@ servers: description: AWS region description: Regional endpoint for application-signals paths: + /batch-delete-instrumentation-configurations: + post: + operationId: BatchDeleteInstrumentationConfigurations + description: "Deletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods: By scope: Delete all configurations matching a Service + Environment + InstrumentationType By ARN list: Delete specific configurations by providing a list of resource ARNs" + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + DeletionTarget: + $ref: "#/components/schemas/BatchDeleteDeletionTarget" + required: + - DeletionTarget + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteInstrumentationConfigurationsResponse" /budget-report: post: operationId: BatchGetServiceLevelObjectiveBudgetReport @@ -68,6 +91,49 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchUpdateExclusionWindowsOutput" + /create-instrumentation-configuration: + post: + operationId: CreateInstrumentationConfiguration + description: Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after creation. For BREAKPOINT type configurations, they expire after 24 hours unless a shorter expiration is provided. For PROBE type configurations, they persist until explicitly deleted; an expiration cannot be set for PROBE configurations. If a configuration already exists for the same service, environment, signal type, and location, this operation returns a conflict instead of overwriting it. Use attribute filters and capture settings to control where the instrumentation runs and which data is collected. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + Service: + $ref: "#/components/schemas/CreateInstrumentationConfigurationRequestServiceString" + Environment: + $ref: "#/components/schemas/CreateInstrumentationConfigurationRequestEnvironmentString" + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + Location: + $ref: "#/components/schemas/Location" + Description: + $ref: "#/components/schemas/CreateInstrumentationConfigurationRequestDescriptionString" + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + AttributeFilters: + $ref: "#/components/schemas/DynamicInstrumentationAttributeFilters" + CaptureConfiguration: + $ref: "#/components/schemas/CaptureConfiguration" + Tags: + $ref: "#/components/schemas/TagList" + required: + - InstrumentationType + - SignalType + - CaptureConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateInstrumentationConfigurationResponse" /slo: post: operationId: CreateServiceLevelObjective @@ -139,6 +205,39 @@ paths: application/json: schema: $ref: "#/components/schemas/PutGroupingConfigurationOutput" + /delete-instrumentation-configuration: + post: + operationId: DeleteInstrumentationConfiguration + description: Deletes the specified instrumentation configuration. SDKs remove the instrumentation during their next sync after the configuration is deleted or expires. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + Service: + $ref: "#/components/schemas/DeleteInstrumentationConfigurationRequestServiceString" + Environment: + $ref: "#/components/schemas/DeleteInstrumentationConfigurationRequestEnvironmentString" + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + LocationIdentifier: + $ref: "#/components/schemas/LocationIdentifier" + required: + - InstrumentationType + - SignalType + - LocationIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteInstrumentationConfigurationResponse" /slo/{id}: delete: operationId: DeleteServiceLevelObjective @@ -210,6 +309,82 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateServiceLevelObjectiveOutput" + /get-instrumentation-configuration: + post: + operationId: GetInstrumentationConfiguration + description: Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + Service: + $ref: "#/components/schemas/GetInstrumentationConfigurationRequestServiceString" + Environment: + $ref: "#/components/schemas/GetInstrumentationConfigurationRequestEnvironmentString" + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + LocationIdentifier: + $ref: "#/components/schemas/LocationIdentifier" + required: + - InstrumentationType + - SignalType + - LocationIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetInstrumentationConfigurationResponse" + /get-instrumentation-configuration-status: + post: + operationId: GetInstrumentationConfigurationStatus + description: Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED. If no status or time window is provided, the operation defaults to ACTIVE events from the last hour. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + Service: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusRequestServiceString" + Environment: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusRequestEnvironmentString" + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + LocationIdentifier: + $ref: "#/components/schemas/LocationIdentifier" + Status: + $ref: "#/components/schemas/InstrumentationConfigurationStatus" + StartTime: + $ref: "#/components/schemas/Timestamp" + EndTime: + $ref: "#/components/schemas/Timestamp" + MaxResults: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusRequestMaxResultsInteger" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - InstrumentationType + - SignalType + - LocationIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusResponse" /service: post: operationId: GetService @@ -358,6 +533,39 @@ paths: application/json: schema: $ref: "#/components/schemas/ListGroupingAttributeDefinitionsOutput" + /list-instrumentation-configurations: + post: + operationId: ListInstrumentationConfigurations + description: Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally. Include the previous SyncedAt value to perform incremental syncs. When no changes are detected, the response sets Changed to false and omits configuration details. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Service: + $ref: "#/components/schemas/ListInstrumentationConfigurationsRequestServiceString" + Environment: + $ref: "#/components/schemas/ListInstrumentationConfigurationsRequestEnvironmentString" + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + SyncedAt: + $ref: "#/components/schemas/Timestamp" + MaxResults: + $ref: "#/components/schemas/ListInstrumentationConfigurationsRequestMaxResultsInteger" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - InstrumentationType + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/InstrumentationConfigurationsPage" /service-dependencies: post: operationId: ListServiceDependencies @@ -688,6 +896,33 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" + /report-instrumentation-configuration-status: + post: + operationId: ReportInstrumentationConfigurationStatus + description: Reports the status of one or more instrumentation configurations from SDK instances. Use this to record when configurations become ready, hit errors, become active, or are disabled by limits. Report READY, ERROR, and DISABLED when the status changes. Report ACTIVE periodically (for example, every minute) while instrumentation is running. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Service: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusRequestServiceString" + Environment: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusRequestEnvironmentString" + Configurations: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusRequestConfigurationsList" + required: + - Configurations + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusResponse" /start-discovery: post: operationId: StartDiscovery @@ -796,6 +1031,138 @@ components: schema: type: string schemas: + BatchDeleteDeletionTarget: + description: Union type for batch delete target selection. Exactly one of the two modes must be specified. + type: object + properties: + Scope: + $ref: "#/components/schemas/BatchDeleteScope" + description: Delete all configurations matching the specified scope. + ResourceArns: + $ref: "#/components/schemas/BatchDeleteByResourceArns" + description: Delete specific configurations by ARN list. + BatchDeleteScope: + description: Scope parameters for bulk delete by scope. + type: object + properties: + Service: + $ref: "#/components/schemas/BatchDeleteScopeServiceString" + description: Service name for the instrumentation configurations. + Environment: + $ref: "#/components/schemas/BatchDeleteScopeEnvironmentString" + description: Environment identifier for the instrumentation configurations. + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: "Instrumentation type: BREAKPOINT or PROBE." + required: + - Service + - Environment + - InstrumentationType + BatchDeleteScopeServiceString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + BatchDeleteScopeEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + InstrumentationType: + description: Type of instrumentation configuration + type: string + enum: + - BREAKPOINT + - PROBE + BatchDeleteByResourceArns: + description: Parameters for targeted delete by ARN list. + type: object + properties: + ResourceArns: + $ref: "#/components/schemas/BatchDeleteByResourceArnsResourceArnsList" + description: List of resource ARNs to delete. + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: "Instrumentation type: BREAKPOINT or PROBE." + required: + - ResourceArns + - InstrumentationType + BatchDeleteByResourceArnsResourceArnsList: + description: List of resource ARNs for batch delete by ARN list. Maximum 50 ARNs per request. + type: array + items: + $ref: "#/components/schemas/BatchDeleteByResourceArnsResourceArnsListMemberString" + BatchDeleteByResourceArnsResourceArnsListMemberString: + type: string + minLength: 20 + maxLength: 2048 + BatchDeleteInstrumentationConfigurationsResponse: + type: object + properties: + DeletedCount: + $ref: "#/components/schemas/Integer" + description: Number of configurations successfully deleted. When deleting by scope, this is the total count of deleted items. When deleting by ARN list, this equals the length of SuccessfulDeletions. + SuccessfulDeletions: + $ref: "#/components/schemas/BatchDeleteSuccessfulDeletionList" + description: List of successfully deleted configurations. Deleting by scope populates SignalType and LocationHash per item. Deleting by ARN list populates ResourceArn per item. + Errors: + $ref: "#/components/schemas/BatchDeleteErrorList" + description: List of configurations that failed to delete. + required: + - DeletedCount + - SuccessfulDeletions + - Errors + Integer: + type: integer + BatchDeleteSuccessfulDeletionList: + description: List of successful deletions in batch delete response. + type: array + items: + $ref: "#/components/schemas/BatchDeleteSuccessfulDeletion" + BatchDeleteSuccessfulDeletion: + description: Represents a successfully deleted instrumentation configuration. + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String" + description: ARN of the deleted configuration (populated only when deleting by ARN list). + SignalType: + $ref: "#/components/schemas/String" + description: Signal type of the deleted configuration (populated only when deleting by scope). + LocationHash: + $ref: "#/components/schemas/String" + description: Location hash of the deleted configuration (populated only when deleting by scope). + String: + type: string + BatchDeleteErrorList: + description: List of errors in batch delete response. + type: array + items: + $ref: "#/components/schemas/BatchDeleteError" + BatchDeleteError: + description: Represents an error that occurred when attempting to delete a configuration. + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String" + description: ARN of the configuration that failed to delete. + Code: + $ref: "#/components/schemas/BatchDeleteErrorCode" + description: Error code indicating the type of failure. + Message: + $ref: "#/components/schemas/String" + description: Descriptive error message. + required: + - ResourceArn + - Code + - Message + BatchDeleteErrorCode: + description: Error codes for batch delete item-level failures. + type: string + enum: + - ResourceNotFoundException + - AccessDeniedException + - InternalServiceException Timestamp: type: string format: date-time @@ -803,8 +1170,6 @@ components: type: array items: $ref: "#/components/schemas/String" - String: - type: string BatchGetServiceLevelObjectiveBudgetReportOutput: type: object properties: @@ -1437,71 +1802,353 @@ components: type: string ExclusionWindowErrorMessage: type: string - ServiceLevelObjectiveDescription: + CreateInstrumentationConfigurationRequestServiceString: type: string minLength: 1 - maxLength: 1024 - ServiceLevelIndicatorConfig: - description: This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor. + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + CreateInstrumentationConfigurationRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + DynamicInstrumentationSignalType: + description: The telemetry signal type for instrumentation. SNAPSHOT - Captures a snapshot of the instrumentation point. + type: string + enum: + - SNAPSHOT + Location: + description: A union that identifies the location to instrument. Specify a CodeLocation for code-level instrumentation. type: object properties: - SliMetricConfig: - $ref: "#/components/schemas/ServiceLevelIndicatorMetricConfig" - description: Use this structure to specify the metric to be used for the SLO. - MetricThreshold: - $ref: "#/components/schemas/ServiceLevelIndicatorMetricThreshold" - description: This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the observed Latency metric values are to be compared to. This is not required if CreateRecommendedSlo is set to true. - ComparisonOperator: - $ref: "#/components/schemas/ServiceLevelIndicatorComparisonOperator" - description: The arithmetic operation to use when comparing the specified metric to the threshold. This is not required if CreateRecommendedSlo is set to true. - required: - - SliMetricConfig - ServiceLevelIndicatorMetricConfig: - description: Use this structure to specify the information for the metric that a period-based SLO will monitor. + CodeLocation: + $ref: "#/components/schemas/CodeLocation" + description: A code location for code-level instrumentation, including language, code unit, class, method, file path, and optional line number. + CodeLocation: + description: Identifies a code location to instrument, including the programming language, code unit, class, method, file path, and optional line number. type: object properties: - KeyAttributes: - type: object - properties: {} - description: If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes. This is a string-to-string map. It can include the following fields. Type designates the type of object this is. ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource. Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service. Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource. Environment specifies the location where this object is hosted, or what it belongs to. - OperationName: - $ref: "#/components/schemas/OperationName" - description: If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation. - MetricType: - $ref: "#/components/schemas/ServiceLevelIndicatorMetricType" - description: If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used. - MetricName: - $ref: "#/components/schemas/MetricName" - description: The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics. - Statistic: - $ref: "#/components/schemas/ServiceLevelIndicatorStatistic" - description: The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions. - PeriodSeconds: - $ref: "#/components/schemas/SLIPeriodSeconds" - description: The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance. - MetricSource: - $ref: "#/components/schemas/MetricSource" - description: Identifies the metric source for SLOs on resources other than Application Signals services. - MetricDataQueries: - $ref: "#/components/schemas/MetricDataQueries" - description: If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression. - DependencyConfig: - $ref: "#/components/schemas/DependencyConfig" - description: Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName. - CompositeSliConfig: - $ref: "#/components/schemas/CompositeSliConfig" - description: The composite SLI configuration for service-level SLOs that monitor multiple operations of a service. - ServiceLevelIndicatorStatistic: + Language: + $ref: "#/components/schemas/ProgrammingLanguage" + description: The programming language for this instrumentation point, such as Java, Python, or JavaScript. + CodeUnit: + $ref: "#/components/schemas/CodeLocationCodeUnitString" + description: The package, module, or namespace that contains the target code, for example com.amazon.payment or payment_service. + ClassName: + $ref: "#/components/schemas/CodeLocationClassNameString" + description: The class or type name that contains the method. This is required for Java and optional for Python module-level functions. + MethodName: + $ref: "#/components/schemas/CodeLocationMethodNameString" + description: The method or function name to instrument, such as validateCreditCard or __init__. + FilePath: + $ref: "#/components/schemas/CodeLocationFilePathString" + description: The source file path relative to the project or source root, such as src/payment/PaymentProcessor.java or src/payment/PaymentProcessor.py. + LineNumber: + $ref: "#/components/schemas/CodeLocationLineNumberInteger" + description: The line number to instrument. Provide this to disambiguate overloaded methods and to target a specific line when needed. + required: + - Language + - FilePath + ProgrammingLanguage: + description: The programming language of the instrumentation point. Java, Python, and JavaScript are currently supported. + type: string + enum: + - Java + - Python + - Javascript + CodeLocationCodeUnitString: type: string minLength: 1 - maxLength: 20 - pattern: "[a-zA-Z0-9.]+" - SLIPeriodSeconds: + maxLength: 128 + CodeLocationClassNameString: + type: string + minLength: 1 + maxLength: 128 + CodeLocationMethodNameString: + type: string + minLength: 1 + maxLength: 80 + CodeLocationFilePathString: + type: string + minLength: 1 + maxLength: 1024 + CodeLocationLineNumberInteger: type: integer - minimum: 60 - maximum: 900 - RequestBasedServiceLevelIndicatorConfig: - description: This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor. + minimum: 1 + CreateInstrumentationConfigurationRequestDescriptionString: + type: string + minLength: 1 + maxLength: 50 + DynamicInstrumentationAttributeFilters: + description: An array of attribute filter groups used to target specific instances. Each filter group must match all of its keys (AND), and multiple groups are OR-matched to decide whether an instance applies the instrumentation. Filters are evaluated client-side by the SDK. + type: array + items: + $ref: "#/components/schemas/DynamicInstrumentationAttributeFilterGroup" + DynamicInstrumentationAttributeFilterGroup: + description: A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance. + type: object + properties: {} + CaptureConfiguration: + description: A union that defines what data to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings. + type: object + properties: + CodeCapture: + $ref: "#/components/schemas/CodeCaptureConfiguration" + description: Capture settings for code-level instrumentation, including arguments, return values, stack traces, local variables, and safety limits. + CodeCaptureConfiguration: + description: Defines what data to capture for code-level instrumentation, including arguments, return values, stack traces, local variables, and safety limits. + type: object + properties: + CaptureArguments: + $ref: "#/components/schemas/CodeCaptureConfigurationCaptureArgumentsList" + description: The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use ["*"] to capture all arguments, or specify argument names to capture selectively (up to 10 entries). + CaptureReturn: + $ref: "#/components/schemas/Boolean" + description: Whether to capture the return value. Defaults to false. + CaptureStackTrace: + $ref: "#/components/schemas/Boolean" + description: Whether to capture a stack trace when the instrumentation point is hit. Defaults to true. + CaptureLocals: + $ref: "#/components/schemas/CodeCaptureConfigurationCaptureLocalsList" + description: The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names. + CaptureLimits: + $ref: "#/components/schemas/CaptureLimitsConfig" + description: Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size. + required: + - CaptureLimits + CodeCaptureConfigurationCaptureArgumentsList: + type: array + items: + $ref: "#/components/schemas/CodeCaptureConfigurationCaptureArgumentsListMemberString" + CodeCaptureConfigurationCaptureArgumentsListMemberString: + type: string + minLength: 1 + maxLength: 80 + Boolean: + type: boolean + CodeCaptureConfigurationCaptureLocalsList: + type: array + items: + $ref: "#/components/schemas/CodeCaptureConfigurationCaptureLocalsListMemberString" + CodeCaptureConfigurationCaptureLocalsListMemberString: + type: string + minLength: 1 + maxLength: 80 + CaptureLimitsConfig: + description: Guardrails that prevent instrumentation from impacting application performance by limiting how much data is captured. + type: object + properties: + MaxHits: + $ref: "#/components/schemas/CaptureLimitsConfigMaxHitsInteger" + description: The maximum number of times the instrumentation point can be hit before it is automatically disabled. Defaults to 100. + MaxStringLength: + $ref: "#/components/schemas/CaptureLimitsConfigMaxStringLengthInteger" + description: The maximum length of captured string values in characters. Strings longer than this are truncated. Defaults to 128. + MaxCollectionWidth: + $ref: "#/components/schemas/CaptureLimitsConfigMaxCollectionWidthInteger" + description: The maximum number of items to capture from any collection to prevent large payloads. Defaults to 10. + MaxCollectionDepth: + $ref: "#/components/schemas/CaptureLimitsConfigMaxCollectionDepthInteger" + description: The maximum nesting depth to traverse inside collections. Defaults to 3. + MaxStackFrames: + $ref: "#/components/schemas/CaptureLimitsConfigMaxStackFramesInteger" + description: The maximum number of stack frames to capture in stack traces. Defaults to 2. + MaxStackTraceSize: + $ref: "#/components/schemas/CaptureLimitsConfigMaxStackTraceSizeInteger" + description: The maximum total size, in bytes, of a captured stack trace. Defaults to 1000. + MaxObjectDepth: + $ref: "#/components/schemas/CaptureLimitsConfigMaxObjectDepthInteger" + description: The maximum depth for nested object traversal when capturing structured data. Defaults to 3. + MaxFieldsPerObject: + $ref: "#/components/schemas/CaptureLimitsConfigMaxFieldsPerObjectInteger" + description: The maximum number of fields to capture for any object. Defaults to 10. + CaptureLimitsConfigMaxHitsInteger: + type: integer + minimum: 1 + maximum: 1000 + CaptureLimitsConfigMaxStringLengthInteger: + type: integer + minimum: 1 + maximum: 255 + CaptureLimitsConfigMaxCollectionWidthInteger: + type: integer + minimum: 1 + maximum: 20 + CaptureLimitsConfigMaxCollectionDepthInteger: + type: integer + minimum: 1 + maximum: 5 + CaptureLimitsConfigMaxStackFramesInteger: + type: integer + minimum: 1 + maximum: 20 + CaptureLimitsConfigMaxStackTraceSizeInteger: + type: integer + minimum: 1 + maximum: 1000 + CaptureLimitsConfigMaxObjectDepthInteger: + type: integer + minimum: 1 + maximum: 5 + CaptureLimitsConfigMaxFieldsPerObjectInteger: + type: integer + minimum: 1 + maximum: 20 + TagList: + type: array + items: + $ref: "#/components/schemas/Tag" + Tag: + description: A key-value pair associated with a resource. Tags can help you organize and categorize your resources. + type: object + properties: + Key: + $ref: "#/components/schemas/TagKey" + description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. + Value: + $ref: "#/components/schemas/TagValue" + description: The value for the specified tag key. + required: + - Key + - Value + TagKey: + type: string + minLength: 1 + maxLength: 128 + TagValue: + type: string + minLength: 0 + maxLength: 256 + CreateInstrumentationConfigurationResponse: + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: The type of instrumentation that was created, echoed from the request. + Service: + $ref: "#/components/schemas/CreateInstrumentationConfigurationResponseServiceString" + description: The service name for the instrumentation configuration, echoed from the request. + Environment: + $ref: "#/components/schemas/CreateInstrumentationConfigurationResponseEnvironmentString" + description: The environment for the instrumentation configuration, echoed from the request. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type for the instrumentation configuration, echoed from the request. + Location: + $ref: "#/components/schemas/Location" + description: The location where instrumentation is applied, echoed from the request. + LocationHash: + $ref: "#/components/schemas/CreateInstrumentationConfigurationResponseLocationHashString" + description: A stable hash computed from the location that uniquely identifies this instrumentation point within the service, environment, and signal type. + Description: + $ref: "#/components/schemas/String" + description: The optional description that was stored with the instrumentation configuration. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp after which this configuration is no longer served to clients. Present only for BREAKPOINT configurations; PROBE configurations do not expire. + AttributeFilters: + $ref: "#/components/schemas/DynamicInstrumentationAttributeFilters" + description: The attribute filters returned with the configuration so SDKs can perform client-side targeting. + CaptureConfiguration: + $ref: "#/components/schemas/CaptureConfiguration" + description: The capture settings that were stored for this instrumentation configuration. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The server-generated creation timestamp for this instrumentation configuration. + ARN: + $ref: "#/components/schemas/InstrumentationConfigurationArn" + description: ARN for the created instrumentation configuration + required: + - InstrumentationType + - Service + - Environment + - SignalType + - Location + - LocationHash + - CaptureConfiguration + - CreatedAt + - ARN + CreateInstrumentationConfigurationResponseServiceString: + type: string + minLength: 1 + maxLength: 255 + CreateInstrumentationConfigurationResponseEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + CreateInstrumentationConfigurationResponseLocationHashString: + type: string + minLength: 16 + maxLength: 16 + InstrumentationConfigurationArn: + description: "ARN for an instrumentation configuration Format: arn:${Partition}:application-signals:${Region}:${Account}:instrumentationConfig/${service}/${environment}/${signalType}/${locationHash} Note: service and environment can contain '/' and ':', so we use a permissive pattern that only validates the ARN prefix structure and the 16-character lowercase hex locationHash suffix." + type: string + pattern: arn:[^:]+:application-signals:[^:]+:[0-9]{12}:instrumentationConfig/.+/[0-9a-f]{16} + ServiceLevelObjectiveDescription: + type: string + minLength: 1 + maxLength: 1024 + ServiceLevelIndicatorConfig: + description: This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor. + type: object + properties: + SliMetricConfig: + $ref: "#/components/schemas/ServiceLevelIndicatorMetricConfig" + description: Use this structure to specify the metric to be used for the SLO. + MetricThreshold: + $ref: "#/components/schemas/ServiceLevelIndicatorMetricThreshold" + description: This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the observed Latency metric values are to be compared to. This is not required if CreateRecommendedSlo is set to true. + ComparisonOperator: + $ref: "#/components/schemas/ServiceLevelIndicatorComparisonOperator" + description: The arithmetic operation to use when comparing the specified metric to the threshold. This is not required if CreateRecommendedSlo is set to true. + required: + - SliMetricConfig + ServiceLevelIndicatorMetricConfig: + description: Use this structure to specify the information for the metric that a period-based SLO will monitor. + type: object + properties: + KeyAttributes: + type: object + properties: {} + description: If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes. This is a string-to-string map. It can include the following fields. Type designates the type of object this is. ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource. Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service. Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource. Environment specifies the location where this object is hosted, or what it belongs to. + OperationName: + $ref: "#/components/schemas/OperationName" + description: If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation. + MetricType: + $ref: "#/components/schemas/ServiceLevelIndicatorMetricType" + description: If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used. + MetricName: + $ref: "#/components/schemas/MetricName" + description: The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics. + Statistic: + $ref: "#/components/schemas/ServiceLevelIndicatorStatistic" + description: The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions. + PeriodSeconds: + $ref: "#/components/schemas/SLIPeriodSeconds" + description: The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance. + MetricSource: + $ref: "#/components/schemas/MetricSource" + description: Identifies the metric source for SLOs on resources other than Application Signals services. + MetricDataQueries: + $ref: "#/components/schemas/MetricDataQueries" + description: If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression. + DependencyConfig: + $ref: "#/components/schemas/DependencyConfig" + description: Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName. + CompositeSliConfig: + $ref: "#/components/schemas/CompositeSliConfig" + description: The composite SLI configuration for service-level SLOs that monitor multiple operations of a service. + ServiceLevelIndicatorStatistic: + type: string + minLength: 1 + maxLength: 20 + pattern: "[a-zA-Z0-9.]+" + SLIPeriodSeconds: + type: integer + minimum: 60 + maximum: 900 + RequestBasedServiceLevelIndicatorConfig: + description: This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor. type: object properties: RequestBasedSliMetricConfig: @@ -1547,31 +2194,6 @@ components: CompositeSliConfig: $ref: "#/components/schemas/CompositeSliConfig" description: The composite SLI configuration for service-level SLOs that monitor multiple operations of a service. - TagList: - type: array - items: - $ref: "#/components/schemas/Tag" - Tag: - description: A key-value pair associated with a resource. Tags can help you organize and categorize your resources. - type: object - properties: - Key: - $ref: "#/components/schemas/TagKey" - description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. - Value: - $ref: "#/components/schemas/TagValue" - description: The value for the specified tag key. - required: - - Key - - Value - TagKey: - type: string - minLength: 1 - maxLength: 128 - TagValue: - type: string - minLength: 0 - maxLength: 256 BurnRateConfigurations: type: array items: @@ -1589,8 +2211,6 @@ components: type: integer minimum: 1 maximum: 10080 - Boolean: - type: boolean CreateServiceLevelObjectiveOutput: type: object properties: @@ -1655,8 +2275,212 @@ components: - Service DeleteGroupingConfigurationOutput: type: object + DeleteInstrumentationConfigurationRequestServiceString: + type: string + minLength: 1 + maxLength: 255 + DeleteInstrumentationConfigurationRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + LocationIdentifier: + description: Union type for identifying an instrumentation configuration by code location or locationHash. Used in Get/Delete/GetStatus operations to allow flexible identification. + type: object + properties: + CodeLocation: + $ref: "#/components/schemas/CodeLocation" + description: The full code location specification (will be hashed internally) + LocationHash: + $ref: "#/components/schemas/LocationIdentifierLocationHashString" + description: The pre-computed location hash (16-character hex string) + LocationIdentifierLocationHashString: + type: string + minLength: 16 + maxLength: 16 + DeleteInstrumentationConfigurationResponse: + type: object + properties: + DeletionStatus: + $ref: "#/components/schemas/DynamicInstrumentationDeletionStatus" + description: The result of the delete request. The value is DELETED when the configuration has been removed. + required: + - DeletionStatus + DynamicInstrumentationDeletionStatus: + description: The status of a delete request for an instrumentation configuration. The value is DELETED after a successful deletion. + type: string + enum: + - DELETED DeleteServiceLevelObjectiveOutput: type: object + GetInstrumentationConfigurationRequestServiceString: + type: string + minLength: 1 + maxLength: 255 + GetInstrumentationConfigurationRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + GetInstrumentationConfigurationResponse: + type: object + properties: + Configuration: + $ref: "#/components/schemas/InstrumentationConfiguration" + description: The complete instrumentation configuration, including its location hash, capture settings, filters, expiration, and creation time. + required: + - Configuration + InstrumentationConfiguration: + description: The full instrumentation configuration, including the instrumentation type, service, environment, signal type, location details, stable location hash, capture settings, filters, expiration, creation time, and ARN. + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: The type of instrumentation for this configuration. + Service: + $ref: "#/components/schemas/InstrumentationConfigurationServiceString" + description: The service that this instrumentation configuration targets. + Environment: + $ref: "#/components/schemas/InstrumentationConfigurationEnvironmentString" + description: The environment where the service is running. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type for this instrumentation configuration. + Location: + $ref: "#/components/schemas/Location" + description: The location where this instrumentation is applied. + LocationHash: + $ref: "#/components/schemas/InstrumentationConfigurationLocationHashString" + description: The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment. + Description: + $ref: "#/components/schemas/InstrumentationConfigurationDescriptionString" + description: An optional short description of the instrumentation configuration. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when this configuration expires. + AttributeFilters: + $ref: "#/components/schemas/DynamicInstrumentationAttributeFilters" + description: Client-side filters that determine which instances apply this instrumentation. + CaptureConfiguration: + $ref: "#/components/schemas/CaptureConfiguration" + description: The capture settings for this instrumentation configuration. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when this instrumentation configuration was created. + ARN: + $ref: "#/components/schemas/InstrumentationConfigurationArn" + description: ARN for the instrumentation configuration + required: + - InstrumentationType + - Service + - Environment + - SignalType + - Location + - LocationHash + - CaptureConfiguration + - CreatedAt + - ARN + InstrumentationConfigurationServiceString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationConfigurationEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationConfigurationLocationHashString: + type: string + minLength: 16 + maxLength: 16 + InstrumentationConfigurationDescriptionString: + type: string + minLength: 1 + maxLength: 50 + GetInstrumentationConfigurationStatusRequestServiceString: + type: string + minLength: 1 + maxLength: 255 + GetInstrumentationConfigurationStatusRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationConfigurationStatus: + description: The status of an instrumentation configuration on a host. READY - The configuration has been applied but has not been hit yet. ERROR - Applying the configuration failed; see the error cause. ACTIVE - The configuration has been hit and is capturing data. DISABLED - The configuration was disabled, for example because a limit was reached. + type: string + enum: + - READY + - ERROR + - ACTIVE + - DISABLED + GetInstrumentationConfigurationStatusRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + NextToken: + type: string + GetInstrumentationConfigurationStatusResponse: + type: object + properties: + Service: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusResponseServiceString" + description: The service name echoed from the request. + Environment: + $ref: "#/components/schemas/GetInstrumentationConfigurationStatusResponseEnvironmentString" + description: The environment echoed from the request. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type echoed from the request. + Location: + $ref: "#/components/schemas/Location" + description: The code location echoed from the request. + Status: + $ref: "#/components/schemas/InstrumentationConfigurationStatus" + description: The status that was queried. If not specified in the request, this is ACTIVE. + Events: + $ref: "#/components/schemas/InstrumentationStatusEventList" + description: The list of status events within the requested time window, sorted with the most recent first. Error events include an error cause. + NextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to continue retrieving status events. + required: + - Service + - Environment + - SignalType + - Location + - Status + - Events + GetInstrumentationConfigurationStatusResponseServiceString: + type: string + minLength: 1 + maxLength: 255 + GetInstrumentationConfigurationStatusResponseEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationStatusEventList: + type: array + items: + $ref: "#/components/schemas/InstrumentationStatusEvent" + InstrumentationStatusEvent: + description: A status event for an instrumentation configuration returned by GetInstrumentationConfigurationStatus. Events include the timestamp and, for errors, an error cause. + type: object + properties: + Time: + $ref: "#/components/schemas/Timestamp" + description: The time when the status was reported, rounded to the nearest minute. + ErrorCause: + $ref: "#/components/schemas/InstrumentationErrorCause" + description: The error cause when the status is ERROR. + required: + - Time + InstrumentationErrorCause: + description: The reason why applying an instrumentation configuration failed. FILE_NOT_FOUND - The specified file or file location could not be located. METHOD_NOT_FOUND - The specified method or function does not exist. LINE_NOT_EXECUTABLE - The specified line does not contain executable code. OVERLOADED_METHODS - Multiple overloaded methods were found; provide a line number to disambiguate. LANGUAGE_MISMATCH - The language specified in the configuration does not match the service. RUNTIME_ERROR - A runtime error occurred while applying the instrumentation. + type: string + enum: + - FILE_NOT_FOUND + - METHOD_NOT_FOUND + - LINE_NOT_EXECUTABLE + - OVERLOADED_METHODS + - LANGUAGE_MISMATCH + - RUNTIME_ERROR Attributes: type: object properties: {} @@ -1885,8 +2709,6 @@ components: enum: - BRIEF - DETAILED - NextToken: - type: string ListAuditFindingMaxResults: type: integer minimum: 1 @@ -2165,6 +2987,116 @@ components: type: array items: $ref: "#/components/schemas/GroupingString" + ListInstrumentationConfigurationsRequestServiceString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + ListInstrumentationConfigurationsRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9:/+=,.@_-]+" + ListInstrumentationConfigurationsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + InstrumentationConfigurationsPage: + type: object + properties: + Service: + $ref: "#/components/schemas/InstrumentationConfigurationsPageServiceString" + description: The service name associated with the returned configurations. + Environment: + $ref: "#/components/schemas/InstrumentationConfigurationsPageEnvironmentString" + description: The environment associated with the returned configurations. + Changed: + $ref: "#/components/schemas/Boolean" + description: Indicates whether there are configuration changes since the provided SyncedAt timestamp. + LatestConfigurations: + $ref: "#/components/schemas/InstrumentationConfigurationsWithoutServiceEnv" + description: The current set of active instrumentation configurations for the service and environment. Items omit service and environment because they are provided in the request. + SyncedAt: + $ref: "#/components/schemas/Timestamp" + description: The server timestamp to supply on the next sync call. + SyncInterval: + $ref: "#/components/schemas/InstrumentationConfigurationsPageSyncIntervalInteger" + description: The suggested number of seconds to wait before the next sync request. This is at least 60 seconds to prevent excessive polling. + NextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to continue listing configurations when more results are available. + required: + - Service + - Environment + - Changed + - SyncedAt + - SyncInterval + InstrumentationConfigurationsPageServiceString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationConfigurationsPageEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + InstrumentationConfigurationsWithoutServiceEnv: + description: An array of instrumentation configurations that omit service and environment, used when those values are provided elsewhere in the response. + type: array + items: + $ref: "#/components/schemas/InstrumentationConfigurationWithoutServiceEnv" + InstrumentationConfigurationWithoutServiceEnv: + description: An instrumentation configuration that omits service and environment because they are provided at a higher level, such as in a list response. + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: The type of instrumentation for this configuration. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type for this instrumentation configuration. + Location: + $ref: "#/components/schemas/Location" + description: The location where this instrumentation is applied. + LocationHash: + $ref: "#/components/schemas/InstrumentationConfigurationWithoutServiceEnvLocationHashString" + description: The stable hash derived from the location that identifies this instrumentation point. + Description: + $ref: "#/components/schemas/InstrumentationConfigurationWithoutServiceEnvDescriptionString" + description: An optional short description of the instrumentation configuration. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when this configuration expires. + AttributeFilters: + $ref: "#/components/schemas/DynamicInstrumentationAttributeFilters" + description: Client-side filters that determine which instances apply this instrumentation. + CaptureConfiguration: + $ref: "#/components/schemas/CaptureConfiguration" + description: The capture settings for this instrumentation configuration. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when this instrumentation configuration was created. + ARN: + $ref: "#/components/schemas/InstrumentationConfigurationArn" + description: ARN for the instrumentation configuration + required: + - InstrumentationType + - SignalType + - Location + - LocationHash + - CaptureConfiguration + - CreatedAt + - ARN + InstrumentationConfigurationWithoutServiceEnvLocationHashString: + type: string + minLength: 16 + maxLength: 16 + InstrumentationConfigurationWithoutServiceEnvDescriptionString: + type: string + minLength: 1 + maxLength: 50 + InstrumentationConfigurationsPageSyncIntervalInteger: + type: integer + minimum: 60 ListServiceDependenciesMaxResults: type: integer minimum: 1 @@ -2527,6 +3459,118 @@ components: required: - GroupingAttributeDefinitions - UpdatedAt + ReportInstrumentationConfigurationStatusRequestServiceString: + type: string + minLength: 1 + maxLength: 255 + ReportInstrumentationConfigurationStatusRequestEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + ReportInstrumentationConfigurationStatusRequestConfigurationsList: + type: array + items: + $ref: "#/components/schemas/InstrumentationConfigurationStatusReport" + InstrumentationConfigurationStatusReport: + description: The status of a single instrumentation configuration reported by an SDK instance. + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: The type of instrumentation configuration being reported. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type for this instrumentation configuration. + LocationHash: + $ref: "#/components/schemas/InstrumentationConfigurationStatusReportLocationHashString" + description: The stable hash of the instrumentation location that identifies the configuration being reported. + Status: + $ref: "#/components/schemas/InstrumentationConfigurationStatus" + description: "The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED." + Time: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the status event occurred. + ErrorCause: + $ref: "#/components/schemas/InstrumentationErrorCause" + description: The error cause when the status is ERROR, such as the file or method not being found. + required: + - InstrumentationType + - SignalType + - LocationHash + - Status + - Time + InstrumentationConfigurationStatusReportLocationHashString: + type: string + minLength: 16 + maxLength: 16 + ReportInstrumentationConfigurationStatusResponse: + type: object + properties: + Service: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusResponseServiceString" + description: The service name echoed from the request. + Environment: + $ref: "#/components/schemas/ReportInstrumentationConfigurationStatusResponseEnvironmentString" + description: The environment echoed from the request. + UnprocessedStatusEvents: + $ref: "#/components/schemas/UnprocessedStatusEventList" + description: Status events that failed to be processed. Each entry includes the configuration identifiers, status, timestamp, and a reason for the failure. + required: + - Service + - Environment + - UnprocessedStatusEvents + ReportInstrumentationConfigurationStatusResponseServiceString: + type: string + minLength: 1 + maxLength: 255 + ReportInstrumentationConfigurationStatusResponseEnvironmentString: + type: string + minLength: 1 + maxLength: 255 + UnprocessedStatusEventList: + type: array + items: + $ref: "#/components/schemas/UnprocessedStatusEvent" + UnprocessedStatusEvent: + description: A status event that could not be processed by the service. + type: object + properties: + InstrumentationType: + $ref: "#/components/schemas/InstrumentationType" + description: The type of instrumentation configuration for the unprocessed status event. + SignalType: + $ref: "#/components/schemas/DynamicInstrumentationSignalType" + description: The telemetry signal type for the unprocessed status event. + LocationHash: + $ref: "#/components/schemas/UnprocessedStatusEventLocationHashString" + description: The stable hash of the instrumentation location for the unprocessed event. + Status: + $ref: "#/components/schemas/InstrumentationConfigurationStatus" + description: The status that failed to be processed. + Time: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the status event that failed to be processed. + FailedReason: + $ref: "#/components/schemas/UnprocessedStatusEventFailureReason" + description: The reason why this status event could not be processed, such as throttling or validation errors. + required: + - InstrumentationType + - SignalType + - LocationHash + - Status + - Time + - FailedReason + UnprocessedStatusEventLocationHashString: + type: string + minLength: 16 + maxLength: 16 + UnprocessedStatusEventFailureReason: + description: The reason an instrumentation status event could not be processed. THROTTLED - The request exceeded allowed throughput. INTERNAL_ERROR - An internal server error occurred while processing the event. VALIDATION_ERROR - The event failed validation. + type: string + enum: + - THROTTLED + - INTERNAL_ERROR + - VALIDATION_ERROR StartDiscoveryOutput: type: object TagResourceResponse: @@ -2546,6 +3590,84 @@ components: required: - Slo x-stackQL-resources: + instrumentation_configurations: + id: aws.application_signals.instrumentation_configurations + name: instrumentation_configurations + title: instrumentation_configurations + methods: + batch_delete_instrumentation_configurations: + operation: + $ref: "#/paths/~1batch-delete-instrumentation-configurations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_instrumentation_configuration: + operation: + $ref: "#/paths/~1create-instrumentation-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_instrumentation_configuration: + operation: + $ref: "#/paths/~1delete-instrumentation-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_instrumentation_configuration: + operation: + $ref: "#/paths/~1get-instrumentation-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Configuration + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_instrumentation_configurations: + operation: + $ref: "#/paths/~1list-instrumentation-configurations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.LatestConfigurations + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/instrumentation_configurations/methods/get_instrumentation_configuration" + - $ref: "#/components/x-stackQL-resources/instrumentation_configurations/methods/list_instrumentation_configurations" + insert: + - $ref: "#/components/x-stackQL-resources/instrumentation_configurations/methods/create_instrumentation_configuration" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/instrumentation_configurations/methods/delete_instrumentation_configuration" service_level_objective_budget_reports: id: aws.application_signals.service_level_objective_budget_reports name: service_level_objective_budget_reports @@ -2667,6 +3789,47 @@ components: - $ref: "#/components/x-stackQL-resources/grouping_configurations/methods/put_grouping_configuration" delete: - $ref: "#/components/x-stackQL-resources/grouping_configurations/methods/delete_grouping_configuration" + instrumentation_configuration_status: + id: aws.application_signals.instrumentation_configuration_status + name: instrumentation_configuration_status + title: instrumentation_configuration_status + methods: + get_instrumentation_configuration_status: + operation: + $ref: "#/paths/~1get-instrumentation-configuration-status/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Events + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + report_instrumentation_configuration_status: + operation: + $ref: "#/paths/~1report-instrumentation-configuration-status/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/instrumentation_configuration_status/methods/get_instrumentation_configuration_status" + insert: [] + update: [] + delete: [] services: id: aws.application_signals.services name: services diff --git a/providers/src/aws/v00.00.00000/services/appstream.yaml b/providers/src/aws/v00.00.00000/services/appstream.yaml index f6a29bdb..782c3da4 100644 --- a/providers/src/aws/v00.00.00000/services/appstream.yaml +++ b/providers/src/aws/v00.00.00000/services/appstream.yaml @@ -923,7 +923,10 @@ paths: description: A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens. SourceAmiId: $ref: "#/components/schemas/PhotonAmiId" - description: The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers. + description: The ID of the EC2 AMI to import. + WorkspaceImageId: + $ref: "#/components/schemas/WorkspaceImageId" + description: The ID of the Workspaces Image to import. IamRoleArn: $ref: "#/components/schemas/Arn" description: The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role. @@ -948,9 +951,6 @@ paths: DryRun: $ref: "#/components/schemas/Boolean" description: When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation. - required: - - SourceAmiId - - IamRoleArn responses: "200": description: Success @@ -4497,6 +4497,7 @@ components: - EXPORTING - COMPLETED - FAILED + - TIMED_OUT PhotonAmiId: type: string pattern: ^ami-[a-z0-9]{8,17}$ @@ -4841,6 +4842,11 @@ components: Expires: $ref: "#/components/schemas/Timestamp" description: The elapsed time, in seconds after the Unix epoch, when this URL expires. + WorkspaceImageId: + type: string + minLength: 12 + maxLength: 67 + pattern: ^wsi-[0-9a-z]{8,63}$ ImageImportDescription: type: string maxLength: 256 @@ -5057,6 +5063,7 @@ components: enum: - CUSTOM - NATIVE + - BYOL StorageConnectorList: description: The storage connectors. type: array @@ -5230,6 +5237,9 @@ components: ScreenImageFormat: $ref: "#/components/schemas/ScreenImageFormat" description: The image format for agent screen captures. + UserControlMode: + $ref: "#/components/schemas/UserControlMode" + description: The user control mode for agent sessions. This setting determines how users can interact with agent sessions. required: - Settings - ScreenResolution @@ -5245,7 +5255,7 @@ components: properties: AgentAction: $ref: "#/components/schemas/AgentAction" - description: The agent action to configure. Valid values are COMPUTER_VISION and COMPUTER_INPUT. If you enable COMPUTER_INPUT, you must also enable COMPUTER_VISION. + description: The agent action to configure. Valid values are COMPUTER_VISION, COMPUTER_INPUT, and FORWARD_MCP_TOOLS. If you enable COMPUTER_INPUT, you must also enable COMPUTER_VISION. Permission: $ref: "#/components/schemas/Permission" description: Whether the agent action is enabled or disabled. @@ -5253,11 +5263,12 @@ components: - AgentAction - Permission AgentAction: - description: The type of agent action. COMPUTER_VISION - Allows agents to take screenshots of the desktop. COMPUTER_INPUT - Allows agents to click, type, and scroll on the desktop. Requires COMPUTER_VISION to also be enabled. + description: The type of agent action. COMPUTER_VISION - Allows agents to take screenshots of the desktop. COMPUTER_INPUT - Allows agents to click, type, and scroll on the desktop. Requires COMPUTER_VISION to also be enabled. FORWARD_MCP_TOOLS - Allows agents to interact with applications and the desktop operating system through direct MCP calls rather than using computer use tools. Forwards MCP tools configured on the WorkSpaces application session to the agent. type: string enum: - COMPUTER_VISION - COMPUTER_INPUT + - FORWARD_MCP_TOOLS S3BucketArn: type: string pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:s3:::[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]$ @@ -5272,6 +5283,13 @@ components: enum: - PNG - JPEG + UserControlMode: + description: The user control mode for agent sessions. VIEW_ONLY - Users can view and observe agent actions as they happen. VIEW_STOP - Users can view agent actions and stop the agent if needed. DISABLED - Users cannot view or stop the agent session. + type: string + enum: + - VIEW_ONLY + - VIEW_STOP + - DISABLED CreateStackResult: type: object properties: @@ -6254,6 +6272,9 @@ components: ScreenImageFormat: $ref: "#/components/schemas/ScreenImageFormat" description: The image format for agent screen captures. + UserControlMode: + $ref: "#/components/schemas/UserControlMode" + description: The user control mode for agent sessions. This setting determines how users can interact with agent sessions. UpdateStackResult: type: object properties: @@ -7096,8 +7117,8 @@ components: select: - $ref: "#/components/x-stackQL-resources/images/methods/describe_images" insert: - - $ref: "#/components/x-stackQL-resources/images/methods/create_imported_image" - $ref: "#/components/x-stackQL-resources/images/methods/create_updated_image" + - $ref: "#/components/x-stackQL-resources/images/methods/create_imported_image" update: [] delete: - $ref: "#/components/x-stackQL-resources/images/methods/delete_image" diff --git a/providers/src/aws/v00.00.00000/services/arc_region_switch.yaml b/providers/src/aws/v00.00.00000/services/arc_region_switch.yaml index 7a40c570..6a01a422 100644 --- a/providers/src/aws/v00.00.00000/services/arc_region_switch.yaml +++ b/providers/src/aws/v00.00.00000/services/arc_region_switch.yaml @@ -544,7 +544,7 @@ paths: description: The record name for the health checks. maxResults: $ref: "#/components/schemas/ListRoute53HealthChecksRequestMaxResultsInteger" - description: The number of objects that you want to return with this call. + description: The maximum number of results to return in the response. nextToken: $ref: "#/components/schemas/NextToken" description: Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. @@ -589,7 +589,7 @@ paths: description: The record name for the health checks. maxResults: $ref: "#/components/schemas/ListRoute53HealthChecksInRegionRequestMaxResultsInteger" - description: The number of objects that you want to return with this call. + description: The maximum number of results to return in the response. nextToken: $ref: "#/components/schemas/NextToken" description: Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. @@ -677,6 +677,9 @@ paths: recoveryExecutionId: $ref: "#/components/schemas/RecoveryExecutionId" description: The execution identifier of the recovery execution that ran in the opposite region post-recovery is ran in. Required when starting a post-recovery execution. + clientToken: + $ref: "#/components/schemas/StartPlanExecutionRequestClientTokenString" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request and returns the result of the original successful request. If you don't provide a client token, the service automatically generates one. For more information about idempotency, see Making retries safe with idempotent APIs. required: - planArn - targetRegion @@ -1069,6 +1072,15 @@ components: lambdaEventSourceMappingConfig: $ref: "#/components/schemas/LambdaEventSourceMappingConfiguration" description: A Lambda event source mapping execution block. + auroraServerlessScalingConfig: + $ref: "#/components/schemas/AuroraServerlessScalingConfiguration" + description: An Aurora Serverless scaling execution block. + auroraProvisionedScalingConfig: + $ref: "#/components/schemas/AuroraProvisionedScalingConfiguration" + description: An Aurora provisioned cluster scaling execution block. + neptuneGlobalDatabaseConfig: + $ref: "#/components/schemas/NeptuneGlobalDatabaseConfiguration" + description: A Neptune global database execution block. CustomActionLambdaConfiguration: description: Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch. type: object @@ -1683,6 +1695,120 @@ components: type: string enum: - skip + AuroraServerlessScalingConfiguration: + description: Configuration for Amazon Aurora Serverless scaling used in a Region switch plan. + type: object + properties: + timeoutMinutes: + $ref: "#/components/schemas/AuroraServerlessScalingConfigurationTimeoutMinutesInteger" + description: The timeout value specified for the configuration. + crossAccountRole: + $ref: "#/components/schemas/IamRoleArn" + description: The cross account role for the configuration. + externalId: + $ref: "#/components/schemas/String" + description: The external ID (secret key) for the configuration. + globalClusterIdentifier: + $ref: "#/components/schemas/GlobalClusterIdentifier" + description: The global cluster identifier for a global database. + regionDatabaseClusterArns: + type: object + properties: {} + description: Per-Region configuration that maps each Region to the Aurora database cluster ARN for scaling. + targetPercent: + $ref: "#/components/schemas/Integer" + description: The target capacity percentage for Aurora Serverless scaling. + required: + - globalClusterIdentifier + - regionDatabaseClusterArns + AuroraServerlessScalingConfigurationTimeoutMinutesInteger: + type: integer + minimum: 1 + AuroraProvisionedScalingConfiguration: + description: Configuration for Amazon Aurora provisioned cluster scaling used in a Region switch plan. + type: object + properties: + timeoutMinutes: + $ref: "#/components/schemas/AuroraProvisionedScalingConfigurationTimeoutMinutesInteger" + description: The timeout value specified for the configuration. + crossAccountRole: + $ref: "#/components/schemas/IamRoleArn" + description: The cross account role for the configuration. + externalId: + $ref: "#/components/schemas/String" + description: The external ID (secret key) for the configuration. + globalClusterIdentifier: + $ref: "#/components/schemas/GlobalClusterIdentifier" + description: The global cluster identifier for a global database. + regionDatabaseClusterArns: + type: object + properties: {} + description: Per-Region configuration that maps each Region to the Aurora database cluster ARN for scaling. + instanceArns: + type: object + properties: {} + description: Per-Region configuration that maps each Region to the Aurora database instance ARN for scaling. + required: + - globalClusterIdentifier + - regionDatabaseClusterArns + - instanceArns + AuroraProvisionedScalingConfigurationTimeoutMinutesInteger: + type: integer + minimum: 1 + NeptuneGlobalDatabaseConfiguration: + description: Configuration for Amazon Neptune global databases used in a Region switch plan. + type: object + properties: + timeoutMinutes: + $ref: "#/components/schemas/NeptuneGlobalDatabaseConfigurationTimeoutMinutesInteger" + description: The timeout value specified for the configuration. + crossAccountRole: + $ref: "#/components/schemas/IamRoleArn" + description: The cross account role for the configuration. + externalId: + $ref: "#/components/schemas/String" + description: The external ID (secret key) for the configuration. + behavior: + $ref: "#/components/schemas/NeptuneDefaultBehavior" + description: The behavior for a global database, that is, only allow switchover or also allow failover. + ungraceful: + $ref: "#/components/schemas/NeptuneUngraceful" + description: The settings for ungraceful execution. + globalClusterIdentifier: + $ref: "#/components/schemas/NeptuneGlobalClusterIdentifier" + description: The global cluster identifier for a Neptune global database. + regionDatabaseClusterArns: + type: object + properties: {} + description: The database cluster Amazon Resource Names (ARNs) for a Neptune global database. + required: + - behavior + - globalClusterIdentifier + - regionDatabaseClusterArns + NeptuneGlobalDatabaseConfigurationTimeoutMinutesInteger: + type: integer + minimum: 1 + NeptuneDefaultBehavior: + type: string + enum: + - switchoverOnly + - failover + NeptuneUngraceful: + description: Configuration for handling failures when performing operations on Neptune global databases. + type: object + properties: + ungraceful: + $ref: "#/components/schemas/NeptuneUngracefulBehavior" + description: The settings for ungraceful execution. + NeptuneUngracefulBehavior: + type: string + enum: + - failover + NeptuneGlobalClusterIdentifier: + type: string + minLength: 1 + maxLength: 63 + pattern: "[A-Za-z][0-9A-Za-z-]*" ExecutionBlockType: type: string enum: @@ -1700,6 +1826,9 @@ components: - RdsPromoteReadReplica - RdsCreateCrossRegionReplica - LambdaEventSourceMapping + - AuroraServerlessScaling + - AuroraProvisionedScaling + - NeptuneGlobalDatabase WorkflowTargetAction: type: string enum: @@ -2392,7 +2521,7 @@ components: description: Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. ListRoute53HealthChecksRequestMaxResultsInteger: type: integer - minimum: 10 + minimum: 1 maximum: 100 ListRoute53HealthChecksResponse: type: object @@ -2402,7 +2531,7 @@ components: description: List of the health checks requested. nextToken: $ref: "#/components/schemas/NextToken" - description: Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. + description: A pagination token. A response may contain no results while still including a nextToken. Continue paginating until nextToken is null to retrieve all results. Route53HealthCheckList: type: array items: @@ -2452,7 +2581,7 @@ components: description: List of the health checks requested. nextToken: $ref: "#/components/schemas/NextToken" - description: Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. + description: A pagination token. A response may contain no results while still including a nextToken. Continue paginating until nextToken is null to retrieve all results. ListTagsForResourceResponse: type: object properties: @@ -2463,6 +2592,11 @@ components: RecoveryExecutionId: type: string pattern: "[a-z]{2}(-[a-z]+)+-[0-9]+/[0-9a-fA-F]{16}" + StartPlanExecutionRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" StartPlanExecutionResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/artifact.yaml b/providers/src/aws/v00.00.00000/services/artifact.yaml index 1f529d4b..4a0f6111 100644 --- a/providers/src/aws/v00.00.00000/services/artifact.yaml +++ b/providers/src/aws/v00.00.00000/services/artifact.yaml @@ -16,6 +16,65 @@ servers: description: AWS region description: Regional endpoint for artifact paths: + /v1/compliance-inquiry/create: + post: + operationId: CreateComplianceInquiry + description: Create a new compliance inquiry. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/InquiryName" + inquiryContent: + $ref: "#/components/schemas/InquiryContent" + clientToken: + $ref: "#/components/schemas/IdempotentClientToken" + supportMode: + $ref: "#/components/schemas/InquirySupportMode" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - name + - inquiryContent + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateComplianceInquiryResponse" + /v1/compliance-inquiry/export: + post: + operationId: ExportComplianceInquiry + description: Export a compliance inquiry report. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + complianceInquiryId: + $ref: "#/components/schemas/InquiryId" + queryIdentifiers: + $ref: "#/components/schemas/QueryIdentifiersList" + includeCitations: + $ref: "#/components/schemas/Boolean" + required: + - complianceInquiryId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExportComplianceInquiryResponse" /v1/account-settings/get: get: operationId: GetAccountSettings @@ -28,6 +87,24 @@ paths: application/json: schema: $ref: "#/components/schemas/GetAccountSettingsResponse" + /v1/compliance-inquiry/getMetadata: + get: + operationId: GetComplianceInquiryMetadata + description: Get the metadata for a single compliance inquiry. + parameters: + - name: complianceInquiryId + in: query + required: true + schema: + $ref: "#/components/schemas/InquiryId" + description: Unique resource ID for the compliance inquiry. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetComplianceInquiryMetadataResponse" /v1/report/get: get: operationId: GetReport @@ -106,6 +183,60 @@ paths: application/json: schema: $ref: "#/components/schemas/GetTermForReportResponse" + /v1/compliance-inquiry/list: + get: + operationId: ListComplianceInquiries + description: List available compliance inquiries. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResultsAttribute" + description: Maximum number of resources to return in the paginated response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextTokenAttribute" + description: Pagination token to request the next page of resources. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListComplianceInquiriesResponse" + /v1/compliance-inquiry/listQueries: + get: + operationId: ListComplianceInquiryQueries + description: List queries within a compliance inquiry. + parameters: + - name: complianceInquiryId + in: query + required: true + schema: + $ref: "#/components/schemas/InquiryId" + description: Unique resource ID for the compliance inquiry. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResultsAttribute" + description: Maximum number of resources to return in the paginated response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextTokenAttribute" + description: Pagination token to request the next page of resources. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListComplianceInquiryQueriesResponse" /v1/customer-agreement/list: get: operationId: ListCustomerAgreements @@ -184,6 +315,75 @@ paths: application/json: schema: $ref: "#/components/schemas/ListReportsResponse" + /tags/{resource_arn}: + get: + operationId: ListTagsForResource + description: List tags for a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/LongStringAttribute" + description: The Amazon Resource Name (ARN) of the resource. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + post: + operationId: TagResource + description: Add tags to a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/LongStringAttribute" + description: The Amazon Resource Name (ARN) of the resource. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tags: + $ref: "#/components/schemas/TagsMap" + required: + - tags + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceResponse" + delete: + operationId: UntagResource + description: Remove tags from a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/LongStringAttribute" + description: The Amazon Resource Name (ARN) of the resource. + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeys" + description: Tag keys to remove from the resource. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceResponse" /v1/account-settings/put: put: operationId: PutAccountSettings @@ -205,6 +405,42 @@ paths: application/json: schema: $ref: "#/components/schemas/PutAccountSettingsResponse" + /v1/compliance-inquiry/putFeedback: + put: + operationId: PutComplianceInquiryFeedback + description: Submits feedback on a compliance inquiry response. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + complianceInquiryId: + $ref: "#/components/schemas/InquiryId" + queryIdentifier: + $ref: "#/components/schemas/Integer" + rating: + $ref: "#/components/schemas/FeedbackRating" + responseRevisionId: + $ref: "#/components/schemas/Integer" + reasonCodes: + $ref: "#/components/schemas/FeedbackReasonCodeList" + comment: + $ref: "#/components/schemas/FeedbackCommentAttribute" + clientToken: + $ref: "#/components/schemas/IdempotentClientToken" + required: + - complianceInquiryId + - rating + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutComplianceInquiryFeedbackResponse" components: parameters: X-Amz-Content-Sha256: @@ -250,6 +486,154 @@ components: schema: type: string schemas: + InquiryName: + type: string + InquiryContent: + description: Content for creating a compliance inquiry - either a single query or file content. + type: object + properties: + query: + $ref: "#/components/schemas/LongStringAttribute" + description: Single text query for AI-generated answer. + fileContent: + $ref: "#/components/schemas/InquiryFileContent" + description: File content with multiple questions. + LongStringAttribute: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[^<>]*" + InquiryFileContent: + description: File content structure for compliance inquiry uploads. + type: object + properties: + fileSections: + $ref: "#/components/schemas/InquiryFileContentFileSectionsList" + description: List of file sections/sheets to process. + content: + $ref: "#/components/schemas/Blob" + description: Binary content of the uploaded file. + required: + - content + InquiryFileContentFileSectionsList: + type: array + items: + $ref: "#/components/schemas/ShortStringAttribute" + ShortStringAttribute: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9_\\-\\s]*" + Blob: + type: string + format: byte + IdempotentClientToken: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\w\\-]+" + InquirySupportMode: + type: string + enum: + - AI_ONLY + - FULL_SUPPORT + TagsMap: + description: A map of tag keys to tag values. + type: object + properties: {} + CreateComplianceInquiryResponse: + type: object + properties: + complianceInquirySummary: + $ref: "#/components/schemas/InquirySummary" + description: Summary information about the created compliance inquiry. + tags: + type: object + properties: {} + description: Tags associated with the compliance inquiry resource. + InquirySummary: + description: Summary information about a compliance inquiry. + type: object + properties: + arn: + $ref: "#/components/schemas/String" + description: ARN of the compliance inquiry resource. + name: + $ref: "#/components/schemas/String" + description: Title of the inquiry. + id: + $ref: "#/components/schemas/InquiryId" + description: Unique resource ID for the compliance inquiry. + status: + $ref: "#/components/schemas/InquiryStatus" + description: Current processing status of the inquiry. + statusMessage: + $ref: "#/components/schemas/InquiryStatusMessage" + description: Status message providing additional context. + inputSource: + $ref: "#/components/schemas/InputSource" + description: Type of inquiry content (text or file). + createdAt: + $ref: "#/components/schemas/TimestampAttribute" + description: Timestamp indicating when the resource was created. + required: + - arn + - name + - id + - status + - statusMessage + - inputSource + - createdAt + String: + type: string + InquiryId: + type: string + pattern: compliance-inquiry-[a-zA-Z0-9]{16} + InquiryStatus: + type: string + enum: + - PROCESSING + - HUMAN_REVIEW + - COMPLETED + - FAILED + InquiryStatusMessage: + type: string + enum: + - Compliance inquiry processing is complete. + - Malware was detected on the file. Provide a new file and try again. + - Compliance inquiry processing is in-progress. + - An internal error occurred while processing the inquiry. Try again at a later time. + - Human review is in progress. + - Compliance inquiry processing is complete. One or more queries encountered errors during processing. + InputSource: + type: string + enum: + - TEXT + - FILE + TimestampAttribute: + type: string + format: date-time + QueryIdentifiersList: + type: array + items: + $ref: "#/components/schemas/Integer" + Integer: + type: integer + Boolean: + type: boolean + ExportComplianceInquiryResponse: + type: object + properties: + documentPresignedUrl: + $ref: "#/components/schemas/PresignedUrl" + description: Presigned S3 URL to access the exported compliance inquiry report. + tags: + type: object + properties: {} + description: Tags associated with the compliance inquiry resource. + PresignedUrl: + description: A pre-signed URL for accessing content. + type: string GetAccountSettingsResponse: type: object properties: @@ -267,6 +651,55 @@ components: enum: - SUBSCRIBED - NOT_SUBSCRIBED + GetComplianceInquiryMetadataResponse: + type: object + properties: + complianceInquiryDetail: + $ref: "#/components/schemas/InquiryDetail" + description: Detailed information about the compliance inquiry. + tags: + type: object + properties: {} + description: Tags associated with the compliance inquiry resource. + InquiryDetail: + description: Detailed information about a compliance inquiry. + type: object + properties: + arn: + $ref: "#/components/schemas/String" + description: ARN of the compliance inquiry resource. + name: + $ref: "#/components/schemas/String" + description: Title of the inquiry. + id: + $ref: "#/components/schemas/InquiryId" + description: Unique resource ID for the compliance inquiry. + status: + $ref: "#/components/schemas/InquiryStatus" + description: Current processing status of the inquiry. + statusMessage: + $ref: "#/components/schemas/InquiryStatusMessage" + description: Status message providing additional context. + inputSource: + $ref: "#/components/schemas/InputSource" + description: Type of inquiry content (text or file). + createdAt: + $ref: "#/components/schemas/TimestampAttribute" + description: Timestamp indicating when the resource was created. + updatedAt: + $ref: "#/components/schemas/TimestampAttribute" + description: Timestamp indicating when the resource was last modified. + supportMode: + $ref: "#/components/schemas/InquirySupportMode" + description: Support mode for this inquiry. AI_ONLY provides AI-generated responses. FULL_SUPPORT includes human expert review. + required: + - arn + - name + - id + - status + - statusMessage + - inputSource + - createdAt ReportId: type: string pattern: report-[a-zA-Z0-9]{16} @@ -274,11 +707,6 @@ components: type: integer format: int64 minimum: 1 - ShortStringAttribute: - type: string - minLength: 1 - maxLength: 256 - pattern: "[a-zA-Z0-9_\\-\\s]*" GetReportResponse: type: object properties: @@ -359,14 +787,6 @@ components: statusMessage: $ref: "#/components/schemas/StatusMessage" description: The message associated with the current upload state. - LongStringAttribute: - type: string - minLength: 1 - maxLength: 1024 - pattern: "[^<>]*" - TimestampAttribute: - type: string - format: date-time PublishedState: type: string enum: @@ -403,8 +823,6 @@ components: type: string minLength: 1 maxLength: 10240 - String: - type: string MaxResultsAttribute: type: integer minimum: 1 @@ -413,6 +831,122 @@ components: type: string minLength: 1 maxLength: 2048 + ListComplianceInquiriesResponse: + type: object + properties: + complianceInquiries: + $ref: "#/components/schemas/InquiriesList" + description: List of compliance inquiry resources. + nextToken: + $ref: "#/components/schemas/NextTokenAttribute" + description: Pagination token to request the next page of resources. + InquiriesList: + type: array + items: + $ref: "#/components/schemas/InquirySummary" + ListComplianceInquiryQueriesResponse: + type: object + properties: + queries: + $ref: "#/components/schemas/QueriesList" + description: List of compliance query summaries. + nextToken: + $ref: "#/components/schemas/NextTokenAttribute" + description: Pagination token to request the next page of resources. + QueriesList: + type: array + items: + $ref: "#/components/schemas/QuerySummary" + QuerySummary: + description: Summary information about a single query within a compliance inquiry. + type: object + properties: + queryIdentifier: + $ref: "#/components/schemas/Integer" + description: Sequential identifier of the query within the inquiry. + query: + $ref: "#/components/schemas/LongStringAttribute" + description: The actual query text. + response: + $ref: "#/components/schemas/LongStringAttribute" + description: Generated response to the query. + reviewType: + $ref: "#/components/schemas/ReviewType" + description: Type of review for the response. + citations: + $ref: "#/components/schemas/CitationList" + description: Supporting citations for the response. + status: + $ref: "#/components/schemas/QueryStatus" + description: Current processing status of the query. + statusMessage: + $ref: "#/components/schemas/QueryStatusMessage" + description: Descriptive status message. + createdAt: + $ref: "#/components/schemas/TimestampAttribute" + description: Timestamp when the query was created. + updatedResponseVersions: + $ref: "#/components/schemas/ResponseVersionList" + description: Ordered list of response version history entries, oldest first. + required: + - queryIdentifier + - query + - status + - statusMessage + - createdAt + ReviewType: + type: string + enum: + - HUMAN + - AI + CitationList: + type: array + items: + $ref: "#/components/schemas/Citation" + Citation: + description: Citation information for AI-generated responses. + type: object + properties: + sourceLabel: + $ref: "#/components/schemas/ShortStringAttribute" + description: Label identifying the compliance source. + sourceContent: + $ref: "#/components/schemas/LongStringAttribute" + description: Content text from the compliance source. + sourceLink: + $ref: "#/components/schemas/LongStringAttribute" + description: Link to the compliance source. + QueryStatus: + type: string + enum: + - PROCESSING + - COMPLETED + - FAILED + QueryStatusMessage: + type: string + enum: + - Query processing is complete. + - Query processing is in-progress. + - An internal error occurred while processing the query. Try again at a later time. + - Query is pending human review. + - Query contains restricted or unsupported content. + ResponseVersionList: + type: array + items: + $ref: "#/components/schemas/ResponseVersion" + ResponseVersion: + description: A versioned snapshot of a response edit. + type: object + properties: + responseText: + $ref: "#/components/schemas/LongStringAttribute" + description: The response text for this version. + timestamp: + $ref: "#/components/schemas/TimestampAttribute" + description: ISO 8601 timestamp of when this edit was made. + required: + - responseText + - timestamp ListCustomerAgreementsResponse: type: object properties: @@ -563,12 +1097,126 @@ components: nextToken: $ref: "#/components/schemas/NextTokenAttribute" description: Pagination token to request the next page of resources. + ListTagsForResourceResponse: + type: object + properties: + tags: + type: object + properties: {} + description: Tags associated with the resource. PutAccountSettingsResponse: type: object properties: accountSettings: $ref: "#/components/schemas/AccountSettings" + FeedbackRating: + type: string + enum: + - THUMBS_UP + - THUMBS_DOWN + FeedbackReasonCodeList: + type: array + items: + $ref: "#/components/schemas/FeedbackReasonCode" + FeedbackReasonCode: + type: string + enum: + - OTHER + - PARTIAL_RESPONSE + - IRRELEVANT_RESPONSE + FeedbackCommentAttribute: + type: string + minLength: 1 + maxLength: 1000 + pattern: "[a-zA-Z0-9\\s.,;:!?'\\-()/@#&+=]+" + PutComplianceInquiryFeedbackResponse: + type: object + properties: + submittedAt: + $ref: "#/components/schemas/TimestampAttribute" + description: The timestamp when the feedback was submitted. + required: + - submittedAt + TagResourceResponse: + type: object + TagKeys: + description: A list of tag keys. + type: array + items: + $ref: "#/components/schemas/TagKey" + TagKey: + description: A tag key. + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9\\s_.:/=+\\-@]*" + UntagResourceResponse: + type: object x-stackQL-resources: + compliance_inquiries: + id: aws.artifact.compliance_inquiries + name: compliance_inquiries + title: compliance_inquiries + methods: + create_compliance_inquiry: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1create/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + export_compliance_inquiry: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1export/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_compliance_inquiries: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1list/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.complianceInquiries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + put_compliance_inquiry_feedback: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1putFeedback/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/compliance_inquiries/methods/list_compliance_inquiries" + insert: + - $ref: "#/components/x-stackQL-resources/compliance_inquiries/methods/create_compliance_inquiry" + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/compliance_inquiries/methods/put_compliance_inquiry_feedback" + delete: [] account_settings: id: aws.artifact.account_settings name: account_settings @@ -600,6 +1248,25 @@ components: replace: - $ref: "#/components/x-stackQL-resources/account_settings/methods/put_account_settings" delete: [] + compliance_inquiry_metadatas: + id: aws.artifact.compliance_inquiry_metadatas + name: compliance_inquiry_metadatas + title: compliance_inquiry_metadatas + methods: + get_compliance_inquiry_metadata: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1getMetadata/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/compliance_inquiry_metadatas/methods/get_compliance_inquiry_metadata" + insert: [] + update: [] + delete: [] reports: id: aws.artifact.reports name: reports @@ -676,6 +1343,34 @@ components: insert: [] update: [] delete: [] + compliance_inquiry_queries: + id: aws.artifact.compliance_inquiry_queries + name: compliance_inquiry_queries + title: compliance_inquiry_queries + methods: + list_compliance_inquiry_queries: + operation: + $ref: "#/paths/~1v1~1compliance-inquiry~1listQueries/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.queries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/compliance_inquiry_queries/methods/list_compliance_inquiry_queries" + insert: [] + update: [] + delete: [] customer_agreements: id: aws.artifact.customer_agreements name: customer_agreements @@ -732,3 +1427,41 @@ components: insert: [] update: [] delete: [] + tags: + id: aws.artifact.tags + name: tags + title: tags + methods: + list_tags_for_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/post" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/auditmanager.yaml b/providers/src/aws/v00.00.00000/services/auditmanager.yaml index 04e83510..05e155a4 100644 --- a/providers/src/aws/v00.00.00000/services/auditmanager.yaml +++ b/providers/src/aws/v00.00.00000/services/auditmanager.yaml @@ -2616,15 +2616,15 @@ components: - Common_Control - Core_Control SourceKeyword: - description: "A keyword that relates to the control data source. For manual evidence, this keyword indicates if the manual evidence is a file or text. For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name. To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide: Config rules supported by Audit Manager Security Hub controls supported by Audit Manager API calls supported by Audit Manager CloudTrail event names supported by Audit Manager" + description: "A keyword that relates to the control data source. For manual evidence, this keyword indicates if the manual evidence is a file or text. For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub CSPM control, or Amazon Web Services API name. To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide: Config rules supported by Audit Manager Security Hub CSPM controls supported by Audit Manager API calls supported by Audit Manager CloudTrail event names supported by Audit Manager" type: object properties: keywordInputType: $ref: "#/components/schemas/KeywordInputType" - description: The input method for the keyword. SELECT_FROM_LIST is used when mapping a data source for automated evidence. When keywordInputType is SELECT_FROM_LIST, a keyword must be selected to collect automated evidence. For example, this keyword can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source for manual evidence. When keywordInputType is UPLOAD_FILE, a file must be uploaded as manual evidence. When keywordInputType is INPUT_TEXT, text must be entered as manual evidence. + description: The input method for the keyword. SELECT_FROM_LIST is used when mapping a data source for automated evidence. When keywordInputType is SELECT_FROM_LIST, a keyword must be selected to collect automated evidence. For example, this keyword can be a CloudTrail event name, a rule name for Config, a Security Hub CSPM control, or the name of an Amazon Web Services API call. UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source for manual evidence. When keywordInputType is UPLOAD_FILE, a file must be uploaded as manual evidence. When keywordInputType is INPUT_TEXT, text must be entered as manual evidence. keywordValue: $ref: "#/components/schemas/KeywordValue" - description: "The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule: For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name. Keyword example for managed rules: Managed rule name: s3-bucket-acl-prohibited keywordValue: S3_BUCKET_ACL_PROHIBITED For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule. Keyword example for custom rules: Custom rule name: my-custom-config-rule keywordValue: Custom_my-custom-config-rule For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name. Keyword examples for service-linked rules: Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue: Custom_CustomRuleForAccount-conformance-pack Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended. Keep in mind the following requirements, depending on the data source type that you're using. For Config: For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules. For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name. For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls. For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls. For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Services service prefix and action names in the Service Authorization Reference." + description: "The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub CSPM control, or the name of an Amazon Web Services API call. If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule: For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name. Keyword example for managed rules: Managed rule name: s3-bucket-acl-prohibited keywordValue: S3_BUCKET_ACL_PROHIBITED For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule. Keyword example for custom rules: Custom rule name: my-custom-config-rule keywordValue: Custom_my-custom-config-rule For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name. Keyword examples for service-linked rules: Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue: Custom_CustomRuleForAccount-conformance-pack Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended. Keep in mind the following requirements, depending on the data source type that you're using. For Config: For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules. For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name. For Security Hub CSPM: The format varies for Security Hub CSPM control names. For accuracy, we recommend that you reference the list of supported Security Hub CSPM controls. For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls. For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Services service prefix and action names in the Service Authorization Reference." KeywordInputType: type: string enum: @@ -2967,7 +2967,7 @@ components: description: The unique identifier for the user or role that's associated with the evidence. complianceCheck: $ref: "#/components/schemas/String" - description: The evaluation status for automated evidence that falls under the compliance check category. Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). + description: The evaluation status for automated evidence that falls under the compliance check category. Audit Manager classes evidence as non-compliant if Security Hub CSPM reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes evidence as compliant if Security Hub CSPM reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub CSPM as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). awsOrganization: $ref: "#/components/schemas/String" description: The Amazon Web Services account that the evidence is collected from, and its organization path. @@ -3008,7 +3008,7 @@ components: description: The value of the resource. complianceCheck: $ref: "#/components/schemas/String" - description: The evaluation status for a resource that was assessed when collecting compliance check evidence. Audit Manager classes the resource as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes the resource as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the resource assessment uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). + description: The evaluation status for a resource that was assessed when collecting compliance check evidence. Audit Manager classes the resource as non-compliant if Security Hub CSPM reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes the resource as compliant if Security Hub CSPM reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub CSPM as the underlying data source type, but those services aren't enabled. This is also the case if the resource assessment uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). GenericArn: type: string minLength: 20 @@ -3090,10 +3090,10 @@ components: description: The number of evidence that falls under the manual category. This evidence is imported manually. evidenceByTypeComplianceCheckCount: $ref: "#/components/schemas/Integer" - description: The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub. + description: The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub CSPM. evidenceByTypeComplianceCheckIssuesCount: $ref: "#/components/schemas/Integer" - description: The total number of issues that were reported directly from Security Hub, Config, or both. + description: The total number of issues that were reported directly from Security Hub CSPM, Config, or both. evidenceByTypeUserActivityCount: $ref: "#/components/schemas/Integer" description: The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs. @@ -3142,13 +3142,13 @@ components: description: The number of active assessments in Audit Manager. noncompliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling. compliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling. inconclusiveEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: "The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data." + description: "The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub CSPM or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data." assessmentControlsCountByNoncompliantEvidence: $ref: "#/components/schemas/NullableInteger" description: The number of assessment controls that collected non-compliant evidence on the lastUpdated date. @@ -3172,13 +3172,13 @@ components: properties: noncompliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling. compliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling. inconclusiveEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data. + description: The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub CSPM or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data. assessmentControlsCountByNoncompliantEvidence: $ref: "#/components/schemas/NullableInteger" description: The number of assessment controls that collected non-compliant evidence on the lastUpdated date. @@ -3388,13 +3388,13 @@ components: properties: noncompliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub CSPM with a Fail ruling, or collected from Config with a Non-compliant ruling. compliantEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. + description: The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub CSPM with a Pass ruling, or collected from Config with a Compliant ruling. inconclusiveEvidenceCount: $ref: "#/components/schemas/NullableInteger" - description: The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data. + description: The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub CSPM or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data. ListAssessmentFrameworkShareRequestsResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/autoscaling.yaml b/providers/src/aws/v00.00.00000/services/autoscaling.yaml index 96800ce0..7705c9fc 100644 --- a/providers/src/aws/v00.00.00000/services/autoscaling.yaml +++ b/providers/src/aws/v00.00.00000/services/autoscaling.yaml @@ -639,6 +639,12 @@ paths: description: The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a Retained state instead of automatic termination. For more information, see Control instance retention with instance lifecycle policies in the Amazon EC2 Auto Scaling User Guide. Instances in a Retained state will continue to incur standard EC2 charges until terminated. schema: $ref: "#/components/schemas/InstanceLifecyclePolicy" + - name: Operator + in: query + required: false + description: The entity that manages the Auto Scaling group. If you specify this parameter, Amazon EC2 Auto Scaling passes the operator identity to EC2 for instance launches and only allows the designated operator to make changes to the Auto Scaling group. All mutating API calls from non-operator callers are rejected with an AccessDenied exception. + schema: + $ref: "#/components/schemas/Operator" responses: "200": description: Success @@ -3578,14 +3584,26 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_TerminateInstanceInAutoScalingGroup - description: Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide. + description: Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instances are not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. To terminate multiple instances in a single call, use the InstanceIds and AutoScalingGroupName parameters instead of InstanceId. When terminating multiple instances, the response populates Activities instead of Activity. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide. parameters: - name: InstanceId in: query - required: true + required: false description: The ID of the instance. schema: $ref: "#/components/schemas/XmlStringMaxLen19" + - name: InstanceIds + in: query + required: false + description: The IDs of the instances. You can specify up to 100 instances. This parameter requires that you also specify AutoScalingGroupName. + schema: + $ref: "#/components/schemas/TerminationInstanceIds" + - name: AutoScalingGroupName + in: query + required: false + description: The name of the Auto Scaling group. Required when using InstanceIds. + schema: + $ref: "#/components/schemas/XmlStringMaxLen255" - name: ShouldDecrementDesiredCapacity in: query required: true @@ -3601,7 +3619,7 @@ paths: $ref: "#/components/schemas/TerminateInstanceInAutoScalingGroupOutputDisplay" post: operationId: POST_TerminateInstanceInAutoScalingGroup - description: Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide. + description: Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instances are not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. To terminate multiple instances in a single call, use the InstanceIds and AutoScalingGroupName parameters instead of InstanceId. When terminating multiple instances, the response populates Activities instead of Activity. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide. responses: "200": description: Success @@ -4725,12 +4743,13 @@ components: properties: CapacityDistributionStrategy: $ref: "#/components/schemas/CapacityDistributionStrategy" - description: If launches fail in an Availability Zone, the following strategies are available. The default is balanced-best-effort. balanced-only - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution. balanced-best-effort - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead. + description: If launches fail in an Availability Zone, the following strategies are available. The default is balanced-best-effort. balanced-only - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution. balanced-best-effort - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead. reservations-then-balanced - Auto Scaling will first attempt to launch into your Capacity Reservations, and then balance any remaining capacity across healthy Availability Zones. CapacityDistributionStrategy: type: string enum: - balanced-only - balanced-best-effort + - reservations-then-balanced AvailabilityZoneImpairmentPolicy: description: Describes an Availability Zone impairment policy. type: object @@ -4802,6 +4821,19 @@ components: enum: - retain - terminate + Operator: + description: Describes the entity that manages an Auto Scaling group. + type: object + properties: + Principal: + $ref: "#/components/schemas/ManagerIdentifier" + description: The service principal that is authorized to manage the Auto Scaling group. When an operator is specified, only the designated operator service principal can make mutating changes to the Auto Scaling group. + required: + - Principal + ManagerIdentifier: + type: string + minLength: 1 + maxLength: 128 CreateAutoScalingGroupType: type: object properties: @@ -4910,6 +4942,9 @@ components: InstanceLifecyclePolicy: $ref: "#/components/schemas/InstanceLifecyclePolicy" description: The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a Retained state instead of automatic termination. For more information, see Control instance retention with instance lifecycle policies in the Amazon EC2 Auto Scaling User Guide. Instances in a Retained state will continue to incur standard EC2 charges until terminated. + Operator: + $ref: "#/components/schemas/Operator" + description: The entity that manages the Auto Scaling group. If you specify this parameter, Amazon EC2 Auto Scaling passes the operator identity to EC2 for instance launches and only allows the designated operator to make changes to the Auto Scaling group. All mutating API calls from non-operator callers are rejected with an AccessDenied exception. required: - AutoScalingGroupName - MinSize @@ -5408,6 +5443,9 @@ components: InstanceLifecyclePolicy: type: string description: The instance lifecycle policy for the Auto Scaling group. + Operator: + type: string + description: The entity that manages the Auto Scaling group, if applicable. When set, only the designated operator can make changes to the group configuration. DescribeAutoScalingGroupsOutputDisplay: type: object properties: @@ -7324,7 +7362,7 @@ components: description: (Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met. MaxHealthyPercentage: $ref: "#/components/schemas/IntPercent100To200" - description: Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200. If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time. If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined. + description: Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200. If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time. If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined. Explicitly setting MaxHealthyPercentage to 100 is not equivalent to omitting it. When MaxHealthyPercentage is explicitly set and it is mathematically impossible to replace instances while honoring both MinHealthyPercentage and MaxHealthyPercentage bounds simultaneously, Auto Scaling launches a new instance before terminating an old one (temporarily exceeding the desired capacity). When MaxHealthyPercentage is omitted, Auto Scaling terminates an instance and launches its replacement simultaneously. This behavioral difference can affect workflows that depend on instance replacement ordering. BakeTime: $ref: "#/components/schemas/BakeTime" description: The amount of time, in seconds, to wait at the end of an instance refresh before the instance refresh is considered complete. @@ -7412,24 +7450,42 @@ components: description: "Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum and maximum healthy percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You can also choose to enable additional features, such as the following: Auto rollback Checkpoints CloudWatch alarms Skip matching Bake time" required: - AutoScalingGroupName + TerminationInstanceIds: + type: array + items: + $ref: "#/components/schemas/XmlStringMaxLen19" + ActivityTypeDisplay: + type: object + properties: + Activity: + type: string + description: A scaling activity. + Activities: + type: string + description: The scaling activities related to terminating the instances from the Auto Scaling group. TerminateInstanceInAutoScalingGroupOutputDisplay: type: object properties: line_items: type: array items: - $ref: "#/components/schemas/ActivityDisplay" + $ref: "#/components/schemas/ActivityTypeDisplay" TerminateInstanceInAutoScalingGroupType: type: object properties: InstanceId: $ref: "#/components/schemas/XmlStringMaxLen19" description: The ID of the instance. + InstanceIds: + $ref: "#/components/schemas/TerminationInstanceIds" + description: The IDs of the instances. You can specify up to 100 instances. This parameter requires that you also specify AutoScalingGroupName. + AutoScalingGroupName: + $ref: "#/components/schemas/XmlStringMaxLen255" + description: The name of the Auto Scaling group. Required when using InstanceIds. ShouldDecrementDesiredCapacity: $ref: "#/components/schemas/ShouldDecrementDesiredCapacity" description: Indicates whether terminating the instance also decrements the size of the Auto Scaling group. required: - - InstanceId - ShouldDecrementDesiredCapacity UpdatePlacementGroupParam: type: string @@ -7903,8 +7959,8 @@ components: replace: - $ref: "#/components/x-stackQL-resources/auto_scaling_groups/methods/put_scheduled_update_group_action" delete: - - $ref: "#/components/x-stackQL-resources/auto_scaling_groups/methods/terminate_instance_in_auto_scaling_group" - $ref: "#/components/x-stackQL-resources/auto_scaling_groups/methods/delete_auto_scaling_group" + - $ref: "#/components/x-stackQL-resources/auto_scaling_groups/methods/terminate_instance_in_auto_scaling_group" load_balancer_target_groups: id: aws.autoscaling.load_balancer_target_groups name: load_balancer_target_groups diff --git a/providers/src/aws/v00.00.00000/services/backup.yaml b/providers/src/aws/v00.00.00000/services/backup.yaml index 11ea1728..459c6964 100644 --- a/providers/src/aws/v00.00.00000/services/backup.yaml +++ b/providers/src/aws/v00.00.00000/services/backup.yaml @@ -74,6 +74,37 @@ paths: application/json: schema: $ref: "#/components/schemas/CancelLegalHoldOutput" + /backup-access-point/create: + put: + operationId: CreateBackupAccessPoint + description: Creates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point, without initiating a restore. While a backup access point is active for a recovery point, Backup pauses lifecycle transitions and blocks deletion of that recovery point. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + AccessPointMetadata: + $ref: "#/components/schemas/AccessPointMetadataMap" + AccessPointPolicy: + $ref: "#/components/schemas/AccessPointPolicy" + Name: + $ref: "#/components/schemas/AccessPointName" + RecoveryPointArn: + $ref: "#/components/schemas/RecoveryPointArn" + Tags: + $ref: "#/components/schemas/TagMap" + required: + - RecoveryPointArn + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateBackupAccessPointResponse" /backup/plans/: put: operationId: CreateBackupPlan @@ -628,6 +659,20 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateTieringConfigurationOutput" + /backup-access-point/delete/{access_point_arn}: + delete: + operationId: DeleteBackupAccessPoint + description: Deletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other backup access points remain for the recovery point, resumes lifecycle transitions for that recovery point. Always delete backup access points using this operation rather than deleting the underlying Amazon S3 access point directly. + parameters: + - name: access_point_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AccessPointArn" + description: The Amazon Resource Name (ARN) of the backup access point to delete. + responses: + "204": + description: Success /backup/plans/{backup_plan_id}: delete: operationId: DeleteBackupPlan @@ -1272,6 +1317,24 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateTieringConfigurationOutput" + /backup-access-point/{access_point_arn}: + get: + operationId: DescribeBackupAccessPoint + description: Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point. After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data. + parameters: + - name: access_point_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AccessPointArn" + description: The Amazon Resource Name (ARN) of the backup access point to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeBackupAccessPointResponse" /backup-jobs/{backup_job_id}: get: operationId: DescribeBackupJob @@ -1621,6 +1684,42 @@ paths: application/json: schema: $ref: "#/components/schemas/GetLegalHoldOutput" + /scan/pitr-malware-scan-results: + get: + operationId: GetPITRMalwareScanResults + description: Returns the malware scan results for a specified point in time within a continuous (point-in-time recovery) backup. + parameters: + - name: RecoveryPointArn + in: query + required: true + schema: + $ref: "#/components/schemas/String" + description: An ARN that uniquely identifies the target recovery point for scanning; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + - name: BackupVaultName + in: query + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. + - name: ScanEndTime + in: query + required: true + schema: + $ref: "#/components/schemas/Timestamp" + description: The point in time within the continuous backup to examine for malware scan results. + - name: MalwareScanner + in: query + required: true + schema: + $ref: "#/components/schemas/MalwareScanner" + description: The scanning engine used for the corresponding scan job. Currently only GUARDDUTY is supported. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetPITRMalwareScanResultsOutput" /backup-vaults/{backup_vault_name}/recovery-points/{recovery_point_arn}/index: get: operationId: GetRecoveryPointIndexDetails @@ -1769,6 +1868,90 @@ paths: application/json: schema: $ref: "#/components/schemas/GetSupportedResourceTypesOutputDisplay" + /backup-access-point: + get: + operationId: ListBackupAccessPoints + description: Returns a list of the backup access points in your account and Region. + parameters: + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListBackupAccessPointsRequestMaxResultsInteger" + description: The maximum number of items to be returned. + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListBackupAccessPointsResponse" + /backup-access-point/recovery-point/{recovery_point_arn}: + post: + operationId: ListBackupAccessPointsByRecoveryPoint + description: Returns the backup access points associated with the specified recovery point. If you own the recovery point and have shared it with other accounts, the response includes backup access points created by those accounts. + parameters: + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListBackupAccessPointsByRecoveryPointRequestMaxResultsInteger" + description: The maximum number of items to be returned. + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + - name: recovery_point_arn + in: path + required: true + schema: + $ref: "#/components/schemas/RecoveryPointArn" + description: The Amazon Resource Name (ARN) of the recovery point whose backup access points you want to list. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListBackupAccessPointsByRecoveryPointResponse" + /backup-access-point/resource/{resource_arn}: + post: + operationId: ListBackupAccessPointsByResource + description: Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket. + parameters: + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListBackupAccessPointsByResourceRequestMaxResultsInteger" + description: The maximum number of items to be returned. + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the resource whose backup access points you want to list. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListBackupAccessPointsByResourceResponse" /audit/backup-job-summaries: get: operationId: ListBackupJobSummaries @@ -2210,7 +2393,7 @@ paths: /resources/: get: operationId: ListProtectedResources - description: Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. + description: Returns an array of resources with recovery points created by Backup (regardless of the recovery point's status), including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. parameters: - name: nextToken in: query @@ -2397,7 +2580,7 @@ paths: required: false schema: $ref: "#/components/schemas/boolean" - description: "This attribute filters recovery points based on ownership. If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup. If this is set to FALSE, the response will contain all recovery points associated with the selected resource. Type: Boolean" + description: "This attribute filters recovery points based on ownership. If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup. If this is set to FALSE, the response will contain all recovery points associated with the selected resource, except for EBS snapshots copied within the same Region and account. Type: Boolean" responses: "200": description: Success @@ -3064,6 +3247,8 @@ paths: properties: BackupVaultName: $ref: "#/components/schemas/String" + ContinuousScanEndTime: + $ref: "#/components/schemas/Timestamp" IamRoleArn: $ref: "#/components/schemas/String" IdempotencyToken: @@ -3199,6 +3384,49 @@ components: format: int64 CancelLegalHoldOutput: type: object + AccessPointMetadataMap: + type: object + properties: {} + AccessPointPolicy: + type: string + minLength: 1 + maxLength: 200000 + AccessPointName: + type: string + minLength: 3 + maxLength: 50 + pattern: "[\\da-z]{1}[\\da-z-]{1,48}[\\da-z]{1}(?`". Attach this header and retry the original request. To inspect the full credential, base64url-decode the token. + required: + - version + - selectedPaymentId + - paymentCredential + MppPaymentOutputSelectedPaymentIdString: + type: string + minLength: 1 + maxLength: 512 + MppPaymentCredential: + description: "Ready-to-send Authorization: Payment `` value. This is a bearer-like payment credential and must not appear in logs, traces, or error messages." + type: string + minLength: 1 + maxLength: 32768 SearchCriteria: description: Contains search criteria for retrieving memory records. type: object @@ -7823,6 +8772,10 @@ components: type: array items: $ref: "#/components/schemas/Evaluator" + StartBatchEvaluationRequestInsightsList: + type: array + items: + $ref: "#/components/schemas/Insight" EvaluationMetadata: description: Metadata for the evaluation, including session-specific ground truth data. type: object @@ -7854,22 +8807,22 @@ components: required: - sessionId GroundTruthSource: - description: Where to pull ground truth from + description: Where to pull ground truth from. type: object properties: inline: $ref: "#/components/schemas/InlineGroundTruth" - description: Provide ground truth inline + description: Inline ground truth data provided directly in the request. InlineGroundTruth: description: Inline ground truth data containing assertions, expected trajectories, and per-turn expected responses. type: object properties: assertions: $ref: "#/components/schemas/EvaluationContentList" - description: assertions for evaluation, reuses common model EvaluationContentList + description: Assertions for evaluation, reuses common model EvaluationContentList. expectedTrajectory: $ref: "#/components/schemas/EvaluationExpectedTrajectory" - description: expectedTrajectory for evaluation, reuses common model EvaluationExpectedTrajectory + description: The expected tool call sequence for trajectory evaluation. turns: $ref: "#/components/schemas/InlineGroundTruthTurnsList" description: A list of per-turn ground truth data, each containing an input prompt and expected response. @@ -7913,6 +8866,9 @@ components: evaluators: $ref: "#/components/schemas/EvaluatorList" description: The list of evaluators applied during the batch evaluation. + insights: + $ref: "#/components/schemas/InsightList" + description: The list of insight analyses applied during the batch evaluation. status: $ref: "#/components/schemas/BatchEvaluationStatus" description: The status of the batch evaluation. @@ -7922,6 +8878,13 @@ components: outputConfig: $ref: "#/components/schemas/OutputConfig" description: The output configuration specifying where evaluation results are written. + tags: + type: object + properties: {} + description: The tags associated with the batch evaluation. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The ARN of the KMS key used to encrypt evaluation data. description: $ref: "#/components/schemas/BatchEvaluationDescription" description: The description of the batch evaluation. @@ -8216,6 +9179,8 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal get_memory_record: operation: $ref: "#/paths/~1memories~1{memory_id}~1memoryRecord~1{memory_record_id}/get" @@ -8223,6 +9188,8 @@ components: openAPIDocKey: "200" mediaType: application/json objectKey: $.memoryRecord + request: + nativeCasing: pascal list_memory_records: operation: $ref: "#/paths/~1memories~1{memory_id}~1memoryRecords/post" @@ -8595,6 +9562,66 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/batch_evaluations/methods/delete_batch_evaluation" + sessions: + id: aws.bedrock_agentcore.sessions + name: sessions + title: sessions + methods: + delete_capacity_provider_session: + operation: + $ref: "#/paths/~1capacity-providers~1{capacity_provider_id}~1sessions~1{session_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + list_sessions: + operation: + $ref: "#/paths/~1memories~1{memory_id}~1actor~1{actor_id}~1sessions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.sessionSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + save_browser_session_profile: + operation: + $ref: "#/paths/~1browser-profiles~1{profile_identifier}~1save/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_browser_stream: + operation: + $ref: "#/paths/~1browsers~1{browser_identifier}~1sessions~1streams~1update/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/sessions/methods/list_sessions" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/sessions/methods/update_browser_stream" + delete: + - $ref: "#/components/x-stackQL-resources/sessions/methods/delete_capacity_provider_session" recommendations: id: aws.bedrock_agentcore.recommendations name: recommendations @@ -8933,59 +9960,6 @@ components: insert: [] update: [] delete: [] - sessions: - id: aws.bedrock_agentcore.sessions - name: sessions - title: sessions - methods: - list_sessions: - operation: - $ref: "#/paths/~1memories~1{memory_id}~1actor~1{actor_id}~1sessions/post" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.sessionSummaries - request: - nativeCasing: pascal - config: - pagination: - requestToken: - key: nextToken - location: body - responseToken: - key: $.nextToken - location: body - requestBodyTranslate: - algorithm: naive - save_browser_session_profile: - operation: - $ref: "#/paths/~1browser-profiles~1{profile_identifier}~1save/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - update_browser_stream: - operation: - $ref: "#/paths/~1browsers~1{browser_identifier}~1sessions~1streams~1update/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/sessions/methods/list_sessions" - insert: [] - update: - - $ref: "#/components/x-stackQL-resources/sessions/methods/update_browser_stream" - delete: [] registry_records: id: aws.bedrock_agentcore.registry_records name: registry_records diff --git a/providers/src/aws/v00.00.00000/services/bedrock_agentcore_control.yaml b/providers/src/aws/v00.00.00000/services/bedrock_agentcore_control.yaml index 7feb766a..f6e7f2a9 100644 --- a/providers/src/aws/v00.00.00000/services/bedrock_agentcore_control.yaml +++ b/providers/src/aws/v00.00.00000/services/bedrock_agentcore_control.yaml @@ -16,6 +16,68 @@ servers: description: AWS region description: Regional endpoint for bedrock-agentcore-control paths: + /datasets/{dataset_id}/examples/add: + post: + operationId: AddDatasetExamples + description: Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics). + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset to add examples to. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + source: + $ref: "#/components/schemas/DataSourceType" + required: + - source + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AddDatasetExamplesResponse" + /gateways/{gateway_identifier}/rate-limits/batch: + put: + operationId: BatchPutGatewayRateLimits + description: Atomically creates or updates multiple rate limits for a gateway. The operation updates existing limits with matching keys and creates new limits for new keys. If the operation fails, the service applies no changes. Retry the request after resolving the issue. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + rateLimits: + $ref: "#/components/schemas/BatchPutLimitEntries" + required: + - rateLimits + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchPutGatewayRateLimitsResponse" /runtimes/: put: operationId: CreateAgentRuntime @@ -52,13 +114,14 @@ paths: $ref: "#/components/schemas/EnvironmentVariablesMap" filesystemConfigurations: $ref: "#/components/schemas/FilesystemConfigurations" + capacityProviderConfiguration: + $ref: "#/components/schemas/CapacityProviderConfiguration" tags: $ref: "#/components/schemas/TagsMap" required: - agentRuntimeName - agentRuntimeArtifact - roleArn - - networkConfiguration responses: "202": description: Success @@ -170,12 +233,15 @@ paths: name: $ref: "#/components/schemas/CredentialProviderName" apiKey: - $ref: "#/components/schemas/ApiKeyType" + $ref: "#/components/schemas/DefaultApiKeyType" + apiKeySecretConfig: + $ref: "#/components/schemas/SecretReference" + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" tags: $ref: "#/components/schemas/TagsMap" required: - name - - apiKey responses: "201": description: Success @@ -211,6 +277,8 @@ paths: $ref: "#/components/schemas/BrowserEnterprisePolicies" certificates: $ref: "#/components/schemas/Certificates" + filesystemConfigurations: + $ref: "#/components/schemas/ToolsFileSystemConfigurations" clientToken: $ref: "#/components/schemas/ClientToken" tags: @@ -315,6 +383,64 @@ paths: application/json: schema: $ref: "#/components/schemas/ListBrowserProfilesResponse" + /capacity-providers: + put: + operationId: CreateCapacityProvider + description: Creates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance types, networking, and storage. It also specifies the IAM permissions that AgentCore uses to manage those instances. The capacity provider name must be unique within your account. After you create the capacity provider, it enters a CREATING state and transitions to READY when it is available for use. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/CapacityProviderName" + description: + $ref: "#/components/schemas/Description" + permissionsConfiguration: + $ref: "#/components/schemas/PermissionsConfiguration" + clientToken: + $ref: "#/components/schemas/ClientToken" + tags: + $ref: "#/components/schemas/TagsMap" + computeConfiguration: + $ref: "#/components/schemas/ComputeConfiguration" + required: + - name + - permissionsConfiguration + - computeConfiguration + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCapacityProviderOutput" + post: + operationId: ListCapacityProviders + description: Lists the capacity providers in your account and returns summary information for each one. To retrieve the full configuration for a specific capacity provider, use GetCapacityProvider. Results are paginated; use the nextToken parameter to retrieve additional results. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + 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. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + 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. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListCapacityProvidersOutput" /code-interpreters: put: operationId: CreateCodeInterpreter @@ -337,6 +463,8 @@ paths: $ref: "#/components/schemas/CodeInterpreterNetworkConfiguration" certificates: $ref: "#/components/schemas/Certificates" + filesystemConfigurations: + $ref: "#/components/schemas/ToolsFileSystemConfigurations" clientToken: $ref: "#/components/schemas/ClientToken" tags: @@ -406,6 +534,8 @@ paths: $ref: "#/components/schemas/CreateConfigurationBundleRequestCommitMessageString" createdBy: $ref: "#/components/schemas/VersionCreatedBySource" + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" tags: $ref: "#/components/schemas/TagsMap" required: @@ -418,6 +548,122 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateConfigurationBundleResponse" + /datasets: + post: + operationId: CreateDataset + description: Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + datasetName: + $ref: "#/components/schemas/DatasetName" + description: + $ref: "#/components/schemas/CreateDatasetRequestDescriptionString" + source: + $ref: "#/components/schemas/DataSourceType" + schemaType: + $ref: "#/components/schemas/DatasetSchemaType" + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - datasetName + - source + - schemaType + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatasetResponse" + get: + operationId: ListDatasets + description: Lists all datasets in the caller's account, paginated. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListDatasetsRequestNextTokenString" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListDatasetsRequestMaxResultsInteger" + description: The maximum number of datasets to return per page. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDatasetsResponse" + /datasets/{dataset_id}/versions: + post: + operationId: CreateDatasetVersion + description: Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset to publish a version for. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatasetVersionResponse" + get: + operationId: ListDatasetVersions + description: Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListDatasetVersionsRequestMaxResultsInteger" + description: The maximum number of versions to return per page. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDatasetVersionsResponse" /evaluators/create: post: operationId: CreateEvaluator @@ -527,6 +773,73 @@ paths: application/json: schema: $ref: "#/components/schemas/ListGatewaysResponse" + /gateways/{gateway_identifier}/rate-limits: + post: + operationId: CreateGatewayRateLimit + description: Creates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent connections through the gateway. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway to create the rate limit for. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + entries: + $ref: "#/components/schemas/LimitEntries" + required: + - dimensionKeys + - entries + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateGatewayRateLimitResponse" + get: + operationId: ListGatewayRateLimits + description: Lists all rate limits for a gateway. Results are paginated. Use the nextToken parameter to retrieve additional results. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/GatewayRateLimitMaxResults" + 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. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/GatewayRateLimitNextToken" + description: The token to use to retrieve the next page of results. Use the value returned in a previous ListGatewayRateLimits response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListGatewayRateLimitsResponse" /gateways/{gateway_identifier}/rules: post: operationId: CreateGatewayRule @@ -627,7 +940,6 @@ paths: privateEndpoint: $ref: "#/components/schemas/PrivateEndpoint" required: - - name - targetConfiguration responses: "202": @@ -668,7 +980,7 @@ paths: /harnesses: post: operationId: CreateHarness - description: Operation to create a Harness. + description: Operation to create a harness. parameters: [] requestBody: required: true @@ -725,7 +1037,7 @@ paths: $ref: "#/components/schemas/CreateHarnessResponse" get: operationId: ListHarnesses - description: Operation to list Harnesses. + description: Operation to list harnesses. parameters: - name: maxResults in: query @@ -746,11 +1058,17 @@ paths: application/json: schema: $ref: "#/components/schemas/ListHarnessesResponse" - /memories/create: + /harnesses/{harness_id}/endpoints: post: - operationId: CreateMemory - description: Creates a new Amazon Bedrock AgentCore Memory resource. - parameters: [] + operationId: CreateHarnessEndpoint + description: Operation to create a harness endpoint. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness to create an endpoint for. requestBody: required: true content: @@ -758,37 +1076,99 @@ paths: schema: type: object properties: - clientToken: - $ref: "#/components/schemas/CreateMemoryInputClientTokenString" - name: - $ref: "#/components/schemas/Name" + endpointName: + $ref: "#/components/schemas/HarnessEndpointName" + targetVersion: + $ref: "#/components/schemas/HarnessVersion" description: - $ref: "#/components/schemas/Description" - encryptionKeyArn: - $ref: "#/components/schemas/Arn" - memoryExecutionRoleArn: - $ref: "#/components/schemas/Arn" - eventExpiryDuration: - $ref: "#/components/schemas/CreateMemoryInputEventExpiryDurationInteger" - memoryStrategies: - $ref: "#/components/schemas/MemoryStrategyInputList" - indexedKeys: - $ref: "#/components/schemas/IndexedKeysList" - streamDeliveryResources: - $ref: "#/components/schemas/StreamDeliveryResources" + $ref: "#/components/schemas/HarnessEndpointDescription" + clientToken: + $ref: "#/components/schemas/ClientToken" tags: $ref: "#/components/schemas/TagsMap" required: - - name - - eventExpiryDuration + - endpointName responses: - "202": + "201": description: Success content: application/json: schema: - $ref: "#/components/schemas/CreateMemoryOutput" - /identities/CreateOauth2CredentialProvider: + $ref: "#/components/schemas/CreateHarnessEndpointResponse" + get: + operationId: ListHarnessEndpoints + description: Operation to list the endpoints of a harness. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness whose endpoints are listed. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListHarnessEndpointsResponse" + /memories/create: + post: + operationId: CreateMemory + description: Creates a new Amazon Bedrock AgentCore Memory resource. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/CreateMemoryInputClientTokenString" + name: + $ref: "#/components/schemas/Name" + description: + $ref: "#/components/schemas/Description" + encryptionKeyArn: + $ref: "#/components/schemas/Arn" + memoryExecutionRoleArn: + $ref: "#/components/schemas/Arn" + eventExpiryDuration: + $ref: "#/components/schemas/CreateMemoryInputEventExpiryDurationInteger" + memoryStrategies: + $ref: "#/components/schemas/MemoryStrategyInputList" + indexedKeys: + $ref: "#/components/schemas/IndexedKeysList" + namespaceKeys: + $ref: "#/components/schemas/NamespaceKeysList" + streamDeliveryResources: + $ref: "#/components/schemas/StreamDeliveryResources" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - name + - eventExpiryDuration + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateMemoryOutput" + /identities/CreateOauth2CredentialProvider: post: operationId: CreateOauth2CredentialProvider description: Creates a new OAuth2 credential provider. @@ -843,6 +1223,10 @@ paths: $ref: "#/components/schemas/DataSourceConfig" evaluators: $ref: "#/components/schemas/EvaluatorList" + insights: + $ref: "#/components/schemas/InsightList" + clusteringConfig: + $ref: "#/components/schemas/ClusteringConfig" evaluationExecutionRoleArn: $ref: "#/components/schemas/RoleArn" enableOnCreate: @@ -853,7 +1237,6 @@ paths: - onlineEvaluationConfigName - rule - dataSourceConfig - - evaluators - evaluationExecutionRoleArn - enableOnCreate responses: @@ -889,6 +1272,8 @@ paths: $ref: "#/components/schemas/PaymentConnectorType" credentialProviderConfigurations: $ref: "#/components/schemas/CredentialsProviderConfigurations" + provisionMode: + $ref: "#/components/schemas/PaymentConnectorProvisionMode" clientToken: $ref: "#/components/schemas/ClientToken" required: @@ -959,6 +1344,8 @@ paths: $ref: "#/components/schemas/ClientToken" tags: $ref: "#/components/schemas/TagsMap" + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" required: - name - authorizerType @@ -973,7 +1360,7 @@ paths: /policy-engines/{policy_engine_id}/policies: post: operationId: CreatePolicy - description: Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion. + description: Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion. If the new policy is a temporal policy, creating it invalidates the policy engine's active temporal sessions. For more information about temporal policy sessions, see session-based temporal policies. The policy engine returns an HTTP 409 ConflictException to in-flight sessions. To resume, you must start a new session with a new session ID. parameters: - name: policy_engine_id in: path @@ -996,6 +1383,8 @@ paths: $ref: "#/components/schemas/Description" validationMode: $ref: "#/components/schemas/PolicyValidationMode" + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" clientToken: $ref: "#/components/schemas/ClientToken" required: @@ -1286,7 +1675,7 @@ paths: /runtimes/{agent_runtime_id}/: delete: operationId: DeleteAgentRuntime - description: Deletes an Amazon Bedrock AgentCore Runtime. + description: Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier. parameters: - name: agent_runtime_id in: path @@ -1294,6 +1683,12 @@ paths: schema: $ref: "#/components/schemas/AgentRuntimeId" description: The unique identifier of the AgentCore Runtime to delete. + - name: version + in: query + required: false + schema: + $ref: "#/components/schemas/AgentRuntimeVersion" + description: The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted. - name: clientToken in: query required: false @@ -1369,12 +1764,13 @@ paths: $ref: "#/components/schemas/EnvironmentVariablesMap" filesystemConfigurations: $ref: "#/components/schemas/FilesystemConfigurations" + capacityProviderConfiguration: + $ref: "#/components/schemas/CapacityProviderConfiguration" clientToken: $ref: "#/components/schemas/ClientToken" required: - agentRuntimeArtifact - roleArn - - networkConfiguration responses: "202": description: Success @@ -1385,7 +1781,7 @@ paths: /runtimes/{agent_runtime_id}/runtime-endpoints/{endpoint_name}/: delete: operationId: DeleteAgentRuntimeEndpoint - description: Deletes an AAgentCore Runtime endpoint. + description: Deletes an AgentCore Runtime endpoint. parameters: - name: agent_runtime_id in: path @@ -1576,6 +1972,75 @@ paths: application/json: schema: $ref: "#/components/schemas/GetBrowserProfileResponse" + /capacity-providers/{capacity_provider_id}: + delete: + operationId: DeleteCapacityProvider + description: Deletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references remain, the operation fails. + parameters: + - name: capacity_provider_id + in: path + required: true + schema: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider to delete. + - name: clientToken + in: query + required: false + schema: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteCapacityProviderOutput" + get: + operationId: GetCapacityProvider + description: Retrieves information about a capacity provider, including its status, permissions configuration, and compute configuration. + parameters: + - name: capacity_provider_id + in: path + required: true + schema: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCapacityProviderOutput" + put: + operationId: UpdateCapacityProvider + description: Updates a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new capacity provider. + parameters: + - name: capacity_provider_id + in: path + required: true + schema: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + description: + $ref: "#/components/schemas/UpdatedDescription" + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateCapacityProviderOutput" /code-interpreters/{code_interpreter_id}: delete: operationId: DeleteCodeInterpreter @@ -1691,6 +2156,8 @@ paths: $ref: "#/components/schemas/UpdateConfigurationBundleRequestCommitMessageString" createdBy: $ref: "#/components/schemas/VersionCreatedBySource" + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" responses: "200": description: Success @@ -1698,6 +2165,112 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateConfigurationBundleResponse" + /datasets/{dataset_id}: + delete: + operationId: DeleteDataset + description: Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset to delete. + - name: datasetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/DatasetVersion" + description: Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDatasetResponse" + get: + operationId: GetDataset + description: Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset to retrieve. + - name: datasetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/DatasetVersion" + description: 'Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.' + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDatasetResponse" + put: + operationId: UpdateDataset + description: Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + description: + $ref: "#/components/schemas/UpdateDatasetRequestDescriptionString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatasetResponse" + /datasets/{dataset_id}/examples/delete: + post: + operationId: DeleteDatasetExamples + description: Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics). + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + exampleIds: + $ref: "#/components/schemas/DeleteDatasetExamplesRequestExampleIdsList" + required: + - exampleIds + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDatasetExamplesResponse" /evaluators/{evaluator_id}: delete: operationId: DeleteEvaluator @@ -1841,12 +2414,16 @@ paths: $ref: "#/components/schemas/AuthorizerConfiguration" kmsKeyArn: $ref: "#/components/schemas/KmsKeyArn" + customTransformConfiguration: + $ref: "#/components/schemas/CustomTransformConfiguration" interceptorConfigurations: $ref: "#/components/schemas/GatewayInterceptorConfigurations" policyEngineConfiguration: $ref: "#/components/schemas/GatewayPolicyEngineConfiguration" exceptionLevel: $ref: "#/components/schemas/ExceptionLevel" + wafConfiguration: + $ref: "#/components/schemas/WafConfiguration" required: - name - roleArn @@ -1858,119 +2435,202 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateGatewayResponse" - /gateways/{gateway_identifier}/rules/{rule_id}: + /gateways/{gateway_identifier}/rate-limits/{rate_limit_id}: delete: - operationId: DeleteGatewayRule - description: Deletes a gateway rule. + operationId: DeleteGatewayRateLimit + description: Deletes a gateway rate limit. parameters: - name: gateway_identifier in: path required: true schema: $ref: "#/components/schemas/GatewayIdentifier" - description: The identifier of the gateway containing the rule. - - name: rule_id + description: The unique identifier of the gateway. + - name: rate_limit_id in: path required: true schema: - $ref: "#/components/schemas/GatewayRuleId" - description: The unique identifier of the rule to delete. + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit to delete. responses: - "202": + "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteGatewayRuleResponse" + $ref: "#/components/schemas/DeleteGatewayRateLimitResponse" get: - operationId: GetGatewayRule - description: Retrieves detailed information about a specific gateway rule. + operationId: GetGatewayRateLimit + description: Retrieves information about a gateway rate limit. parameters: - name: gateway_identifier in: path required: true schema: $ref: "#/components/schemas/GatewayIdentifier" - description: The identifier of the gateway containing the rule. - - name: rule_id + description: The unique identifier of the gateway. + - name: rate_limit_id in: path required: true schema: - $ref: "#/components/schemas/GatewayRuleId" - description: The unique identifier of the rule to retrieve. + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit to retrieve. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/GetGatewayRuleResponse" + $ref: "#/components/schemas/GetGatewayRateLimitResponse" patch: - operationId: UpdateGatewayRule - description: Updates a gateway rule's priority, conditions, actions, or description. + operationId: UpdateGatewayRateLimit + description: Updates the entries of a gateway rate limit. The dimension keys are immutable after creation. parameters: - name: gateway_identifier in: path required: true schema: $ref: "#/components/schemas/GatewayIdentifier" - description: The identifier of the gateway containing the rule. - - name: rule_id + description: The unique identifier of the gateway. + - name: rate_limit_id in: path required: true schema: - $ref: "#/components/schemas/GatewayRuleId" - description: The unique identifier of the rule to update. + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit to update. requestBody: - required: false + required: true content: application/json: schema: type: object properties: - priority: - $ref: "#/components/schemas/GatewayRulePriority" - conditions: - $ref: "#/components/schemas/Conditions" - actions: - $ref: "#/components/schemas/Actions" description: - $ref: "#/components/schemas/GatewayRuleDescription" + $ref: "#/components/schemas/GatewayRateLimitDescription" + entries: + $ref: "#/components/schemas/LimitEntries" + required: + - entries responses: - "202": + "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/UpdateGatewayRuleResponse" - /gateways/{gateway_identifier}/targets/{target_id}/: + $ref: "#/components/schemas/UpdateGatewayRateLimitResponse" + /gateways/{gateway_identifier}/rules/{rule_id}: delete: - operationId: DeleteGatewayTarget - description: Deletes a gateway target. You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target. + operationId: DeleteGatewayRule + description: Deletes a gateway rule. parameters: - name: gateway_identifier in: path required: true schema: $ref: "#/components/schemas/GatewayIdentifier" - description: The unique identifier of the gateway associated with the target. - - name: target_id + description: The identifier of the gateway containing the rule. + - name: rule_id in: path required: true schema: - $ref: "#/components/schemas/TargetId" - description: The unique identifier of the gateway target to delete. + $ref: "#/components/schemas/GatewayRuleId" + description: The unique identifier of the rule to delete. responses: "202": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteGatewayTargetResponse" + $ref: "#/components/schemas/DeleteGatewayRuleResponse" get: - operationId: GetGatewayTarget - description: Retrieves information about a specific gateway target. - parameters: + operationId: GetGatewayRule + description: Retrieves detailed information about a specific gateway rule. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The identifier of the gateway containing the rule. + - name: rule_id + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayRuleId" + description: The unique identifier of the rule to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetGatewayRuleResponse" + patch: + operationId: UpdateGatewayRule + description: Updates a gateway rule's priority, conditions, actions, or description. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The identifier of the gateway containing the rule. + - name: rule_id + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayRuleId" + description: The unique identifier of the rule to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + priority: + $ref: "#/components/schemas/GatewayRulePriority" + conditions: + $ref: "#/components/schemas/Conditions" + actions: + $ref: "#/components/schemas/Actions" + description: + $ref: "#/components/schemas/GatewayRuleDescription" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateGatewayRuleResponse" + /gateways/{gateway_identifier}/targets/{target_id}/: + delete: + operationId: DeleteGatewayTarget + description: Deletes a gateway target. You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target. + parameters: + - name: gateway_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway associated with the target. + - name: target_id + in: path + required: true + schema: + $ref: "#/components/schemas/TargetId" + description: The unique identifier of the gateway target to delete. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteGatewayTargetResponse" + get: + operationId: GetGatewayTarget + description: Retrieves information about a specific gateway target. + parameters: - name: gateway_identifier in: path required: true @@ -2026,7 +2686,6 @@ paths: privateEndpoint: $ref: "#/components/schemas/PrivateEndpoint" required: - - name - targetConfiguration responses: "202": @@ -2052,6 +2711,12 @@ paths: schema: $ref: "#/components/schemas/ClientToken" description: A unique, case-sensitive identifier to ensure idempotency of the request. + - name: deleteManagedMemory + in: query + required: false + schema: + $ref: "#/components/schemas/Boolean" + description: "Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource." responses: "200": description: Success @@ -2061,7 +2726,7 @@ paths: $ref: "#/components/schemas/DeleteHarnessResponse" get: operationId: GetHarness - description: Operation to get a single Harness. + description: Operation to get a single harness. parameters: - name: harness_id in: path @@ -2069,6 +2734,12 @@ paths: schema: $ref: "#/components/schemas/HarnessId" description: The ID of the harness to retrieve. + - name: harnessVersion + in: query + required: false + schema: + $ref: "#/components/schemas/HarnessVersion" + description: Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status. responses: "200": description: Success @@ -2078,7 +2749,7 @@ paths: $ref: "#/components/schemas/GetHarnessResponse" patch: operationId: UpdateHarness - description: Operation to update a Harness. + description: Operation to update a harness. parameters: - name: harness_id in: path @@ -2132,6 +2803,95 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateHarnessResponse" + /harnesses/{harness_id}/endpoints/{endpoint_name}: + delete: + operationId: DeleteHarnessEndpoint + description: Operation to delete a harness endpoint. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness that the endpoint belongs to. + - name: endpoint_name + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessEndpointName" + description: The name of the endpoint to delete. + - name: clientToken + in: query + required: false + schema: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier to ensure idempotency of the request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteHarnessEndpointResponse" + get: + operationId: GetHarnessEndpoint + description: Operation to get a single harness endpoint. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness that the endpoint belongs to. + - name: endpoint_name + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessEndpointName" + description: The name of the endpoint to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetHarnessEndpointResponse" + patch: + operationId: UpdateHarnessEndpoint + description: Operation to update a harness endpoint. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness that the endpoint belongs to. + - name: endpoint_name + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessEndpointName" + description: The name of the endpoint to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + targetVersion: + $ref: "#/components/schemas/HarnessVersion" + description: + $ref: "#/components/schemas/HarnessEndpointDescription" + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateHarnessEndpointResponse" /memories/{memory_id}/delete: delete: operationId: DeleteMemory @@ -2241,6 +3001,10 @@ paths: $ref: "#/components/schemas/DataSourceConfig" evaluators: $ref: "#/components/schemas/EvaluatorList" + insights: + $ref: "#/components/schemas/InsightList" + clusteringConfig: + $ref: "#/components/schemas/ClusteringConfig" evaluationExecutionRoleArn: $ref: "#/components/schemas/RoleArn" executionStatus: @@ -2434,6 +3198,8 @@ paths: $ref: "#/components/schemas/RoleArn" clientToken: $ref: "#/components/schemas/ClientToken" + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" responses: "202": description: Success @@ -2490,7 +3256,7 @@ paths: $ref: "#/components/schemas/GetPolicyResponse" patch: operationId: UpdatePolicy - description: Updates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion. + description: Updates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion. If the updated policy is a temporal policy, the policy engine invalidates all active temporal sessions. If the update adds or removes temporal operators, the policy engine also invalidates active temporal sessions. For more information about temporal policy sessions, see session-based temporal policies. The policy engine returns an HTTP 409 ConflictException to in-flight sessions. To resume, you must start a new session with a new session ID. parameters: - name: policy_engine_id in: path @@ -2517,6 +3283,8 @@ paths: $ref: "#/components/schemas/PolicyDefinition" validationMode: $ref: "#/components/schemas/PolicyValidationMode" + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" responses: "202": description: Success @@ -3112,6 +3880,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAgentRuntimeVersionsResponse" + /capacity-providers/{capacity_provider_id}/runtime-versions: + post: + operationId: ListAgentRuntimeVersionsByCapacityProvider + description: Lists the agent runtime versions that are associated with a capacity provider. Use this operation to identify the runtimes you must disassociate before you can delete the capacity provider. Results are paginated; use the nextToken parameter to retrieve additional results. + parameters: + - name: capacity_provider_id + in: path + required: true + schema: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + 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. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + 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. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentRuntimeVersionsByCapacityProviderOutput" /identities/ListApiKeyCredentialProviders: post: operationId: ListApiKeyCredentialProviders @@ -3198,6 +3996,42 @@ paths: application/json: schema: $ref: "#/components/schemas/ListConfigurationBundlesResponse" + /datasets/{dataset_id}/examples: + get: + operationId: ListDatasetExamples + description: Returns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + - name: datasetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/DatasetVersion" + description: 'Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent. Only used on the first request; for subsequent pages, the version is extracted from the pagination token.' + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListDatasetExamplesRequestMaxResultsInteger" + description: Maximum number of examples to return per page. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListDatasetExamplesRequestNextTokenString" + description: The token for the next page of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDatasetExamplesOutputDisplay" /evaluators: post: operationId: ListEvaluators @@ -3222,6 +4056,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListEvaluatorsResponse" + /harnesses/{harness_id}/versions: + get: + operationId: ListHarnessVersions + description: Operation to list the versions of a Harness. + parameters: + - name: harness_id + in: path + required: true + schema: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness whose versions are listed. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListHarnessVersionsResponse" /memories/: post: operationId: ListMemories @@ -3746,10 +4610,13 @@ paths: name: $ref: "#/components/schemas/CredentialProviderName" apiKey: - $ref: "#/components/schemas/ApiKeyType" + $ref: "#/components/schemas/DefaultApiKeyType" + apiKeySecretConfig: + $ref: "#/components/schemas/SecretReference" + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" required: - name - - apiKey responses: "200": description: Success @@ -3757,6 +4624,37 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateApiKeyCredentialProviderResponse" + /datasets/{dataset_id}/examples/update: + post: + operationId: UpdateDatasetExamples + description: Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics). + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + examples: + $ref: "#/components/schemas/UpdateDatasetExamplesRequestExamplesList" + required: + - examples + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatasetExamplesResponse" /memories/{memory_id}/update: put: operationId: UpdateMemory @@ -3787,6 +4685,8 @@ paths: $ref: "#/components/schemas/ModifyMemoryStrategies" addIndexedKeys: $ref: "#/components/schemas/IndexedKeysList" + namespaceKeys: + $ref: "#/components/schemas/NamespaceKeysList" streamDeliveryResources: $ref: "#/components/schemas/StreamDeliveryResources" responses: @@ -3962,7 +4862,271 @@ components: schema: type: string schemas: - AgentRuntimeName: + DatasetId: + type: string + pattern: "[a-zA-Z0-9_-]{1,110}" + ClientToken: + type: string + minLength: 33 + maxLength: 256 + pattern: "[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" + DataSourceType: + description: Source of examples to add to the dataset. + type: object + properties: + inlineExamples: + $ref: "#/components/schemas/InlineExamplesSource" + description: Inline examples provided directly in the request body. + s3Source: + $ref: "#/components/schemas/S3Source" + description: Amazon S3 URI pointing to a JSONL file in the customer's bucket. + InlineExamplesSource: + description: Inline examples provided directly in the request body. + type: object + properties: + examples: + $ref: "#/components/schemas/InlineExamplesSourceExamplesList" + description: Examples to add. Each example is assigned an auto-generated UUID. + required: + - examples + InlineExamplesSourceExamplesList: + description: A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type. + type: array + items: + $ref: "#/components/schemas/SensitiveJson" + SensitiveJson: + type: object + S3Source: + description: Amazon S3 location of a JSONL file containing dataset examples. + type: object + properties: + s3Uri: + $ref: "#/components/schemas/S3Uri" + description: Amazon S3 URI of the JSONL file (for example, s3://my-bucket/path/to/examples.jsonl). + required: + - s3Uri + S3Uri: + description: Amazon S3 URI string in the format s3://bucket/key. + type: string + pattern: s3://[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]/.{1,1024} + AddDatasetExamplesResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset. + addedCount: + $ref: "#/components/schemas/Long" + description: The number of examples added. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the examples were added. + exampleIds: + $ref: "#/components/schemas/ExampleIdList" + description: IDs of all added examples (auto-generated UUIDs). + required: + - datasetArn + - datasetId + - status + - addedCount + - updatedAt + - exampleIds + DatasetArn: + type: string + pattern: arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110} + DatasetStatus: + description: Dataset lifecycle and operation status. + type: string + enum: + - CREATING + - UPDATING + - DELETING + - ACTIVE + - CREATE_FAILED + - UPDATE_FAILED + - DELETE_FAILED + Long: + type: integer + format: int64 + Timestamp: + type: string + format: date-time + ExampleIdList: + type: array + items: + $ref: "#/components/schemas/ExampleId" + ExampleId: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9_.:-]+" + GatewayIdentifier: + type: string + pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10} + BatchPutLimitEntries: + type: array + items: + $ref: "#/components/schemas/BatchPutLimitEntry" + BatchPutLimitEntry: + description: A rate limit definition within a batch put request. If you provide a rateLimitId, the service uses it for upsert matching against existing rate limits. + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit. If provided, the service uses it for upsert matching against existing rate limits. + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + description: An optional human-readable description for this rate limit. If not provided, the rate limit is created without a description. + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + description: The ordered list of dimension key names that define the scope of this rate limit. + entries: + $ref: "#/components/schemas/LimitEntries" + description: The list of rule entries that map dimension values to rate configurations. + required: + - dimensionKeys + - entries + GatewayRateLimitId: + description: The limit identifier. Optional on create (the system generates it if not provided by the customer). Always present in responses. + type: string + minLength: 2 + maxLength: 64 + pattern: "[a-zA-Z0-9][a-zA-Z0-9\\-_\\.]{0,62}[a-zA-Z0-9]" + GatewayRateLimitDescription: + description: An optional human-readable description for a gateway limit. + type: string + minLength: 0 + maxLength: 512 + DimensionKeys: + description: An ordered list of dimension key names defining the scope of a limit. + type: array + items: + $ref: "#/components/schemas/DimensionKey" + DimensionKey: + description: "A dimension key specifying the scope dimension for rate limiting. Allowed values: targetName, toolName, qualifiedModelId, or context-path expressions: $.context.iam.principal, $.context.iam.sourceIdentity, $.context.jwt.`` where `` is a JWT claim name (for example, $.context.jwt.sub). Validated server-side to enforce allowed prefixes and patterns." + type: string + minLength: 1 + maxLength: 80 + pattern: (targetName|toolName|qualifiedModelId|\$\.context\.iam\.principal|\$\.context\.iam\.sourceIdentity|\$\.context\.jwt\.[a-zA-Z_][a-zA-Z0-9_\-\.]{0,61}[a-zA-Z0-9_]) + LimitEntries: + description: A list of rule entries within a limit. + type: array + items: + $ref: "#/components/schemas/LimitEntry" + LimitEntry: + description: A single rule entry within a rate limit that maps dimension values to rate configurations. Each entry defines the rate limits for a specific combination of dimension values. + type: object + properties: + dimensions: + type: object + properties: {} + description: A map of dimension names to dimension values for this rule entry. Keys must match the parent rate limit's dimension keys. Values may use * as a wildcard, but only in trailing positions based on the dimension keys ordering. + requests: + $ref: "#/components/schemas/RateConfigs" + description: The request rate limit configuration. Specifies the maximum number of requests allowed per time period. + tokens: + $ref: "#/components/schemas/RateConfigs" + description: The token rate limit configuration. Specifies the maximum number of tokens allowed per time period. + connections: + $ref: "#/components/schemas/RateConfigs" + description: The connection rate limit configuration. Specifies the maximum number of concurrent connections allowed. + required: + - dimensions + RateConfigs: + description: A list of rate configurations for the limit. Currently supports one entry per limit. + type: array + items: + $ref: "#/components/schemas/RateConfig" + RateConfig: + description: Contains the rate configuration for a rate limit metric, specifying the allowed rate and time period. + type: object + properties: + rate: + $ref: "#/components/schemas/RateConfigRateDouble" + description: The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed. + period: + $ref: "#/components/schemas/Period" + description: "The time period for the rate limit. Valid values: second—Measures the rate limit over a one-second window. minute—Measures the rate limit over a one-minute window." + required: + - rate + - period + RateConfigRateDouble: + type: number + format: double + minimum: 0 + maximum: 10000000 + Period: + description: The time period for rate limiting. + type: string + enum: + - second + - minute + BatchPutGatewayRateLimitsResponse: + type: object + properties: + rateLimits: + $ref: "#/components/schemas/GatewayRateLimits" + description: The resulting set of rate limits after the batch operation. + required: + - rateLimits + GatewayRateLimits: + type: array + items: + $ref: "#/components/schemas/GatewayRateLimitDetail" + GatewayRateLimitDetail: + description: Contains detailed information about a gateway rate limit, including its configuration and current status. + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit. + gatewayIdentifier: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + description: The human-readable description of the rate limit. + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + description: The ordered list of dimension key names that define the scope of this rate limit. + entries: + $ref: "#/components/schemas/LimitEntries" + description: The list of rule entries that map dimension values to rate configurations. + status: + $ref: "#/components/schemas/GatewayRateLimitStatus" + description: The current status of the rate limit. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was last updated. + required: + - rateLimitId + - gatewayIdentifier + - dimensionKeys + - entries + - status + - createdAt + - updatedAt + GatewayRateLimitStatus: + description: The status of a gateway limit. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + DateTimestamp: + type: string + format: date-time + AgentRuntimeName: type: string pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" AgentRuntimeArtifact: @@ -4111,11 +5275,6 @@ components: pattern: subnet-[0-9a-zA-Z]{8,17} Boolean: type: boolean - ClientToken: - type: string - minLength: 33 - maxLength: 256 - pattern: "[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" Description: type: string minLength: 1 @@ -4143,6 +5302,10 @@ components: allowedScopes: $ref: "#/components/schemas/AllowedScopesType" description: An array of scopes that are allowed to access the token. + advertisedScopeMapping: + type: object + properties: {} + description: A map that associates each scope in allowedScopes with a corresponding advertised scope value. The advertised scope appears in OAuth protected resource metadata and WWW-Authenticate response headers. Use this parameter when the scope that clients request from your identity provider differs from the scope in the validated token. Each key is a scope from allowedScopes that the service uses for token validation. Each value is the corresponding scope that the service advertises to clients. Scopes without a mapping entry appear unchanged to clients. customClaims: $ref: "#/components/schemas/CustomClaimValidationsType" description: An array of objects that define a custom claim validation name, value, and operation @@ -4151,6 +5314,9 @@ components: privateEndpointOverrides: $ref: "#/components/schemas/PrivateEndpointOverrides" description: The private endpoint overrides for the custom JWT authorizer configuration. + allowedWorkloadConfiguration: + $ref: "#/components/schemas/AllowedWorkloadConfiguration" + description: The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways. required: - discoveryUrl DiscoveryUrl: @@ -4339,6 +5505,42 @@ components: type: string minLength: 1 maxLength: 253 + AllowedWorkloadConfiguration: + description: The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways. + type: object + properties: + hostingEnvironments: + $ref: "#/components/schemas/HostingEnvironmentListType" + description: The list of hosting environments whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway. + workloadIdentities: + $ref: "#/components/schemas/WorkloadIdentityNameListType" + description: The list of workload identities that are allowed to invoke the target. + HostingEnvironmentListType: + type: array + items: + $ref: "#/components/schemas/HostingEnvironment" + HostingEnvironment: + description: A hosting environment whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway. + type: object + properties: + arn: + $ref: "#/components/schemas/BedrockAgentcoreResourceArn" + description: The Amazon Resource Name (ARN) of the hosting environment. + required: + - arn + BedrockAgentcoreResourceArn: + type: string + minLength: 20 + maxLength: 1011 + WorkloadIdentityNameListType: + type: array + items: + $ref: "#/components/schemas/WorkloadIdentityNameType" + WorkloadIdentityNameType: + type: string + minLength: 3 + maxLength: 255 + pattern: "[A-Za-z0-9_.-]+" RequestHeaderConfiguration: description: Configuration for HTTP request headers that will be passed through to the runtime. type: object @@ -4384,11 +5586,11 @@ components: LifecycleConfigurationIdleRuntimeSessionTimeoutInteger: type: integer minimum: 60 - maximum: 28800 + maximum: 1209600 LifecycleConfigurationMaxLifetimeInteger: type: integer minimum: 60 - maximum: 28800 + maximum: 1209600 EnvironmentVariablesMap: type: object properties: {} @@ -4409,6 +5611,9 @@ components: efsAccessPoint: $ref: "#/components/schemas/EfsAccessPointConfiguration" description: Configuration for an Amazon EFS access point to mount into the AgentCore Runtime. + capacityProviderVolume: + $ref: "#/components/schemas/CapacityProviderVolumeConfiguration" + description: Configuration for a capacity provider volume to mount into the AgentCore Runtime. This mounts a persistent volume that is defined on the capacity provider, referenced by its logical name. SessionStorageConfiguration: description: Configuration for a session storage filesystem mounted into the AgentCore Runtime. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations. type: object @@ -4459,6 +5664,37 @@ components: minLength: 0 maxLength: 128 pattern: arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40} + CapacityProviderVolumeConfiguration: + description: Configuration for a capacity provider volume mounted into the AgentCore Runtime. This references a persistent volume by its logical name, as defined in the capacity provider's list of volumes. + type: object + properties: + volumeName: + $ref: "#/components/schemas/CapacityProviderVolumeName" + description: The logical name of the capacity provider volume to mount. This name must match a volume that is defined in the capacity provider's list of volumes. + mountPath: + $ref: "#/components/schemas/MountPath" + description: The mount path for the capacity provider volume inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data). + required: + - volumeName + - mountPath + CapacityProviderVolumeName: + description: The logical name of a capacity provider volume. This name must match a volume that is defined in the capacity provider's list of volumes. + type: string + minLength: 1 + maxLength: 48 + pattern: "[a-zA-Z][a-zA-Z0-9_-]{0,47}" + CapacityProviderConfiguration: + description: Configuration for customer-managed compute capacity for the AgentCore Runtime. A capacity provider runs the AgentCore Runtime on the Instances compute type, using Amazon Web Services managed compute in your account. + type: object + properties: + capacityProviderArn: + $ref: "#/components/schemas/CapacityProviderArn" + description: The Amazon Resource Name (ARN) of the capacity provider to use for the AgentCore Runtime. + required: + - capacityProviderArn + CapacityProviderArn: + type: string + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:capacity-provider/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10} TagsMap: type: object properties: {} @@ -4491,7 +5727,7 @@ components: - status AgentRuntimeArn: type: string - pattern: arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}:([0-9]{0,4}[1-9][0-9]{0,4}) + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10} WorkloadIdentityDetails: description: The information about the workload identity. type: object @@ -4513,9 +5749,6 @@ components: minLength: 1 maxLength: 5 pattern: ([1-9][0-9]{0,4}) - DateTimestamp: - type: string - format: date-time AgentRuntimeStatus: type: string enum: @@ -4564,7 +5797,7 @@ components: - createdAt AgentRuntimeEndpointArn: type: string - pattern: arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agentEndpoint/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12} + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47} AgentRuntimeEndpointStatus: type: string enum: @@ -4579,16 +5812,48 @@ components: minLength: 1 maxLength: 128 pattern: "[a-zA-Z0-9\\-_]+" - ApiKeyType: + DefaultApiKeyType: type: string - minLength: 1 + minLength: 0 maxLength: 65536 + SecretReference: + description: Contains a reference to a secret stored in Amazon Web Services Secrets Manager. + type: object + properties: + secretId: + $ref: "#/components/schemas/SecretIdType" + description: The ID of the Amazon Web Services Secrets Manager secret that stores the secret value. + jsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the secret value from the Amazon Web Services Secrets Manager secret. + required: + - secretId + - jsonKey + SecretIdType: + type: string + minLength: 1 + maxLength: 2048 + SecretJsonKeyType: + type: string + minLength: 1 + maxLength: 128 + SecretSourceType: + type: string + enum: + - MANAGED + - EXTERNAL CreateApiKeyCredentialProviderResponse: type: object properties: apiKeySecretArn: $ref: "#/components/schemas/Secret" description: The Amazon Resource Name (ARN) of the secret containing the API key. + apiKeySecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret. + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the created API key credential provider. @@ -4600,12 +5865,12 @@ components: - name - credentialProviderArn Secret: - description: Contains information about a secret in AWS Secrets Manager. + description: Contains information about a secret in Amazon Web Services Secrets Manager. type: object properties: secretArn: $ref: "#/components/schemas/SecretArn" - description: The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the secret in Amazon Web Services Secrets Manager. required: - secretArn SecretArn: @@ -4697,93 +5962,588 @@ components: description: The location from which to retrieve a certificate. type: object properties: - secretsManager: - $ref: "#/components/schemas/SecretsManagerLocation" - description: The Amazon Web Services Secrets Manager location of the certificate. - SecretsManagerLocation: - description: The Amazon Web Services Secrets Manager location configuration. + secretsManager: + $ref: "#/components/schemas/SecretsManagerLocation" + description: The Amazon Web Services Secrets Manager location of the certificate. + SecretsManagerLocation: + description: The Amazon Web Services Secrets Manager location configuration. + type: object + properties: + secretArn: + $ref: "#/components/schemas/ToolSecretArn" + description: The ARN of the Amazon Web Services Secrets Manager secret containing the certificate. + required: + - secretArn + ToolSecretArn: + type: string + pattern: arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+ + ToolsFileSystemConfigurations: + description: The file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points. + type: array + items: + $ref: "#/components/schemas/ToolsFileSystemConfiguration" + ToolsFileSystemConfiguration: + description: "Specifies a file system to mount into the session by providing exactly one of the following: s3FilesConfiguration - Mounts an Amazon Simple Storage Service (Amazon S3) Files access point. efsConfiguration - Mounts an Amazon Elastic File System (Amazon EFS) access point." + type: object + properties: + s3FilesConfiguration: + $ref: "#/components/schemas/S3FilesConfiguration" + description: The configuration for mounting your own Amazon Simple Storage Service (Amazon S3) Files access point into the session. + efsConfiguration: + $ref: "#/components/schemas/EfsConfiguration" + description: The configuration for mounting your own Amazon Elastic File System (Amazon EFS) access point into the session. + S3FilesConfiguration: + description: The configuration for mounting an Amazon Simple Storage Service (Amazon S3) Files access point that you own into a session. + type: object + properties: + accessPointArn: + $ref: "#/components/schemas/S3FilesAccessPointArn" + description: The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files access point to mount. + mountPath: + $ref: "#/components/schemas/MountPath" + description: The absolute path within the session at which the access point is mounted, for example /mnt/s3data. Each mount path must be unique across all file system configurations in the session. + fileSystemArn: + $ref: "#/components/schemas/S3FilesFileSystemArn" + description: The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files file system that owns the access point. + required: + - accessPointArn + - mountPath + - fileSystemArn + S3FilesFileSystemArn: + description: The Amazon Resource Name (ARN) of an Amazon Simple Storage Service (Amazon S3) Files file system. The access points you specify must belong to this file system. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws[-a-z]*:s3files:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{17,40} + EfsConfiguration: + description: The configuration for mounting an Amazon Elastic File System (Amazon EFS) access point that you own into a session. + type: object + properties: + accessPointArn: + $ref: "#/components/schemas/EfsAccessPointArn" + description: The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) access point to mount. + mountPath: + $ref: "#/components/schemas/MountPath" + description: The absolute path within the session at which the access point is mounted, for example /mnt/efs. Each mount path must be unique across all file system configurations in the session. + fileSystemArn: + $ref: "#/components/schemas/EfsFileSystemArn" + description: The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) file system that owns the access point. + required: + - accessPointArn + - mountPath + - fileSystemArn + EfsFileSystemArn: + description: The Amazon Resource Name (ARN) of an Amazon Elastic File System (Amazon EFS) file system. The access points you specify must belong to this file system. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws[-a-z]*:elasticfilesystem:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40} + CreateBrowserResponse: + type: object + properties: + browserId: + $ref: "#/components/schemas/BrowserId" + description: The unique identifier of the created browser. + browserArn: + $ref: "#/components/schemas/BrowserArn" + description: The Amazon Resource Name (ARN) of the created browser. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the browser was created. + status: + $ref: "#/components/schemas/BrowserStatus" + description: The current status of the browser. + required: + - browserId + - browserArn + - createdAt + - status + BrowserId: + type: string + pattern: (aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) + BrowserArn: + type: string + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) + BrowserStatus: + type: string + enum: + - CREATING + - CREATE_FAILED + - READY + - DELETING + - DELETE_FAILED + - DELETED + BrowserProfileName: + type: string + pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" + CreateBrowserProfileResponse: + type: object + properties: + profileId: + $ref: "#/components/schemas/BrowserProfileId" + description: The unique identifier of the created browser profile. + profileArn: + $ref: "#/components/schemas/BrowserProfileArn" + description: The Amazon Resource Name (ARN) of the created browser profile. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the browser profile was created. + status: + $ref: "#/components/schemas/BrowserProfileStatus" + description: The current status of the browser profile. + required: + - profileId + - profileArn + - createdAt + - status + BrowserProfileId: + type: string + pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" + BrowserProfileArn: + type: string + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:browser-profile/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10} + BrowserProfileStatus: + description: The status of a browser profile. + type: string + enum: + - READY + - DELETING + - DELETED + - SAVING + CapacityProviderName: + type: string + minLength: 1 + maxLength: 48 + pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" + PermissionsConfiguration: + description: The permissions configuration for a capacity provider. This specifies the IAM role that AgentCore uses to manage the Amazon EC2 instances for the capacity provider on your behalf. + type: object + properties: + capacityProviderOperatorRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that AgentCore assumes to manage the capacity provider, including launching, tagging, and terminating instances and their network interfaces. We recommend scoping this role to the minimum permissions that your workloads require. + required: + - capacityProviderOperatorRoleArn + ComputeConfiguration: + description: The compute configuration for a capacity provider. This structure defines the type and settings of the compute resources used to launch instances. + type: object + properties: + ec2Configuration: + $ref: "#/components/schemas/Ec2Configuration" + description: The Amazon EC2 compute configuration for the capacity provider. + Ec2Configuration: + description: The configuration for Amazon EC2-based compute, including the launch template source, networking, storage volumes, and instance lifecycle settings. + type: object + properties: + launchTemplateSource: + $ref: "#/components/schemas/LaunchTemplateSource" + description: The source of the launch template configuration that defines how instances are launched. + vpcConfiguration: + $ref: "#/components/schemas/VpcConfiguration" + description: The VPC configuration for launching instances, including subnets and security groups. + volumes: + $ref: "#/components/schemas/VolumeConfigurationList" + description: The named persistent Amazon EBS volumes for the capacity provider. A capacity provider can define up to five volumes. + lifecycleConfiguration: + $ref: "#/components/schemas/InstanceLifecycleConfiguration" + description: The lifecycle configuration for instances in the capacity provider. + rootVolume: + $ref: "#/components/schemas/RootVolumeConfiguration" + description: The configuration for the instance root volume. Specify the amount of free space to guarantee and, optionally, the Amazon EBS performance and encryption settings. The device name and delete-on-termination behavior are not configurable. + required: + - launchTemplateSource + - vpcConfiguration + LaunchTemplateSource: + description: The source of the launch template configuration for a capacity provider. The launchParameters member specifies the operating system, instance requirements, and other settings used to launch instances. + type: object + properties: + launchParameters: + $ref: "#/components/schemas/LaunchParameters" + description: The parameters that AgentCore uses to create the launch template. + LaunchParameters: + description: The parameters for launching Amazon EC2 instances in a capacity provider. + type: object + properties: + operatingSystem: + $ref: "#/components/schemas/OperatingSystem" + description: The operating system and CPU architecture for the instances. + instanceRequirements: + $ref: "#/components/schemas/InstanceRequirements" + description: The requirements that determine which instance types can be launched. + ephemeralVolumes: + $ref: "#/components/schemas/LaunchParametersEphemeralVolumesList" + description: The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings. + monitoring: + $ref: "#/components/schemas/Monitoring" + description: The monitoring level for the instances. + licenseSpecifications: + $ref: "#/components/schemas/LaunchParametersLicenseSpecificationsList" + description: The license configurations to associate with the instances. You can specify up to five configurations. + capacityReservationSpecification: + $ref: "#/components/schemas/CapacityReservationSpecification" + description: The Capacity Reservation targeting option for the instances. + sshKeyName: + $ref: "#/components/schemas/SSHKeyName" + description: The name of the SSH key pair to configure on the instances for SSH connectivity. + instanceProfileArn: + $ref: "#/components/schemas/InstanceProfileArn" + description: The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile. + propagatedTags: + type: object + properties: {} + description: The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates. + required: + - operatingSystem + - instanceRequirements + OperatingSystem: + description: The operating system and CPU architecture for capacity provider instances. + type: string + enum: + - LINUX_X86_64 + - LINUX_ARM64 + InstanceRequirements: + description: The requirements for Amazon EC2 instance types in a capacity provider. + type: object + properties: + allowedInstanceTypes: + $ref: "#/components/schemas/InstanceRequirementsAllowedInstanceTypesList" + description: The list of allowed instance types. You can specify up to 30 instance types. + required: + - allowedInstanceTypes + InstanceRequirementsAllowedInstanceTypesList: + type: array + items: + $ref: "#/components/schemas/EC2InstanceType" + EC2InstanceType: + type: string + minLength: 1 + maxLength: 255 + LaunchParametersEphemeralVolumesList: + type: array + items: + $ref: "#/components/schemas/EphemeralBlockDeviceMapping" + EphemeralBlockDeviceMapping: + description: A block device mapping for an instance store (ephemeral) volume. + type: object + properties: + deviceName: + $ref: "#/components/schemas/DeviceName" + description: The device name, for example /dev/sdh or xvdh. + virtualName: + $ref: "#/components/schemas/VirtualDeviceName" + description: The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. + ebs: + $ref: "#/components/schemas/EphemeralEBSVolumeConfiguration" + DeviceName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9/._-]+" + VirtualDeviceName: + type: string + minLength: 1 + maxLength: 255 + pattern: ephemeral[0-9]+ + EphemeralEBSVolumeConfiguration: + description: The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider. + type: object + properties: + volumeType: + $ref: "#/components/schemas/EbsVolumeType" + description: The Amazon EBS volume type. If you do not specify a type, the default is gp3. + iops: + $ref: "#/components/schemas/VolumeIops" + description: "The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000." + throughput: + $ref: "#/components/schemas/EphemeralEBSVolumeConfigurationThroughputInteger" + description: "The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s." + encrypted: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption. + snapshotId: + $ref: "#/components/schemas/EbsSnapshotId" + description: The ID of the snapshot. + volumeSize: + $ref: "#/components/schemas/EphemeralEBSVolumeConfigurationVolumeSizeInteger" + description: "The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536." + volumeInitializationRate: + $ref: "#/components/schemas/EbsVolumeInitializationRate" + description: "The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s." + ebsCardIndex: + $ref: "#/components/schemas/EbsCardIndex" + description: The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards. + EbsVolumeType: + description: The type of Amazon EBS volume. + type: string + enum: + - standard + - io1 + - io2 + - gp2 + - sc1 + - st1 + - gp3 + VolumeIops: + type: integer + minimum: 100 + maximum: 256000 + EphemeralEBSVolumeConfigurationThroughputInteger: + type: integer + minimum: 125 + maximum: 2000 + KmsKeyId: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} + EbsSnapshotId: + type: string + minLength: 13 + maxLength: 64 + pattern: snap-[a-f0-9]{8,17} + EphemeralEBSVolumeConfigurationVolumeSizeInteger: + type: integer + minimum: 1 + maximum: 65536 + EbsVolumeInitializationRate: + type: integer + minimum: 100 + maximum: 300 + EbsCardIndex: + type: integer + minimum: 0 + Monitoring: + type: string + enum: + - BASIC + - DETAILED + LaunchParametersLicenseSpecificationsList: + type: array + items: + $ref: "#/components/schemas/LicenseSpecification" + LicenseSpecification: + description: A license configuration to associate with the instances. + type: object + properties: + licenseConfigurationArn: + $ref: "#/components/schemas/LicenseConfigurationArn" + description: The Amazon Resource Name (ARN) of the license configuration. + required: + - licenseConfigurationArn + LicenseConfigurationArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:license-manager:[a-z0-9-]+:[0-9]{12}:license-configuration:[a-zA-Z0-9_-]+ + CapacityReservationSpecification: + description: The Capacity Reservation targeting option for the instances. + type: object + properties: + capacityReservationPreference: + $ref: "#/components/schemas/CapacityReservationPreference" + description: The Capacity Reservation preference for the instances. + capacityReservationTarget: + $ref: "#/components/schemas/CapacityReservationTarget" + description: The target Capacity Reservation or Capacity Reservation group for the instances. + CapacityReservationPreference: + type: string + enum: + - capacity-reservations-only + - open + - none + CapacityReservationTarget: + description: Information about the target Capacity Reservation or Capacity Reservation group for the instances. + type: object + properties: + capacityReservationId: + $ref: "#/components/schemas/CapacityReservationId" + description: The ID of the Capacity Reservation in which to run the instances. + capacityReservationResourceGroupArn: + $ref: "#/components/schemas/CapacityReservationResourceGroupArn" + description: The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instances. + CapacityReservationId: + type: string + minLength: 1 + maxLength: 255 + pattern: cr-[0-9a-z]+ + CapacityReservationResourceGroupArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:resource-groups:[a-z0-9-]+:[0-9]{12}:group/[a-zA-Z0-9_-]+ + SSHKeyName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[!-~][ -~]*[!-~]$|^[!-~]" + InstanceProfileArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:instance-profile/([!-~]{1,510}/)?([\w+=,.@-]{1,128}) + VpcConfiguration: + description: The VPC configuration for launching Amazon EC2 instances. + type: object + properties: + subnets: + $ref: "#/components/schemas/VpcConfigurationSubnetsList" + description: The IDs of the subnets in which to launch instances. You must specify at least one subnet. + securityGroups: + $ref: "#/components/schemas/VpcConfigurationSecurityGroupsList" + description: The IDs of the security groups to associate with the instances. You must specify at least one security group. + required: + - subnets + - securityGroups + VpcConfigurationSubnetsList: + type: array + items: + $ref: "#/components/schemas/SubnetId" + VpcConfigurationSecurityGroupsList: + type: array + items: + $ref: "#/components/schemas/SecurityGroupId" + VolumeConfigurationList: + type: array + items: + $ref: "#/components/schemas/VolumeConfiguration" + VolumeConfiguration: + description: The configuration for a persistent volume attached to a capacity provider. This structure defines the storage backing for the persistent volumes used by agents that run on capacity provider instances. + type: object + properties: + ebsConfiguration: + $ref: "#/components/schemas/EbsVolumeConfiguration" + description: The configuration for an Amazon EBS-backed persistent volume. + EbsVolumeConfiguration: + description: The configuration for an Amazon EBS-backed persistent volume. The service creates persistent volumes when a session first launches, and the volumes survive instance termination. The volumes persist until you delete the session. type: object properties: - secretArn: - $ref: "#/components/schemas/ToolSecretArn" - description: The ARN of the Amazon Web Services Secrets Manager secret containing the certificate. + name: + $ref: "#/components/schemas/VolumeName" + description: The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime. + sizeGiB: + $ref: "#/components/schemas/VolumeSizeGiB" + description: The size of the volume, in GiB. + volumeType: + $ref: "#/components/schemas/EbsVolumeType" + description: The Amazon EBS volume type. If you do not specify a type, the default is gp3. + iops: + $ref: "#/components/schemas/VolumeIops" + description: The number of IOPS to provision. Valid only for gp3, io1, and io2 volumes. + throughput: + $ref: "#/components/schemas/VolumeThroughput" + description: The throughput, in MiB/s. Valid only for gp3 volumes. + encrypted: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier of the KMS key to use for encryption. + snapshotId: + $ref: "#/components/schemas/EbsSnapshotId" + description: An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored. required: - - secretArn - ToolSecretArn: + - name + - sizeGiB + VolumeName: type: string - pattern: arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+ - CreateBrowserResponse: + minLength: 1 + maxLength: 48 + pattern: "[a-zA-Z][a-zA-Z0-9_-]{0,47}" + VolumeSizeGiB: + type: integer + minimum: 1 + maximum: 65536 + VolumeThroughput: + type: integer + minimum: 125 + maximum: 2000 + InstanceLifecycleConfiguration: + description: The configuration that manages the lifecycle of instances in a capacity provider, including idle timeout and maximum lifetime. type: object properties: - browserId: - $ref: "#/components/schemas/BrowserId" - description: The unique identifier of the created browser. - browserArn: - $ref: "#/components/schemas/BrowserArn" - description: The Amazon Resource Name (ARN) of the created browser. - createdAt: - $ref: "#/components/schemas/DateTimestamp" - description: The timestamp when the browser was created. - status: - $ref: "#/components/schemas/BrowserStatus" - description: The current status of the browser. - required: - - browserId - - browserArn - - createdAt - - status - BrowserId: - type: string - pattern: (aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) - BrowserArn: - type: string - pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) - BrowserStatus: - type: string - enum: - - CREATING - - CREATE_FAILED - - READY - - DELETING - - DELETE_FAILED - - DELETED - BrowserProfileName: - type: string - pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" - CreateBrowserProfileResponse: + idleInstanceTimeout: + $ref: "#/components/schemas/InstanceLifecycleConfigurationIdleInstanceTimeoutInteger" + description: The number of seconds an instance can remain idle before it is stopped. An instance is considered idle when all of its agents are idle. The default is 900 seconds (15 minutes). + maxLifetime: + $ref: "#/components/schemas/InstanceLifecycleConfigurationMaxLifetimeInteger" + description: The maximum lifetime of an instance, in seconds. When an instance reaches this limit, the service terminates it regardless of activity. The default is 28800 seconds (8 hours). The maximum is 1209600 seconds (14 days). + InstanceLifecycleConfigurationIdleInstanceTimeoutInteger: + type: integer + minimum: 60 + maximum: 1209600 + InstanceLifecycleConfigurationMaxLifetimeInteger: + type: integer + minimum: 60 + maximum: 1209600 + RootVolumeConfiguration: + description: The configuration for the root volume of a capacity provider instance. Specify the amount of free space to guarantee on the root volume. The device name and delete-on-termination settings are fixed and cannot be changed. + type: object + properties: + volumeType: + $ref: "#/components/schemas/EbsVolumeType" + description: The Amazon EBS volume type. If you do not specify a type, the default is gp3. + iops: + $ref: "#/components/schemas/VolumeIops" + description: "The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000." + throughput: + $ref: "#/components/schemas/RootVolumeConfigurationThroughputInteger" + description: "The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s." + encrypted: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption. + freeSpaceGiB: + $ref: "#/components/schemas/RootVolumeConfigurationFreeSpaceGiBInteger" + description: The free space guaranteed on the root volume, in GiB. AgentCore adds the operating system overhead on top of this value. The default is 8 GiB. + RootVolumeConfigurationThroughputInteger: + type: integer + minimum: 125 + maximum: 2000 + RootVolumeConfigurationFreeSpaceGiBInteger: + type: integer + minimum: 2 + maximum: 65000 + CreateCapacityProviderOutput: type: object properties: - profileId: - $ref: "#/components/schemas/BrowserProfileId" - description: The unique identifier of the created browser profile. - profileArn: - $ref: "#/components/schemas/BrowserProfileArn" - description: The Amazon Resource Name (ARN) of the created browser profile. - createdAt: - $ref: "#/components/schemas/DateTimestamp" - description: The timestamp when the browser profile was created. + capacityProviderId: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the created capacity provider. + capacityProviderArn: + $ref: "#/components/schemas/CapacityProviderArn" + description: The Amazon Resource Name (ARN) of the capacity provider. + name: + $ref: "#/components/schemas/CapacityProviderName" + description: The name of the capacity provider. status: - $ref: "#/components/schemas/BrowserProfileStatus" - description: The current status of the browser profile. + $ref: "#/components/schemas/CapacityProviderStatus" + description: The current status of the capacity provider. For possible values, see CapacityProviderStatus. required: - - profileId - - profileArn - - createdAt + - capacityProviderId + - capacityProviderArn + - name - status - BrowserProfileId: + CapacityProviderId: type: string + minLength: 12 + maxLength: 59 pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - BrowserProfileArn: - type: string - pattern: arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:browser-profile/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10} - BrowserProfileStatus: - description: The status of a browser profile. + CapacityProviderStatus: + description: "The status of a capacity provider. Possible values: CREATING – The service is creating the capacity provider and validating its configuration. CREATE_FAILED – The service could not create the capacity provider. For details, see statusCode and statusReason. UPDATING – The service is updating the capacity provider. UPDATE_FAILED – The service could not update the capacity provider. For details, see statusCode and statusReason. READY – The capacity provider is available for use. DELETING – The service is deleting the capacity provider. DELETE_FAILED – The service could not delete the capacity provider. You can retry the deletion." type: string enum: + - CREATING + - CREATE_FAILED + - UPDATING + - UPDATE_FAILED - READY - DELETING - - DELETED - - SAVING + - DELETE_FAILED CodeInterpreterNetworkConfiguration: description: The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network. type: object @@ -4871,6 +6631,11 @@ components: - name String: type: string + KmsKeyArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36} CreateConfigurationBundleResponse: type: object properties: @@ -4893,16 +6658,75 @@ components: - createdAt ConfigurationBundleArn: type: string - pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} + pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} ConfigurationBundleId: type: string pattern: "[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" ConfigurationBundleVersion: type: string pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - Timestamp: + DatasetName: type: string - format: date-time + pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" + CreateDatasetRequestDescriptionString: + type: string + minLength: 0 + maxLength: 200 + DatasetSchemaType: + description: Versioned schema type for dataset examples. Each value identifies both the source format and the version of that format's schema. + type: string + enum: + - AGENTCORE_EVALUATION_PREDEFINED_V1 + - AGENTCORE_EVALUATION_SIMULATED_V1 + - GENERIC_EVALUATION_PREDEFINED_V1 + CreateDatasetResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the created dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the created dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was created. + required: + - datasetArn + - datasetId + - status + - createdAt + CreateDatasetVersionResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: Always UPDATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED. + datasetVersion: + $ref: "#/components/schemas/DatasetVersion" + description: The version number being created. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version creation was initiated. + required: + - datasetArn + - datasetId + - status + - datasetVersion + - createdAt + DatasetVersion: + description: Dataset version identifier. Accepts "DRAFT" or a non-negative integer string representing a published version number. + type: string + pattern: (DRAFT|[0-9]+) CustomEvaluatorName: type: string pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" @@ -4920,6 +6744,9 @@ components: codeBased: $ref: "#/components/schemas/CodeBasedEvaluatorConfig" description: Configuration for a code-based evaluator that uses a customer-managed Lambda function to programmatically assess agent performance. + derived: + $ref: "#/components/schemas/DerivedEvaluatorConfig" + description: The configuration for an evaluator derived from an existing base evaluator (a built-in or third-party evaluator), run on your own model. The base evaluator supplies the prompt and scoring. LlmAsAJudgeEvaluatorConfig: description: The configuration for LLM-as-a-Judge evaluation that uses a language model to assess agent performance based on custom instructions and rating scales. type: object @@ -5006,6 +6833,9 @@ components: bedrockEvaluatorModelConfig: $ref: "#/components/schemas/BedrockEvaluatorModelConfig" description: The Amazon Bedrock model configuration for evaluation. + responsesEvaluatorModelConfig: + $ref: "#/components/schemas/OpenResponsesEvaluatorModelConfig" + description: The OpenResponses model configuration for evaluation. BedrockEvaluatorModelConfig: description: The configuration for using Amazon Bedrock models in evaluator assessments, including model selection and inference parameters. type: object @@ -5061,6 +6891,51 @@ components: minLength: 1 AdditionalModelRequestFields: type: object + OpenResponsesEvaluatorModelConfig: + description: The configuration for using models served through the OpenResponses API in evaluator assessments, including model selection and inference parameters. + type: object + properties: + modelId: + $ref: "#/components/schemas/ModelId" + description: The identifier of the model to use for evaluation. + maxOutputTokens: + $ref: "#/components/schemas/OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger" + description: The maximum number of tokens to generate in the model response, including visible output and reasoning tokens. + temperature: + $ref: "#/components/schemas/OpenResponsesEvaluatorModelConfigTemperatureFloat" + description: The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs. + topP: + $ref: "#/components/schemas/OpenResponsesEvaluatorModelConfigTopPFloat" + description: The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices. + reasoning: + $ref: "#/components/schemas/ReasoningConfiguration" + description: The reasoning configuration for reasoning models. Non-reasoning models ignore this configuration. + required: + - modelId + OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger: + type: integer + minimum: 1 + OpenResponsesEvaluatorModelConfigTemperatureFloat: + type: number + format: float + minimum: 0 + maximum: 2 + OpenResponsesEvaluatorModelConfigTopPFloat: + type: number + format: float + minimum: 0 + maximum: 1 + ReasoningConfiguration: + description: The reasoning configuration that controls how a reasoning model allocates effort during evaluation. + type: object + properties: + effort: + $ref: "#/components/schemas/ReasoningConfigurationEffortString" + description: The level of reasoning effort the model applies when generating a response. For supported values, see the model provider's documentation. + ReasoningConfigurationEffortString: + type: string + minLength: 1 + maxLength: 64 CodeBasedEvaluatorConfig: description: Configuration for a code-based evaluator. Specify the Lambda function to use for evaluation. type: object @@ -5087,17 +6962,30 @@ components: type: integer minimum: 1 maximum: 300 + DerivedEvaluatorConfig: + description: The configuration for a derived evaluator. It reuses an existing evaluator's logic on your own model. + type: object + properties: + baseEvaluatorId: + $ref: "#/components/schemas/EvaluatorId" + description: The identifier of the base evaluator whose logic to run (a Builtin.* or ThirdParty.* evaluator). + modelConfig: + $ref: "#/components/schemas/EvaluatorModelConfig" + description: The configuration of the evaluator model that you supply. + required: + - baseEvaluatorId + - modelConfig + EvaluatorId: + type: string + minLength: 1 + maxLength: 111 + pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}) EvaluatorLevel: type: string enum: - TOOL_CALL - TRACE - SESSION - KmsKeyArn: - type: string - minLength: 1 - maxLength: 2048 - pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36} CreateEvaluatorResponse: type: object properties: @@ -5120,10 +7008,7 @@ components: - status CustomEvaluatorArn: type: string - pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} - EvaluatorId: - type: string - pattern: (Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}) + pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} EvaluatorStatus: type: string enum: @@ -5135,7 +7020,7 @@ components: - DELETING GatewayName: type: string - pattern: ([0-9a-zA-Z][-]?){1,100} + pattern: ([0-9a-zA-Z][-]?){1,48} GatewayDescription: type: string minLength: 1 @@ -5249,7 +7134,7 @@ components: type: string minLength: 1 maxLength: 170 - pattern: arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-]+))? + pattern: arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? GatewayInterceptionPoints: type: array items: @@ -5266,8 +7151,35 @@ components: passRequestHeaders: $ref: "#/components/schemas/Boolean" description: Indicates whether to pass request headers as input into the interceptor. When set to true, request headers will be passed. + payloadFilter: + $ref: "#/components/schemas/InterceptorPayloadFilter" + description: The filter that determines which parts of the request or response payload are passed as input to the interceptor. required: - passRequestHeaders + InterceptorPayloadFilter: + description: The filter that controls which fields of the request or response payload are included in the input to the interceptor. + type: object + properties: + exclude: + $ref: "#/components/schemas/InterceptorPayloadExclusionSelectorList" + description: The list of selectors that identify payload fields to exclude from the interceptor input. + required: + - exclude + InterceptorPayloadExclusionSelectorList: + type: array + items: + $ref: "#/components/schemas/InterceptorPayloadExclusionSelector" + InterceptorPayloadExclusionSelector: + description: A selector that identifies a payload field to exclude from the interceptor input. + type: object + properties: + field: + $ref: "#/components/schemas/InterceptorPayloadExclusion" + description: The field to exclude from the interceptor input. + InterceptorPayloadExclusion: + type: string + enum: + - RESPONSE_BODY GatewayPolicyEngineConfiguration: description: The configuration for a policy engine associated with a gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. type: object @@ -5343,6 +7255,9 @@ components: kmsKeyArn: $ref: "#/components/schemas/KmsKeyArn" description: The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway. + customTransformConfiguration: + $ref: "#/components/schemas/CustomTransformConfiguration" + description: The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses. interceptorConfigurations: $ref: "#/components/schemas/GatewayInterceptorConfigurations" description: The list of interceptor configurations for the created gateway. @@ -5355,6 +7270,12 @@ components: exceptionLevel: $ref: "#/components/schemas/ExceptionLevel" description: The level of detail in error messages returned when invoking the gateway. If the value is DEBUG, granular exception messages are returned to help a user debug the gateway. If the value is omitted, a generic error message is returned to the end user. + webAclArn: + $ref: "#/components/schemas/WebAclArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway. + wafConfiguration: + $ref: "#/components/schemas/WafConfiguration" + description: The Amazon Web Services WAF configuration for the gateway. required: - gatewayArn - gatewayId @@ -5390,9 +7311,73 @@ components: type: string minLength: 0 maxLength: 2048 - GatewayIdentifier: + CustomTransformConfiguration: + description: The configuration for custom transformations applied to requests and responses through the gateway. This structure defines how the gateway transforms data. + type: object + properties: + lambda: + $ref: "#/components/schemas/LambdaTransformConfiguration" + description: The Lambda configuration for custom transformations. This configuration defines how the gateway uses a Lambda function to transform data. + LambdaTransformConfiguration: + description: The Lambda configuration for custom transformations. This structure defines the Lambda function that the gateway invokes to transform data. + type: object + properties: + arn: + $ref: "#/components/schemas/LambdaFunctionArn" + description: The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to transform data. + WebAclArn: type: string - pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10} + minLength: 1 + maxLength: 2048 + pattern: arn:[a-z0-9\-]+:wafv2:[a-z0-9\-]+:[0-9]{12}:regional/webacl/.+ + WafConfiguration: + description: The Amazon Web Services WAF configuration for the gateway. This configuration controls how the gateway behaves when the associated web ACL cannot be evaluated. + type: object + properties: + failureMode: + $ref: "#/components/schemas/WafFailureMode" + description: "The failure mode that determines how the gateway handles requests when Amazon Web Services WAF is unreachable or times out. Valid values include: FAIL_CLOSE - The gateway blocks requests when Amazon Web Services WAF cannot be evaluated. FAIL_OPEN - The gateway allows requests when Amazon Web Services WAF cannot be evaluated." + WafFailureMode: + type: string + enum: + - FAIL_CLOSE + - FAIL_OPEN + CreateGatewayRateLimitResponse: + description: Shared fields for GatewayRateLimit responses. + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the created rate limit. + gatewayIdentifier: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + description: The human-readable description of the rate limit. + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + description: The ordered list of dimension key names that define the scope of this rate limit. + entries: + $ref: "#/components/schemas/LimitEntries" + description: The list of rule entries that map dimension values to rate configurations. + status: + $ref: "#/components/schemas/GatewayRateLimitStatus" + description: The current status of the rate limit. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was last updated. + required: + - rateLimitId + - gatewayIdentifier + - dimensionKeys + - entries + - status + - createdAt + - updatedAt GatewayRulePriority: type: integer minimum: 1 @@ -5728,6 +7713,9 @@ components: http: $ref: "#/components/schemas/HttpTargetConfiguration" description: The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime. + inference: + $ref: "#/components/schemas/InferenceTargetConfiguration" + description: The inference configuration for the target. This configuration routes requests to a large language model (LLM) provider. McpTargetConfiguration: description: The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target. type: object @@ -5747,6 +7735,9 @@ components: apiGateway: $ref: "#/components/schemas/ApiGatewayTargetConfiguration" description: The configuration for an Amazon API Gateway target. + connector: + $ref: "#/components/schemas/ConnectorTargetConfiguration" + description: The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target. ApiSchemaConfiguration: description: Configuration for API schema. type: object @@ -5962,24 +7953,116 @@ components: ApiGatewayToolFilters: type: array items: - $ref: "#/components/schemas/ApiGatewayToolFilter" - ApiGatewayToolFilter: - description: Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification. + $ref: "#/components/schemas/ApiGatewayToolFilter" + ApiGatewayToolFilter: + description: Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification. + type: object + properties: + filterPath: + $ref: "#/components/schemas/String" + description: Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API. + methods: + $ref: "#/components/schemas/RestApiMethods" + description: The methods to filter for. + required: + - filterPath + - methods + RestApiMethods: + type: array + items: + $ref: "#/components/schemas/RestApiMethod" + ConnectorTargetConfiguration: + description: Configuration for a connector integration target. Connectors provide pre-built integrations with Amazon Web Services services and third-party tools. + type: object + properties: + source: + $ref: "#/components/schemas/ConnectorSource" + description: The source configuration identifying which connector to use. + enabled: + $ref: "#/components/schemas/EnabledConnectors" + description: A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled. + configurations: + $ref: "#/components/schemas/ConnectorConfigurations" + description: A list of per-tool configurations for the connector. + required: + - source + ConnectorSource: + description: The source identifying the connector integration. + type: object + properties: + connectorId: + $ref: "#/components/schemas/ConnectorId" + description: The identifier for the connector integration (for example, bedrock-knowledge-bases). + version: + $ref: "#/components/schemas/ConnectorVersion" + description: The version of the connector to use (for example, 1.1.0). If you don't specify a version, the service uses the latest available version. + required: + - connectorId + ConnectorId: + type: string + minLength: 1 + maxLength: 256 + ConnectorVersion: + type: string + minLength: 5 + maxLength: 32 + pattern: (?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*) + EnabledConnectors: + type: array + items: + $ref: "#/components/schemas/String" + ConnectorConfigurations: + type: array + items: + $ref: "#/components/schemas/ConnectorConfiguration" + ConnectorConfiguration: + description: Configuration for a single tool within a connector. + type: object + properties: + name: + $ref: "#/components/schemas/ConnectorConfigurationNameString" + description: The tool or operation name (for example, retrieve or webSearch). + description: + $ref: "#/components/schemas/ConnectorConfigurationDescriptionString" + description: An agent-facing description override for this tool. + parameterValues: + $ref: "#/components/schemas/Document" + description: Parameters to set as fixed or default values when provisioning this tool. + parameterOverrides: + $ref: "#/components/schemas/ConnectorParameterOverrides" + description: Parameters to expose to the agent at runtime, with optional description overrides. + required: + - name + ConnectorConfigurationNameString: + type: string + minLength: 0 + maxLength: 64 + pattern: "[a-zA-Z][a-zA-Z0-9_-]*" + ConnectorConfigurationDescriptionString: + type: string + minLength: 0 + maxLength: 2000 + Document: + type: object + ConnectorParameterOverrides: + type: array + items: + $ref: "#/components/schemas/ConnectorParameterOverride" + ConnectorParameterOverride: + description: Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions. type: object properties: - filterPath: + path: $ref: "#/components/schemas/String" - description: Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API. - methods: - $ref: "#/components/schemas/RestApiMethods" - description: The methods to filter for. + description: A JSON Pointer path identifying the parameter (for example, /numberOfResults or /filter). + description: + $ref: "#/components/schemas/String" + description: An agent-facing description override for this parameter. + visible: + $ref: "#/components/schemas/Boolean" + description: Whether this parameter is visible to the agent. If not specified, uses the service default. required: - - filterPath - - methods - RestApiMethods: - type: array - items: - $ref: "#/components/schemas/RestApiMethod" + - path HttpTargetConfiguration: description: The HTTP target configuration for a gateway target. Contains the configuration for HTTP-based target endpoints. type: object @@ -5987,6 +8070,12 @@ components: agentcoreRuntime: $ref: "#/components/schemas/RuntimeTargetConfiguration" description: The AgentCore Runtime target configuration for HTTP-based communication with an agent runtime. + passthrough: + $ref: "#/components/schemas/PassthroughTargetConfiguration" + description: The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint. + connector: + $ref: "#/components/schemas/HttpConnectorTargetConfiguration" + description: The connector-based configuration for the HTTP target. Use this configuration when you want to route HTTP requests through a managed connector. RuntimeTargetConfiguration: description: Configuration for an AgentCore Runtime target. Specifies the agent runtime to route requests to via HTTP. type: object @@ -5997,6 +8086,9 @@ components: qualifier: $ref: "#/components/schemas/RuntimeQualifier" description: The qualifier for the agent runtime, used to target a specific endpoint version. If not specified, the default endpoint is used. + schema: + $ref: "#/components/schemas/HttpApiSchemaConfiguration" + description: The API schema configuration that defines the structure of the runtime target's API. required: - arn RuntimeArn: @@ -6005,6 +8097,197 @@ components: RuntimeQualifier: type: string pattern: .*([1-9][0-9]{0,4})|([a-zA-Z][a-zA-Z0-9_]{0,47}).* + HttpApiSchemaConfiguration: + description: The API schema configuration for an HTTP target. This schema defines the API structure that the target exposes. + type: object + properties: + source: + $ref: "#/components/schemas/ApiSchemaConfiguration" + required: + - source + PassthroughTargetConfiguration: + description: The configuration for an HTTP passthrough target. A passthrough target forwards requests directly to an external HTTP endpoint. + type: object + properties: + endpoint: + $ref: "#/components/schemas/PassthroughEndpoint" + description: The HTTPS endpoint that the gateway forwards requests to for this passthrough target. + protocolType: + $ref: "#/components/schemas/PassthroughProtocolType" + description: "The application protocol that the passthrough target implements. This value is required for passthrough targets: MCP - The Model Context Protocol. A2A - The Agent-to-Agent protocol. INFERENCE - The protocol for routing requests to a large language model (LLM) provider. CUSTOM - A custom application protocol." + schema: + $ref: "#/components/schemas/HttpApiSchemaConfiguration" + description: The API schema configuration that defines the structure of the passthrough target's API. + stickinessConfiguration: + $ref: "#/components/schemas/StickinessConfiguration" + description: The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target. + required: + - endpoint + - protocolType + PassthroughEndpoint: + type: string + minLength: 1 + maxLength: 2048 + pattern: https://[a-zA-Z0-9\-\.]+(:[0-9]{1,5})?(/.*)? + PassthroughProtocolType: + type: string + enum: + - MCP + - A2A + - INFERENCE + - CUSTOM + StickinessConfiguration: + description: The configuration for session-sticky routing to a target. Session stickiness routes requests that share a session identifier to the same target. + type: object + properties: + identifier: + $ref: "#/components/schemas/StickinessConfigurationIdentifierString" + description: The expression that identifies where to extract the session identifier from the request (for example, $context.header.x-session-id). + timeout: + $ref: "#/components/schemas/StickinessTimeout" + description: The session stickiness timeout, in seconds. After this duration of inactivity, the session affinity expires. Valid values range from 1 to 86400. + required: + - identifier + StickinessConfigurationIdentifierString: + type: string + minLength: 1 + maxLength: 256 + StickinessTimeout: + type: integer + minimum: 1 + maximum: 86400 + HttpConnectorTargetConfiguration: + description: The configuration for an HTTP connector target. Use this configuration when you want to route HTTP requests through a managed connector. + type: object + properties: + source: + $ref: "#/components/schemas/HttpConnectorSource" + description: The source configuration identifying which HTTP connector to use. + parameters: + type: object + properties: {} + description: The resource parameters for this connector (for example, memoryId). The service validates these parameters against the request path at runtime. + required: + - source + HttpConnectorSource: + description: The source identifying the HTTP connector integration. + type: object + properties: + connectorId: + $ref: "#/components/schemas/ConnectorId" + description: The identifier for the HTTP connector integration. + required: + - connectorId + InferenceTargetConfiguration: + description: The configuration for an inference target. An inference target routes requests to a large language model (LLM) provider, either through a built-in connector or an explicitly configured provider. + type: object + properties: + connector: + $ref: "#/components/schemas/InferenceConnectorTargetConfiguration" + description: The connector-based inference configuration. Use this option to route requests to an LLM provider through a built-in connector that includes predefined provider rules. + provider: + $ref: "#/components/schemas/InferenceProviderTargetConfiguration" + description: The provider-based inference configuration. Use this option to explicitly configure the endpoint, model mapping, and operations for an LLM provider. + InferenceConnectorTargetConfiguration: + description: The configuration for a connector-based inference target. This configuration uses a built-in connector that provides predefined rules for a large language model (LLM) provider. + type: object + properties: + source: + $ref: "#/components/schemas/InferenceConnectorSource" + description: The source configuration identifying which inference connector to use. + required: + - source + InferenceConnectorSource: + description: The source identifying the inference connector. + type: object + properties: + connectorId: + $ref: "#/components/schemas/InferenceConnectorId" + description: The identifier for the inference connector (for example, bedrock-mantle, openai, or anthropic). + required: + - connectorId + InferenceConnectorId: + type: string + minLength: 1 + maxLength: 256 + InferenceProviderTargetConfiguration: + description: The configuration for a provider-based inference target. This configuration explicitly defines the endpoint, model mapping, and operations used to route requests to a large language model (LLM) provider. + type: object + properties: + endpoint: + $ref: "#/components/schemas/PassthroughEndpoint" + description: The HTTPS endpoint of the inference provider that the gateway forwards requests to. + modelMapping: + $ref: "#/components/schemas/ModelMapping" + description: The configuration that translates client-facing model IDs to the model IDs expected by the provider. + operations: + $ref: "#/components/schemas/InferenceOperationConfigurations" + description: A list of per-operation configurations that map request paths to the models supported for each operation. + required: + - endpoint + ModelMapping: + description: The configuration that translates model IDs between client-facing names and provider model IDs. + type: object + properties: + providerPrefix: + $ref: "#/components/schemas/ProviderPrefix" + description: The provider prefix configuration used for model ID translation. + ProviderPrefix: + description: The configuration that controls how a provider prefix is applied to model IDs during translation. + type: object + properties: + strip: + $ref: "#/components/schemas/Boolean" + description: Whether clients can omit the provider prefix from model IDs. If true, the gateway accepts model IDs without the prefix and restores the full prefixed form before forwarding to the provider. The default is false. + separator: + $ref: "#/components/schemas/ProviderPrefixSeparatorString" + description: The single character that separates the provider prefix from the model name (for example, .). The default is .. + ProviderPrefixSeparatorString: + type: string + minLength: 1 + maxLength: 1 + InferenceOperationConfigurations: + type: array + items: + $ref: "#/components/schemas/InferenceOperationConfiguration" + InferenceOperationConfiguration: + description: The configuration for a specific inference operation, including its request path and the models that the operation supports. + type: object + properties: + path: + $ref: "#/components/schemas/InferenceOperationPath" + description: The request path for this operation (for example, /v1/messages or /v1/responses). + providerPath: + $ref: "#/components/schemas/InferenceOperationPath" + description: The provider path to forward requests to, if it differs from the request path. For example, /anthropic/v1/messages when the provider expects a different path than the client-facing /v1/messages. + models: + $ref: "#/components/schemas/ModelEntries" + description: The list of models supported for this operation. + required: + - path + InferenceOperationPath: + type: string + minLength: 1 + maxLength: 256 + pattern: /[a-zA-Z0-9\-\._/]+ + ModelEntries: + type: array + items: + $ref: "#/components/schemas/ModelEntry" + ModelEntry: + description: A model entry that specifies a model supported for an inference operation. + type: object + properties: + model: + $ref: "#/components/schemas/ModelPattern" + description: The model ID or glob pattern that identifies the model (for example, anthropic.claude-opus-* or openai.gpt-oss-*). + required: + - model + ModelPattern: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9\\-\\._\\*\\?@]+(/[a-zA-Z0-9\\-\\._\\*\\?@]+)*" CredentialProviderConfigurations: type: array items: @@ -6350,6 +8633,9 @@ components: geminiModelConfig: $ref: "#/components/schemas/HarnessGeminiModelConfig" description: Configuration for a Google Gemini model. + liteLlmModelConfig: + $ref: "#/components/schemas/HarnessLiteLlmModelConfig" + description: The LiteLLM model configuration for connecting to third-party model providers. HarnessBedrockModelConfig: description: Configuration for an Amazon Bedrock model provider. type: object @@ -6366,6 +8652,12 @@ components: topP: $ref: "#/components/schemas/TopP" description: The topP set when calling the model. + apiFormat: + $ref: "#/components/schemas/HarnessBedrockApiFormat" + description: The API format to use when calling the Bedrock provider. + additionalParams: + $ref: "#/components/schemas/Document" + description: Provider-specific parameters passed through to the model provider unchanged. required: - modelId MaxTokens: @@ -6381,6 +8673,12 @@ components: format: float minimum: 0 maximum: 1 + HarnessBedrockApiFormat: + type: string + enum: + - converse_stream + - responses + - chat_completions HarnessOpenAiModelConfig: description: Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity. type: object @@ -6400,12 +8698,23 @@ components: topP: $ref: "#/components/schemas/TopP" description: The topP set when calling the model. + apiFormat: + $ref: "#/components/schemas/HarnessOpenAiApiFormat" + description: The API format to use when calling the OpenAI provider. + additionalParams: + $ref: "#/components/schemas/Document" + description: Provider-specific parameters passed through to the model provider unchanged. required: - modelId - apiKeyArn ApiKeyArn: type: string pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+ + HarnessOpenAiApiFormat: + type: string + enum: + - chat_completions + - responses HarnessGeminiModelConfig: description: Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity. type: object @@ -6428,6 +8737,9 @@ components: topK: $ref: "#/components/schemas/TopK" description: The topK set when calling the model. + additionalParams: + $ref: "#/components/schemas/Document" + description: Provider-specific parameters passed through to the Gemini model provider unchanged. required: - modelId - apiKeyArn @@ -6435,6 +8747,37 @@ components: type: integer minimum: 0 maximum: 500 + HarnessLiteLlmModelConfig: + description: Configuration for a LiteLLM model provider, enabling connection to third-party model providers. + type: object + properties: + modelId: + $ref: "#/components/schemas/ModelId" + description: The LiteLLM model identifier (e.g., "anthropic/claude-3-sonnet"). + apiKeyArn: + $ref: "#/components/schemas/ApiKeyArn" + description: The ARN of the API key in AgentCore Identity for authenticating with the model provider. + apiBase: + $ref: "#/components/schemas/HarnessLiteLlmApiBase" + description: The base URL for the model provider's API endpoint. + maxTokens: + $ref: "#/components/schemas/MaxTokens" + description: The maximum number of tokens to allow in the generated response per iteration. + temperature: + $ref: "#/components/schemas/Temperature" + description: The temperature to set when calling the model. + topP: + $ref: "#/components/schemas/TopP" + description: The topP set when calling the model. + additionalParams: + $ref: "#/components/schemas/Document" + description: Provider-specific parameters passed through to the model provider unchanged. + required: + - modelId + HarnessLiteLlmApiBase: + type: string + minLength: 1 + maxLength: 16383 HarnessSystemPrompt: type: array items: @@ -6522,8 +8865,12 @@ components: type: object properties: browserArn: - $ref: "#/components/schemas/BrowserArn" + $ref: "#/components/schemas/HarnessBrowserArn" description: If not populated, the built-in Browser ARN is used. + HarnessBrowserArn: + description: Browser ARN for Harness tool configuration. Accepts both managed (aws.browser.v1) and custom browser ARNs. + type: string + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) HarnessAgentCoreGatewayConfig: description: Configuration for AgentCore Gateway. type: object @@ -6548,6 +8895,7 @@ components: description: No authentication. oauth: $ref: "#/components/schemas/OAuthCredentialProvider" + description: Use OAuth credentials for outbound authentication to the gateway. Unit: type: object HarnessInlineFunctionConfig: @@ -6567,15 +8915,17 @@ components: type: string minLength: 1 maxLength: 4096 - SensitiveJson: - type: object HarnessAgentCoreCodeInterpreterConfig: description: Configuration for AgentCore Code Interpreter. type: object properties: codeInterpreterArn: - $ref: "#/components/schemas/CodeInterpreterArn" + $ref: "#/components/schemas/HarnessCodeInterpreterArn" description: If not populated, the built-in Code Interpreter ARN is used. + HarnessCodeInterpreterArn: + description: Code Interpreter ARN for Harness tool configuration. Accepts both managed (aws.codeinterpreter.v1) and custom code interpreter ARNs. + type: string + pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) HarnessSkills: type: array items: @@ -6587,9 +8937,81 @@ components: path: $ref: "#/components/schemas/HarnessSkillPath" description: The filesystem path to the skill definition. + s3: + $ref: "#/components/schemas/HarnessSkillS3Source" + description: An S3 source containing the skill. + git: + $ref: "#/components/schemas/HarnessSkillGitSource" + description: A git repository containing the skill. + awsSkills: + $ref: "#/components/schemas/HarnessSkillAwsSkillsSource" + description: AWS Skills baked into the harness's underlying Runtime. HarnessSkillPath: type: string minLength: 1 + maxLength: 4096 + HarnessSkillS3Source: + description: An S3 source for a skill. + type: object + properties: + uri: + $ref: "#/components/schemas/HarnessSkillS3Uri" + description: The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/). + required: + - uri + HarnessSkillS3Uri: + type: string + minLength: 5 + maxLength: 16383 + pattern: s3://.* + HarnessSkillGitSource: + description: A git repository source for a skill. + type: object + properties: + url: + $ref: "#/components/schemas/HarnessSkillGitUrl" + description: The HTTPS URL of the git repository. + path: + $ref: "#/components/schemas/String" + description: Subdirectory within the repository containing the skill. + auth: + $ref: "#/components/schemas/HarnessSkillGitAuth" + description: Authentication configuration for private repositories. + required: + - url + HarnessSkillGitUrl: + type: string + minLength: 8 + maxLength: 16383 + pattern: https://[^#@]+ + HarnessSkillGitAuth: + description: Authentication configuration for accessing a private git repository. + type: object + properties: + credentialArn: + $ref: "#/components/schemas/ApiKeyArn" + description: The ARN of the credential in AgentCore Identity containing the password or personal access token. + username: + $ref: "#/components/schemas/String" + description: Username for authentication. Defaults to 'oauth2' if not specified. + required: + - credentialArn + HarnessSkillAwsSkillsSource: + description: Passed to show that AWS Skills should be included. + type: object + properties: + paths: + $ref: "#/components/schemas/HarnessAwsSkillPaths" + description: Optionally filter allowed skills with glob syntax, e.g., ['core-skills/*']. + HarnessAwsSkillPaths: + type: array + items: + $ref: "#/components/schemas/HarnessAwsSkillPath" + HarnessAwsSkillPath: + type: string + minLength: 1 + maxLength: 4096 + pattern: ([^*?\[\]]|\*)+ HarnessAllowedTools: type: array items: @@ -6606,6 +9028,12 @@ components: agentCoreMemoryConfiguration: $ref: "#/components/schemas/HarnessAgentCoreMemoryConfiguration" description: The AgentCore Memory configuration. + managedMemoryConfiguration: + $ref: "#/components/schemas/HarnessManagedMemoryConfiguration" + description: Harness creates and manages a memory resource in the customer's account. + disabled: + $ref: "#/components/schemas/HarnessDisabledMemoryConfiguration" + description: Explicitly opt out of memory. HarnessAgentCoreMemoryConfiguration: description: Configuration for AgentCore Memory integration. type: object @@ -6630,6 +9058,40 @@ components: pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} Integer: type: integer + HarnessManagedMemoryConfiguration: + description: Configuration for managed memory creation. + type: object + properties: + arn: + $ref: "#/components/schemas/MemoryArn" + description: The ARN of the managed AgentCore Memory resource. Read-only on Get, ignored on Create/Update input. + strategies: + $ref: "#/components/schemas/HarnessManagedMemoryStrategyList" + description: Strategy types to enable. Defaults to [SEMANTIC, SUMMARIZATION]. + eventExpiryDuration: + $ref: "#/components/schemas/HarnessManagedMemoryConfigurationEventExpiryDurationInteger" + description: Event retention in days. Defaults to 30. + encryptionKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: Customer-managed KMS key. Defaults to AWS-owned key. Not updatable after creation. + HarnessManagedMemoryStrategyList: + type: array + items: + $ref: "#/components/schemas/HarnessManagedMemoryStrategyType" + HarnessManagedMemoryStrategyType: + type: string + enum: + - SEMANTIC + - SUMMARIZATION + - USER_PREFERENCE + - EPISODIC + HarnessManagedMemoryConfigurationEventExpiryDurationInteger: + type: integer + minimum: 3 + maximum: 365 + HarnessDisabledMemoryConfiguration: + description: Explicitly opt out of memory. + type: object HarnessTruncationConfiguration: description: Configuration for truncating conversation context when it exceeds model limits. type: object @@ -6690,45 +9152,48 @@ components: required: - harness Harness: - description: Representation of a Harness. + description: Representation of a harness. type: object properties: harnessId: $ref: "#/components/schemas/HarnessId" - description: The ID of the Harness. + description: The ID of the harness. harnessName: $ref: "#/components/schemas/HarnessName" - description: The name of the Harness. + description: The name of the harness. arn: $ref: "#/components/schemas/HarnessArn" - description: The ARN of the Harness. + description: The ARN of the harness. status: $ref: "#/components/schemas/HarnessStatus" - description: The status of the Harness. + description: The status of the harness. + harnessVersion: + $ref: "#/components/schemas/HarnessVersion" + description: The version of the harness. Incremented on every successful UpdateHarness. executionRoleArn: $ref: "#/components/schemas/RoleArn" - description: IAM role the Harness assumes when running. + description: IAM role the harness assumes when running. createdAt: $ref: "#/components/schemas/DateTimestamp" - description: The createdAt time of the Harness. + description: The createdAt time of the harness. updatedAt: $ref: "#/components/schemas/DateTimestamp" - description: The updatedAt time of the Harness. + description: The updatedAt time of the harness. model: $ref: "#/components/schemas/HarnessModelConfiguration" description: The configuration of the default model used by the Harness. systemPrompt: $ref: "#/components/schemas/HarnessSystemPrompt" - description: The system prompt of the Harness. + description: The system prompt of the harness. tools: $ref: "#/components/schemas/HarnessTools" - description: The tools of the Harness. + description: The tools of the harness. skills: $ref: "#/components/schemas/HarnessSkills" - description: The skills of the Harness. + description: The skills of the harness. allowedTools: $ref: "#/components/schemas/HarnessAllowedTools" - description: The allowed tools of the Harness. All tools are allowed by default. + description: The allowed tools of the harness. All tools are allowed by default. truncation: $ref: "#/components/schemas/HarnessTruncationConfiguration" description: Configuration for truncating model context. @@ -6741,7 +9206,7 @@ components: environmentVariables: type: object properties: {} - description: Environment variables exposed in the environment in which the Harness operates. + description: Environment variables exposed in the environment in which the harness operates. authorizerConfiguration: $ref: "#/components/schemas/AuthorizerConfiguration" memory: @@ -6790,6 +9255,11 @@ components: - READY - DELETING - DELETE_FAILED + HarnessVersion: + type: string + minLength: 1 + maxLength: 5 + pattern: ([1-9][0-9]{0,4}) HarnessEnvironmentProvider: description: The environment provider for a harness. type: object @@ -6823,10 +9293,79 @@ components: - agentRuntimeId - lifecycleConfiguration - networkConfiguration - BedrockAgentcoreResourceArn: + HarnessEndpointName: type: string - minLength: 20 - maxLength: 1011 + pattern: "[a-zA-Z][a-zA-Z0-9_]{0,47}" + HarnessEndpointDescription: + type: string + minLength: 1 + maxLength: 256 + CreateHarnessEndpointResponse: + type: object + properties: + endpoint: + $ref: "#/components/schemas/HarnessEndpoint" + description: The endpoint that was created. + required: + - endpoint + HarnessEndpoint: + description: Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked. + type: object + properties: + harnessId: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness that the endpoint belongs to. + harnessName: + $ref: "#/components/schemas/HarnessName" + description: The name of the harness that the endpoint belongs to. + endpointName: + $ref: "#/components/schemas/HarnessEndpointName" + description: The name of the endpoint. + arn: + $ref: "#/components/schemas/HarnessEndpointArn" + description: The ARN of the endpoint. + status: + $ref: "#/components/schemas/HarnessEndpointStatus" + description: The status of the endpoint. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the endpoint was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the endpoint was last updated. + liveVersion: + $ref: "#/components/schemas/HarnessVersion" + description: The harness version that the endpoint is currently serving. + targetVersion: + $ref: "#/components/schemas/HarnessVersion" + description: The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning. + description: + $ref: "#/components/schemas/HarnessEndpointDescription" + description: The description of the endpoint. + failureReason: + $ref: "#/components/schemas/String" + description: The reason the endpoint's last create or update operation failed. + required: + - harnessId + - harnessName + - endpointName + - arn + - status + - createdAt + - updatedAt + HarnessEndpointArn: + type: string + pattern: arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}/harness-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47} + HarnessEndpointStatus: + type: string + enum: + - CREATING + - CREATE_FAILED + - UPDATING + - UPDATE_FAILED + - READY + - DELETING + - DELETE_FAILED CreateMemoryInputClientTokenString: type: string minLength: 0 @@ -6892,7 +9431,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: "[a-zA-Z0-9\\-_\\/]*(\\{(actorId|sessionId|memoryStrategyId)\\}[a-zA-Z0-9\\-_\\/]*)*" + pattern: "[a-zA-Z0-9\\-_\\/]*(\\{[a-zA-Z][a-zA-Z0-9]*\\}[a-zA-Z0-9\\-_\\/]*)*" MemoryRecordSchema: description: Schema for metadata on memory records generated by a strategy. type: object @@ -6914,9 +9453,12 @@ components: type_: $ref: "#/components/schemas/MetadataValueType" description: The MetadataValueType. + extractionType: + $ref: "#/components/schemas/ExtractionType" + description: Specifies whether the metadata value is extracted by the LLM or passed through deterministically from the event. extractionConfig: $ref: "#/components/schemas/ExtractionConfig" - description: Configuration for extracting this metadata value from conversational content. + description: Configuration for extracting this metadata value from conversational content. Applicable only if extractionType is LLM inferred. required: - key MetadataKey: @@ -6930,6 +9472,12 @@ components: - STRING - STRINGLIST - NUMBER + ExtractionType: + description: The extraction type for a metadata field, determining how the value is obtained during memory processing. + type: string + enum: + - LLM_INFERRED + - STRICTLY_CONSISTENT ExtractionConfig: description: Configuration for metadata extraction from conversational content. type: object @@ -7405,6 +9953,50 @@ components: required: - key - type_ + NamespaceKeysList: + type: array + items: + $ref: "#/components/schemas/NamespaceKeyEntry" + NamespaceKeyEntry: + description: A namespace variable key definition with optional NamespaceKeyValidation rules. + type: object + properties: + key: + $ref: "#/components/schemas/NamespaceVariableKey" + description: The namespace variable key name. + validation: + $ref: "#/components/schemas/NamespaceKeyValidation" + description: The validation rules that constrain values for this namespace variable at runtime (CreateEvent API). + required: + - key + NamespaceVariableKey: + type: string + minLength: 1 + maxLength: 32 + pattern: (?!memoryStrategyId$|actorId$|sessionId$)[a-z][a-z0-9]* + NamespaceKeyValidation: + description: The validation rules for namespace variable values. When you specify multiple rules, the service enforces a logical AND across all provided key-value pairs. + type: object + properties: + allowedValues: + $ref: "#/components/schemas/NamespaceAllowedValuesList" + description: The allowed values for this namespace variable key. + regexPattern: + $ref: "#/components/schemas/NamespaceRegexPattern" + description: A regex pattern that the namespace variable key-value must match. + NamespaceAllowedValuesList: + type: array + items: + $ref: "#/components/schemas/NamespaceAllowedValue" + NamespaceAllowedValue: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-z0-9][a-z0-9-_]*" + NamespaceRegexPattern: + type: string + minLength: 1 + maxLength: 64 StreamDeliveryResources: description: Configuration for streaming memory record data to external resources. type: object @@ -7512,9 +10104,15 @@ components: indexedKeys: $ref: "#/components/schemas/IndexedKeysList" description: The indexed metadata keys for this memory. Only indexed keys can be used in metadata filters. + namespaceKeys: + $ref: "#/components/schemas/NamespaceKeysList" + description: The namespace variable key definitions for this memory. Namespace keys define custom variables used in namespaceTemplates with optional validation rules. streamDeliveryResources: $ref: "#/components/schemas/StreamDeliveryResources" description: Configuration for streaming memory record data to external resources. + managedByResourceArn: + $ref: "#/components/schemas/Arn" + description: ARN of the resource managing this memory (e.g. a harness). When set, strategy modifications and deletion are only allowed through the managing resource. required: - arn - id @@ -7538,6 +10136,7 @@ components: - ACTIVE - FAILED - DELETING + - UPDATING MemoryStrategyList: type: array items: @@ -7957,18 +10556,27 @@ components: clientSecret: $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the custom OAuth2 provider. - privateEndpoint: - $ref: "#/components/schemas/PrivateEndpoint" - description: The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration. - privateEndpointOverrides: - $ref: "#/components/schemas/PrivateEndpointOverrides" - description: The private endpoint overrides for the custom OAuth2 provider configuration. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. onBehalfOfTokenExchangeConfig: $ref: "#/components/schemas/OnBehalfOfTokenExchangeConfigType" description: The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants. clientAuthenticationMethod: $ref: "#/components/schemas/ClientAuthenticationMethodType" description: The client authentication method to use when authenticating with the token endpoint. + privateKeyJwtConfig: + $ref: "#/components/schemas/PrivateKeyJwtConfig" + description: The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint. + privateEndpoint: + $ref: "#/components/schemas/PrivateEndpoint" + description: The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration. + privateEndpointOverrides: + $ref: "#/components/schemas/PrivateEndpointOverrides" + description: The private endpoint overrides for the custom OAuth2 provider configuration. required: - oauthDiscovery Oauth2Discovery: @@ -8083,6 +10691,47 @@ components: - CLIENT_SECRET_BASIC - CLIENT_SECRET_POST - AWS_IAM_ID_TOKEN_JWT + - PRIVATE_KEY_JWT + PrivateKeyJwtConfig: + description: The private key configuration for private_key_jwt client authentication. + type: object + properties: + privateKeySource: + $ref: "#/components/schemas/PrivateKeySource" + description: The private key source for the JWT client assertion. + signingAlgorithm: + $ref: "#/components/schemas/SigningAlgorithm" + description: The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256. + additionalHeaderClaims: + type: object + properties: {} + description: A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added. + additionalPayloadClaims: + type: object + properties: {} + description: A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added. + PrivateKeySource: + description: Contains the private key source configuration for a JWT client assertion. + type: object + properties: + kmsKeySource: + $ref: "#/components/schemas/KmsKeySourceType" + description: The KMS key source for the JWT client assertion. + KmsKeySourceType: + description: Contains the KMS key configuration for a JWT client assertion. + type: object + properties: + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to sign the JWT client assertion. The key must be an asymmetric key with key usage SIGN_VERIFY and a key spec compatible with the configured signing algorithm. + required: + - kmsKeyArn + SigningAlgorithm: + type: string + enum: + - RS256 + - PS256 + - ES256 GoogleOauth2ProviderConfigInput: description: Input configuration for a Google OAuth2 provider. type: object @@ -8091,19 +10740,20 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the Google OAuth2 provider. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the Google OAuth2 provider. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret ClientIdType: type: string minLength: 1 maxLength: 256 - ClientSecretType: - type: string - minLength: 1 - maxLength: 2048 GithubOauth2ProviderConfigInput: description: Input configuration for a GitHub OAuth2 provider. type: object @@ -8112,11 +10762,16 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the GitHub OAuth2 provider. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the GitHub OAuth2 provider. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret SlackOauth2ProviderConfigInput: description: Input configuration for a Slack OAuth2 provider. type: object @@ -8125,11 +10780,16 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the Slack OAuth2 provider. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the Slack OAuth2 provider. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret SalesforceOauth2ProviderConfigInput: description: Input configuration for a Salesforce OAuth2 provider. type: object @@ -8138,11 +10798,16 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the Salesforce OAuth2 provider. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the Salesforce OAuth2 provider. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret MicrosoftOauth2ProviderConfigInput: description: Input configuration for a Microsoft OAuth2 provider. type: object @@ -8151,14 +10816,19 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the Microsoft OAuth2 provider. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the Microsoft OAuth2 provider. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. tenantId: $ref: "#/components/schemas/TenantIdType" description: The Microsoft Entra ID (formerly Azure AD) tenant ID for your organization. This identifies the specific tenant within Microsoft's identity platform where your application is registered. required: - clientId - - clientSecret TenantIdType: type: string minLength: 1 @@ -8171,11 +10841,16 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the Atlassian OAuth2 provider. This identifier is assigned by Atlassian when you register your application. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the Atlassian OAuth2 provider. This secret is assigned by Atlassian and used along with the client ID to authenticate your application. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret for the Atlassian OAuth2 provider. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret LinkedinOauth2ProviderConfigInput: description: Configuration settings for connecting to LinkedIn services using OAuth2 authentication. This includes the client credentials required to authenticate with LinkedIn's OAuth2 authorization server. type: object @@ -8184,11 +10859,16 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the LinkedIn OAuth2 provider. This identifier is assigned by LinkedIn when you register your application. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the LinkedIn OAuth2 provider. This secret is assigned by LinkedIn and used along with the client ID to authenticate your application. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. required: - clientId - - clientSecret IncludedOauth2ProviderConfigInput: description: Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support. type: object @@ -8197,8 +10877,14 @@ components: $ref: "#/components/schemas/ClientIdType" description: The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application. clientSecret: - $ref: "#/components/schemas/ClientSecretType" + $ref: "#/components/schemas/DefaultClientSecretType" description: The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application. + clientSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. issuer: $ref: "#/components/schemas/IssuerUrlType" description: Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider. @@ -8210,13 +10896,18 @@ components: description: OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens. required: - clientId - - clientSecret CreateOauth2CredentialProviderResponse: type: object properties: clientSecretArn: $ref: "#/components/schemas/Secret" - description: The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager. + clientSecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the OAuth2 credential provider. @@ -8279,18 +10970,21 @@ components: clientId: $ref: "#/components/schemas/ClientIdType" description: The client ID for the custom OAuth2 provider. - privateEndpoint: - $ref: "#/components/schemas/PrivateEndpoint" - description: The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration. - privateEndpointOverrides: - $ref: "#/components/schemas/PrivateEndpointOverrides" - description: The private endpoint overrides for the custom OAuth2 provider configuration. onBehalfOfTokenExchangeConfig: $ref: "#/components/schemas/OnBehalfOfTokenExchangeConfigType" description: The configuration for on-behalf-of token exchange. clientAuthenticationMethod: $ref: "#/components/schemas/ClientAuthenticationMethodType" description: The client authentication method used when authenticating with the token endpoint. + privateEndpoint: + $ref: "#/components/schemas/PrivateEndpoint" + description: The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration. + privateEndpointOverrides: + $ref: "#/components/schemas/PrivateEndpointOverrides" + description: The private endpoint overrides for the custom OAuth2 provider configuration. + privateKeyJwtConfig: + $ref: "#/components/schemas/PrivateKeyJwtConfig" + description: The configuration for private_key_jwt client authentication used by this OAuth2 credential provider. required: - oauthDiscovery GoogleOauth2ProviderConfigOutput: @@ -8526,8 +11220,6 @@ components: $ref: "#/components/schemas/LogGroupName" LogGroupName: type: string - minLength: 1 - maxLength: 512 pattern: "[.\\-_/#A-Za-z0-9]+" CloudWatchLogsInputConfigServiceNamesList: type: array @@ -8549,6 +11241,42 @@ components: evaluatorId: $ref: "#/components/schemas/EvaluatorId" description: The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators. + InsightList: + type: array + items: + $ref: "#/components/schemas/Insight" + Insight: + description: A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization. + type: object + properties: + insightId: + $ref: "#/components/schemas/InsightId" + description: The unique identifier of the insight to run. + required: + - insightId + InsightId: + description: Canonical insight identifiers using the Builtin.Insight.* naming convention. Used by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows. + type: string + pattern: (Builtin\.[a-zA-Z0-9._-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}) + ClusteringConfig: + description: Configuration for periodic batch evaluation clustering, specifying how often clustering jobs run. + type: object + properties: + frequencies: + $ref: "#/components/schemas/ClusteringFrequencyList" + description: The list of frequencies at which clustering batch evaluations are triggered. + required: + - frequencies + ClusteringFrequencyList: + type: array + items: + $ref: "#/components/schemas/ClusteringFrequency" + ClusteringFrequency: + type: string + enum: + - DAILY + - WEEKLY + - MONTHLY CreateOnlineEvaluationConfigResponse: type: object properties: @@ -8580,7 +11308,7 @@ components: - executionStatus OnlineEvaluationConfigArn: type: string - pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} + pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10} OnlineEvaluationConfigId: type: string pattern: "[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" @@ -8631,7 +11359,7 @@ components: type: string minLength: 1 maxLength: 4096 - pattern: "[a-zA-Z0-9\\s]+" + pattern: "[^\\p{C}]*" PaymentConnectorType: type: string enum: @@ -8665,6 +11393,11 @@ components: minLength: 69 maxLength: 2048 pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b|aws-iso-e|aws-iso-f|aws-eusc):(acps|bedrock-agentcore):[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+ + PaymentConnectorProvisionMode: + type: string + enum: + - MANUAL + - QUICK_CREATE CreatePaymentConnectorResponse: type: object properties: @@ -8689,6 +11422,9 @@ components: status: $ref: "#/components/schemas/PaymentConnectorStatus" description: The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. + authorizationUrl: + $ref: "#/components/schemas/PaymentConnectorAuthorizationUrl" + description: The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION. required: - paymentConnectorId - paymentManagerId @@ -8701,7 +11437,7 @@ components: type: string minLength: 12 maxLength: 211 - pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10} + pattern: ([0-9a-z_][-]?){1,100}-[0-9a-z]{10} PaymentConnectorStatus: type: string enum: @@ -8712,6 +11448,16 @@ components: - CREATE_FAILED - UPDATE_FAILED - DELETE_FAILED + - AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED + - PENDING_AUTHENTICATION + - PROVISIONING + - AUTHENTICATION_EXPIRED + - AUTHENTICATION_FAILED + PaymentConnectorAuthorizationUrl: + type: string + minLength: 1 + maxLength: 4096 + pattern: https://[^\p{C}]* PaymentCredentialProviderVendorType: description: Supported vendor types for payment providers using non-standard auth protocols. type: string @@ -8736,30 +11482,40 @@ components: $ref: "#/components/schemas/CoinbaseCdpApiKeyIdType" description: The API key identifier provided by Coinbase Developer Platform. apiKeySecret: - $ref: "#/components/schemas/CoinbaseCdpApiKeySecretType" + $ref: "#/components/schemas/DefaultCoinbaseCdpApiKeySecretType" description: The API key secret provided by Coinbase Developer Platform. + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the API key secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. + apiKeySecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the API key secret. This includes the secret ID and the JSON key used to extract the API key secret value from the secret. Required when apiKeySecretSource is set to EXTERNAL. walletSecret: - $ref: "#/components/schemas/CoinbaseCdpWalletSecretType" + $ref: "#/components/schemas/DefaultCoinbaseCdpWalletSecretType" description: The wallet secret provided by Coinbase Developer Platform. + walletSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the wallet secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. + walletSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the wallet secret. This includes the secret ID and the JSON key used to extract the wallet secret value from the secret. Required when walletSecretSource is set to EXTERNAL. required: - apiKeyId - - apiKeySecret - - walletSecret CoinbaseCdpApiKeyIdType: type: string minLength: 1 maxLength: 512 pattern: "[a-zA-Z0-9\\-_]+" - CoinbaseCdpApiKeySecretType: + DefaultCoinbaseCdpApiKeySecretType: type: string - minLength: 1 + minLength: 0 maxLength: 2048 - pattern: "[a-zA-Z0-9+/=\\-_\\s]+" - CoinbaseCdpWalletSecretType: + pattern: "[a-zA-Z0-9+/=\\-_\\s]*" + DefaultCoinbaseCdpWalletSecretType: type: string - minLength: 1 + minLength: 0 maxLength: 2048 - pattern: "[a-zA-Z0-9+/=\\-_\\s]+" + pattern: "[a-zA-Z0-9+/=\\-_\\s]*" StripePrivyConfigurationInput: description: Stripe Privy configuration — credentials provided by Stripe and Privy. type: object @@ -8768,34 +11524,44 @@ components: $ref: "#/components/schemas/StripePrivyAppIdType" description: The app ID provided by Privy. appSecret: - $ref: "#/components/schemas/StripePrivyAppSecretType" + $ref: "#/components/schemas/DefaultStripePrivyAppSecretType" description: The app secret provided by Privy. + appSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the app secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. + appSecretConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the app secret. This includes the secret ID and the JSON key used to extract the app secret value from the secret. Required when appSecretSource is set to EXTERNAL. authorizationPrivateKey: - $ref: "#/components/schemas/StripePrivyAuthorizationPrivateKeyType" + $ref: "#/components/schemas/DefaultStripePrivyAuthorizationPrivateKeyType" description: The authorization private key for the Stripe Privy integration. + authorizationPrivateKeySource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the authorization private key. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager. + authorizationPrivateKeyConfig: + $ref: "#/components/schemas/SecretReference" + description: A reference to the Amazon Web Services Secrets Manager secret that stores the authorization private key. This includes the secret ID and the JSON key used to extract the authorization private key value from the secret. Required when authorizationPrivateKeySource is set to EXTERNAL. authorizationId: $ref: "#/components/schemas/StripePrivyAuthorizationIdType" description: The authorization ID for the Stripe Privy integration. required: - appId - - appSecret - - authorizationPrivateKey - authorizationId StripePrivyAppIdType: type: string minLength: 1 maxLength: 512 pattern: "[a-zA-Z0-9\\-_]+" - StripePrivyAppSecretType: + DefaultStripePrivyAppSecretType: type: string - minLength: 1 + minLength: 0 maxLength: 2048 - pattern: "[a-zA-Z0-9+/=\\-_\\s]+" - StripePrivyAuthorizationPrivateKeyType: + pattern: "[a-zA-Z0-9+/=\\-_\\s]*" + DefaultStripePrivyAuthorizationPrivateKeyType: type: string - minLength: 1 + minLength: 0 maxLength: 2048 - pattern: "[a-zA-Z0-9+/=\\-_\\s]+" + pattern: (wallet-auth:)?[a-zA-Z0-9+/=\-_\s]* StripePrivyAuthorizationIdType: type: string minLength: 1 @@ -8843,8 +11609,20 @@ components: description: The API key identifier provided by Coinbase Developer Platform. apiKeySecretArn: $ref: "#/components/schemas/Secret" + apiKeySecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the API key secret value from the Amazon Web Services Secrets Manager secret. + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. walletSecretArn: $ref: "#/components/schemas/Secret" + walletSecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the wallet secret value from the Amazon Web Services Secrets Manager secret. + walletSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the wallet secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. required: - apiKeyId - apiKeySecretArn @@ -8858,8 +11636,20 @@ components: description: The app ID provided by Privy. appSecretArn: $ref: "#/components/schemas/Secret" + appSecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the app secret value from the Amazon Web Services Secrets Manager secret. + appSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the app secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. authorizationPrivateKeyArn: $ref: "#/components/schemas/Secret" + authorizationPrivateKeyJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the authorization private key value from the Amazon Web Services Secrets Manager secret. + authorizationPrivateKeySource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the authorization private key. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. authorizationId: $ref: "#/components/schemas/StripePrivyAuthorizationIdType" description: The authorization ID for the Stripe Privy integration. @@ -8910,6 +11700,9 @@ components: type: object properties: {} description: The tags associated with the created payment manager. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. required: - paymentManagerArn - paymentManagerId @@ -8953,6 +11746,9 @@ components: policyGeneration: $ref: "#/components/schemas/PolicyGenerationDetails" description: The generated policy asset information within the policy definition structure. This contains information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option. + policy: + $ref: "#/components/schemas/PolicyStatement" + description: An AgentCore policy statement that defines the access control rules. The statement can be a Cedar policy or a guardrails definition. CedarPolicy: description: Represents a Cedar policy statement within the AgentCore Policy system. Cedar is a policy language designed for authorization that provides human-readable, analyzable, and high-performance policy evaluation for controlling agent behavior and access decisions. type: object @@ -8979,11 +11775,26 @@ components: required: - policyGenerationId - policyGenerationAssetId + PolicyStatement: + description: An AgentCore policy statement, which supports plain Cedar policies as well as guardrails definitions. + type: object + properties: + statement: + $ref: "#/components/schemas/Statement" + description: The body of the AgentCore policy statement. Contains the policy logic, which can be a Cedar policy or a guardrails definition. + required: + - statement PolicyValidationMode: type: string enum: - FAIL_ON_ANY_FINDINGS - IGNORE_ALL_FINDINGS + EnforcementMode: + description: The enforcement mode for a policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. + type: string + enum: + - ACTIVE + - LOG_ONLY CreatePolicyResponse: type: object properties: @@ -9008,6 +11819,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the policy. A status of ACTIVE indicates the policy is ready for use. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The enforcement mode of the created policy. definition: $ref: "#/components/schemas/PolicyDefinition" description: The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions. @@ -9408,11 +12222,6 @@ components: - UPDATING - CREATE_FAILED - UPDATE_FAILED - WorkloadIdentityNameType: - type: string - minLength: 3 - maxLength: 255 - pattern: "[A-Za-z0-9_.-]+" ResourceOauth2ReturnUrlListType: type: array items: @@ -9450,6 +12259,9 @@ components: agentRuntimeId: $ref: "#/components/schemas/AgentRuntimeId" description: The unique identifier of the AgentCore Runtime. + agentRuntimeVersion: + $ref: "#/components/schemas/AgentRuntimeVersion" + description: The version of the AgentCore Runtime that was deleted. This value is present only when you delete a single version. required: - status DeleteAgentRuntimeEndpointResponse: @@ -9507,6 +12319,18 @@ components: - profileArn - status - lastUpdatedAt + DeleteCapacityProviderOutput: + type: object + properties: + capacityProviderId: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the deleted capacity provider. + status: + $ref: "#/components/schemas/CapacityProviderStatus" + description: The current status of the capacity provider. For possible values, see CapacityProviderStatus. + required: + - capacityProviderId + - status DeleteCodeInterpreterResponse: type: object properties: @@ -9545,6 +12369,58 @@ components: - UPDATE_FAILED - DELETING - DELETE_FAILED + DeleteDatasetResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset after the delete request. + datasetVersion: + $ref: "#/components/schemas/DatasetVersion" + description: The version that was deleted. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the delete was initiated. + required: + - datasetArn + - datasetId + - status + - datasetVersion + - updatedAt + DeleteDatasetExamplesRequestExampleIdsList: + type: array + items: + $ref: "#/components/schemas/ExampleId" + DeleteDatasetExamplesResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset. + deletedCount: + $ref: "#/components/schemas/Long" + description: The number of examples deleted. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the examples were deleted. + required: + - datasetArn + - datasetId + - status + - deletedCount + - updatedAt DeleteEvaluatorResponse: type: object properties: @@ -9563,7 +12439,7 @@ components: - status EvaluatorArn: type: string - pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+ + pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/(Builtin|ThirdParty)\.[a-zA-Z0-9._-]+ DeleteGatewayResponse: type: object properties: @@ -9579,6 +12455,18 @@ components: required: - gatewayId - status + DeleteGatewayRateLimitResponse: + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the deleted rate limit. + status: + $ref: "#/components/schemas/GatewayRateLimitStatus" + description: The current status of the rate limit deletion. + required: + - rateLimitId + - status DeleteGatewayRuleResponse: type: object properties: @@ -9616,6 +12504,14 @@ components: harness: $ref: "#/components/schemas/Harness" description: The harness that was deleted. + DeleteHarnessEndpointResponse: + type: object + properties: + endpoint: + $ref: "#/components/schemas/HarnessEndpoint" + description: The endpoint that was deleted. + required: + - endpoint DeleteMemoryInputClientTokenString: type: string minLength: 0 @@ -9697,6 +12593,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The enforcement mode of the deleted policy. definition: $ref: "#/components/schemas/PolicyDefinition" description: @@ -9845,6 +12744,9 @@ components: filesystemConfigurations: $ref: "#/components/schemas/FilesystemConfigurations" description: The filesystem configurations mounted into the AgentCore Runtime. + capacityProviderConfiguration: + $ref: "#/components/schemas/CapacityProviderConfiguration" + description: The capacity provider configuration for the AgentCore Runtime. required: - agentRuntimeArn - agentRuntimeName @@ -9853,7 +12755,6 @@ components: - createdAt - lastUpdatedAt - roleArn - - networkConfiguration - status - lifecycleConfiguration RuntimeMetadataConfiguration: @@ -9917,7 +12818,13 @@ components: properties: apiKeySecretArn: $ref: "#/components/schemas/Secret" - description: The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager. + apiKeySecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret. + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the API key credential provider. @@ -9967,6 +12874,9 @@ components: certificates: $ref: "#/components/schemas/Certificates" description: The list of certificates configured for the browser. + filesystemConfigurations: + $ref: "#/components/schemas/ToolsFileSystemConfigurations" + description: The file system configurations mounted into the browser. Each entry describes an access point and its mount path. status: $ref: "#/components/schemas/BrowserStatus" description: The current status of the browser. @@ -10039,6 +12949,59 @@ components: BrowserSessionId: type: string pattern: "[0-9a-zA-Z]{1,40}" + GetCapacityProviderOutput: + type: object + properties: + capacityProviderId: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider. + capacityProviderArn: + $ref: "#/components/schemas/CapacityProviderArn" + description: The Amazon Resource Name (ARN) of the capacity provider. + name: + $ref: "#/components/schemas/CapacityProviderName" + description: The name of the capacity provider. + status: + $ref: "#/components/schemas/CapacityProviderStatus" + description: The current status of the capacity provider. For possible values, see CapacityProviderStatus. + description: + $ref: "#/components/schemas/Description" + description: The description of the capacity provider, if one was provided. + statusCode: + $ref: "#/components/schemas/CapacityProviderStatusCode" + description: A reason code for a capacity provider that is not in the READY state. Use this code for programmatic error handling. + statusReason: + $ref: "#/components/schemas/String" + description: A human-readable message that describes why the capacity provider is not in the READY state. Because these messages can change, use statusCode for programmatic error handling. + permissionsConfiguration: + $ref: "#/components/schemas/PermissionsConfiguration" + description: The permissions configuration for the capacity provider. + computeConfiguration: + $ref: "#/components/schemas/ComputeConfiguration" + description: The compute configuration for the capacity provider. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the capacity provider was created. + lastUpdatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the capacity provider was last updated. + required: + - capacityProviderId + - capacityProviderArn + - name + - status + - permissionsConfiguration + - computeConfiguration + - createdAt + - lastUpdatedAt + CapacityProviderStatusCode: + description: "A reason code for a capacity provider that is not in the READY state. Possible values: VALIDATION_ERROR – A configuration error prevented the operation. For example, missing permissions, invalid parameters, or a naming conflict. QUOTA_EXCEEDED – An Amazon EC2 resource quota was exceeded. Request a limit increase or remove unused resources. THROTTLED – The request was throttled. Retry after a short delay. INTERNAL_SERVER_EXCEPTION – An internal error occurred." + type: string + enum: + - VALIDATION_ERROR + - QUOTA_EXCEEDED + - THROTTLED + - INTERNAL_SERVER_EXCEPTION GetCodeInterpreterResponse: type: object properties: @@ -10065,6 +13028,9 @@ components: certificates: $ref: "#/components/schemas/Certificates" description: The list of certificates configured for the code interpreter. + filesystemConfigurations: + $ref: "#/components/schemas/ToolsFileSystemConfigurations" + description: The file system configurations mounted into the code interpreter. Each entry describes an access point and its mount path. failureReason: $ref: "#/components/schemas/String" description: The reason for failure if the code interpreter is in a failed state. @@ -10113,6 +13079,9 @@ components: updatedAt: $ref: "#/components/schemas/Timestamp" description: The timestamp when the configuration bundle was last updated. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: KMS key ARN used to encrypt component configurations, if CMK was provided. required: - bundleArn - bundleId @@ -10176,6 +13145,9 @@ components: versionCreatedAt: $ref: "#/components/schemas/Timestamp" description: The timestamp when this specific version was created. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: KMS key ARN used to encrypt component configurations, if CMK was provided. required: - bundleArn - bundleId @@ -10184,6 +13156,76 @@ components: - components - createdAt - versionCreatedAt + GetDatasetResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + datasetVersion: + $ref: "#/components/schemas/DatasetVersion" + description: 'The resolved version: "DRAFT" (default) or the requested version number.' + datasetName: + $ref: "#/components/schemas/DatasetName" + description: The name of the dataset. + description: + $ref: "#/components/schemas/String" + description: The description of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset. + draftStatus: + $ref: "#/components/schemas/DraftStatus" + description: Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version. + failureReason: + $ref: "#/components/schemas/String" + description: Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure. + schemaType: + $ref: "#/components/schemas/DatasetSchemaType" + description: The schema type declared at create time. Immutable after creation. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured. + exampleCount: + $ref: "#/components/schemas/Long" + description: The number of examples in the DRAFT. + downloadUrl: + $ref: "#/components/schemas/DownloadUrl" + description: Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist. + downloadUrlExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: Expiry timestamp for the download URL. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was last updated. + tags: + type: object + properties: {} + description: The tags associated with the dataset. + required: + - datasetArn + - datasetId + - datasetVersion + - datasetName + - status + - schemaType + - exampleCount + - createdAt + - updatedAt + DraftStatus: + description: Publish synchronization state of the DRAFT working copy. + type: string + enum: + - MODIFIED + - UNMODIFIED + DownloadUrl: + type: string IncludedData: type: string enum: @@ -10207,6 +13249,12 @@ components: evaluatorConfig: $ref: "#/components/schemas/EvaluatorConfig" description: The configuration of the evaluator, including LLM-as-a-Judge or code-based settings. + evaluatorType: + $ref: "#/components/schemas/EvaluatorType" + description: "The kind of evaluator resource. Valid values: Builtin – An Amazon Web Services-managed global evaluator. ThirdParty – An Amazon Web Services-managed global evaluator from a third-party provider. Custom – A customer-created evaluator. CustomCode – A customer-created code-based evaluator. CustomDerived – A customer-created evaluator derived from an existing base evaluator." + provider: + $ref: "#/components/schemas/Provider" + description: "The source of the evaluator's logic: Amazon Web Services, a third-party library, or you." level: $ref: "#/components/schemas/EvaluatorLevel" description: The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation. @@ -10236,7 +13284,24 @@ components: - updatedAt EvaluatorName: type: string - pattern: (Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47}) + minLength: 1 + maxLength: 48 + pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47}) + EvaluatorType: + type: string + enum: + - Builtin + - ThirdParty + - Custom + - CustomCode + - CustomDerived + Provider: + type: string + enum: + - AWS + - DeepEval + - AutoEval + - Custom GetGatewayResponse: type: object properties: @@ -10284,6 +13349,9 @@ components: kmsKeyArn: $ref: "#/components/schemas/KmsKeyArn" description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway. + customTransformConfiguration: + $ref: "#/components/schemas/CustomTransformConfiguration" + description: The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses. interceptorConfigurations: $ref: "#/components/schemas/GatewayInterceptorConfigurations" description: The interceptors configured on the gateway. @@ -10296,6 +13364,12 @@ components: exceptionLevel: $ref: "#/components/schemas/ExceptionLevel" description: The level of detail in error messages returned when invoking the gateway. If the value is DEBUG, granular exception messages are returned to help a user debug the gateway. If the value is omitted, a generic error message is returned to the end user. + webAclArn: + $ref: "#/components/schemas/WebAclArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway. + wafConfiguration: + $ref: "#/components/schemas/WafConfiguration" + description: The Amazon Web Services WAF configuration for the gateway. required: - gatewayArn - gatewayId @@ -10304,6 +13378,42 @@ components: - status - name - authorizerType + GetGatewayRateLimitResponse: + description: Shared fields for GatewayRateLimit responses. + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit. + gatewayIdentifier: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + description: The human-readable description of the rate limit. + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + description: The ordered list of dimension key names that define the scope of this rate limit. + entries: + $ref: "#/components/schemas/LimitEntries" + description: The list of rule entries that map dimension values to rate configurations. + status: + $ref: "#/components/schemas/GatewayRateLimitStatus" + description: The current status of the rate limit. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was last updated. + required: + - rateLimitId + - gatewayIdentifier + - dimensionKeys + - entries + - status + - createdAt + - updatedAt GetGatewayRuleResponse: description: Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures. type: object @@ -10412,6 +13522,14 @@ components: description: The harness resource. required: - harness + GetHarnessEndpointResponse: + type: object + properties: + endpoint: + $ref: "#/components/schemas/HarnessEndpoint" + description: The endpoint resource. + required: + - endpoint MemoryView: type: string enum: @@ -10430,7 +13548,13 @@ components: properties: clientSecretArn: $ref: "#/components/schemas/Secret" - description: The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager. + clientSecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the OAuth2 credential provider. @@ -10490,6 +13614,12 @@ components: evaluators: $ref: "#/components/schemas/EvaluatorList" description: The list of evaluators applied during online evaluation. + insights: + $ref: "#/components/schemas/InsightList" + description: The list of insight types configured for this evaluation. + clusteringConfig: + $ref: "#/components/schemas/ClusteringConfig" + description: The clustering configuration for periodic batch evaluation. outputConfig: $ref: "#/components/schemas/OutputConfig" description: The output configuration specifying where evaluation results are written. @@ -10517,7 +13647,6 @@ components: - onlineEvaluationConfigName - rule - dataSourceConfig - - evaluators - status - executionStatus - createdAt @@ -10549,6 +13678,9 @@ components: status: $ref: "#/components/schemas/PaymentConnectorStatus" description: The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. + authorizationUrl: + $ref: "#/components/schemas/PaymentConnectorAuthorizationUrl" + description: The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION. required: - paymentConnectorId - name @@ -10627,6 +13759,9 @@ components: type: object properties: {} description: The tags associated with the payment manager. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. required: - paymentManagerArn - paymentManagerId @@ -10660,6 +13795,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the policy. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The current enforcement mode of the policy. definition: $ref: "#/components/schemas/PolicyDefinition" description: The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions. @@ -10878,6 +14016,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the policy. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The current enforcement mode of the policy. required: - policyId - name @@ -11179,6 +14320,38 @@ components: - description - lastUpdatedAt - status + ListAgentRuntimeVersionsByCapacityProviderOutput: + type: object + properties: + agentRuntimes: + $ref: "#/components/schemas/AgentRuntimeVersionSummaryList" + description: The list of agent runtime versions that are associated with the capacity provider. + nextToken: + $ref: "#/components/schemas/String" + description: If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results. + required: + - agentRuntimes + AgentRuntimeVersionSummaryList: + type: array + items: + $ref: "#/components/schemas/AgentRuntimeVersionSummary" + AgentRuntimeVersionSummary: + description: Summary information about an agent runtime version associated with a capacity provider. This is returned by ListAgentRuntimeVersionsByCapacityProvider. + type: object + properties: + agentRuntimeArn: + $ref: "#/components/schemas/AgentRuntimeArn" + description: The Amazon Resource Name (ARN) of the agent runtime. + agentRuntimeVersion: + $ref: "#/components/schemas/AgentRuntimeVersion" + description: The version of the agent runtime. + status: + $ref: "#/components/schemas/AgentRuntimeStatus" + description: The current status of the agent runtime version. + required: + - agentRuntimeArn + - agentRuntimeVersion + - status ListAgentRuntimesResponse: type: object properties: @@ -11332,6 +14505,46 @@ components: - browserArn - status - createdAt + ListCapacityProvidersOutput: + type: object + properties: + capacityProviders: + $ref: "#/components/schemas/CapacityProviderList" + description: The list of capacity provider summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results. + required: + - capacityProviders + CapacityProviderList: + type: array + items: + $ref: "#/components/schemas/CapacityProviderSummary" + CapacityProviderSummary: + description: A summary of a capacity provider, as returned by ListCapacityProviders. Each summary includes the capacity provider identifier, Amazon Resource Name (ARN), name, status, and last-updated timestamp. + type: object + properties: + capacityProviderId: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider. + capacityProviderArn: + $ref: "#/components/schemas/CapacityProviderArn" + description: The Amazon Resource Name (ARN) of the capacity provider. + name: + $ref: "#/components/schemas/CapacityProviderName" + description: The name of the capacity provider. + status: + $ref: "#/components/schemas/CapacityProviderStatus" + description: The current status of the capacity provider. For possible values, see CapacityProviderStatus. + lastUpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the capacity provider was last updated. + required: + - capacityProviderId + - capacityProviderArn + - name + - status + - lastUpdatedAt ListCodeInterpretersResponse: type: object properties: @@ -11468,10 +14681,136 @@ components: description: $ref: "#/components/schemas/ConfigurationBundleDescription" description: The description of the configuration bundle. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the configuration bundle was created. required: - bundleArn - bundleId - bundleName + ListDatasetExamplesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListDatasetExamplesRequestNextTokenString: + type: string + minLength: 0 + maxLength: 2048 + ListDatasetExamplesRowDisplay: + type: object + properties: + example: + type: object + description: Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields. + ListDatasetExamplesOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ListDatasetExamplesRowDisplay" + ListDatasetVersionsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListDatasetVersionsResponse: + type: object + properties: + versions: + $ref: "#/components/schemas/DatasetVersionSummaryList" + description: The list of published dataset versions. + nextToken: + $ref: "#/components/schemas/String" + description: The token for the next page of results, or null if there are no more results. + required: + - versions + DatasetVersionSummaryList: + type: array + items: + $ref: "#/components/schemas/DatasetVersionSummary" + DatasetVersionSummary: + description: Summary information about a published dataset version. + type: object + properties: + datasetVersion: + $ref: "#/components/schemas/DatasetVersion" + description: The version number of this published snapshot. + exampleCount: + $ref: "#/components/schemas/Long" + description: The number of examples in this version. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when this version was published. + required: + - datasetVersion + - exampleCount + - createdAt + ListDatasetsRequestNextTokenString: + type: string + minLength: 0 + maxLength: 2048 + ListDatasetsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListDatasetsResponse: + type: object + properties: + datasets: + $ref: "#/components/schemas/DatasetSummaryList" + description: The list of datasets. + nextToken: + $ref: "#/components/schemas/String" + description: The token for the next page of results, or null if there are no more results. + required: + - datasets + DatasetSummaryList: + type: array + items: + $ref: "#/components/schemas/DatasetSummary" + DatasetSummary: + description: Summary information about a dataset. + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + datasetName: + $ref: "#/components/schemas/DatasetName" + description: The name of the dataset. + description: + $ref: "#/components/schemas/String" + description: The description of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset. + draftStatus: + $ref: "#/components/schemas/DraftStatus" + description: Publish synchronization state. Only authoritative when status is ACTIVE. + schemaType: + $ref: "#/components/schemas/DatasetSchemaType" + description: The schema type of the dataset. + exampleCount: + $ref: "#/components/schemas/Long" + description: The number of examples in the dataset. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was last updated. + required: + - datasetArn + - datasetId + - datasetName + - status + - schemaType + - exampleCount + - createdAt + - updatedAt ListEvaluatorsRequestMaxResultsInteger: type: integer minimum: 1 @@ -11510,6 +14849,9 @@ components: evaluatorType: $ref: "#/components/schemas/EvaluatorType" description: The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user. + provider: + $ref: "#/components/schemas/Provider" + description: "The source of the evaluator's logic: Amazon Web Services, a third-party library, or you." level: $ref: "#/components/schemas/EvaluatorLevel" description: The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation. @@ -11536,12 +14878,26 @@ components: - status - createdAt - updatedAt - EvaluatorType: + GatewayRateLimitMaxResults: + type: integer + minimum: 1 + maximum: 100 + GatewayRateLimitNextToken: type: string - enum: - - Builtin - - Custom - - CustomCode + minLength: 1 + maxLength: 2048 + pattern: \S* + ListGatewayRateLimitsResponse: + type: object + properties: + rateLimits: + $ref: "#/components/schemas/GatewayRateLimits" + description: The list of rate limits for the gateway. + nextToken: + $ref: "#/components/schemas/GatewayRateLimitNextToken" + description: The token for the next page of results. If this value is absent, there are no more results to retrieve. + required: + - rateLimits GatewayRuleMaxResults: type: integer minimum: 1 @@ -11656,12 +15012,36 @@ components: resourcePriority: $ref: "#/components/schemas/TargetResourcePriority" description: Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set. + lastSynchronizedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the target was last synchronized. + authorizationData: + $ref: "#/components/schemas/AuthorizationData" + targetType: + $ref: "#/components/schemas/TargetType" + description: The type of the target. + listingMode: + $ref: "#/components/schemas/ListingMode" + description: The listing mode for the target. MCP resources for DEFAULT targets are cached at the control plane for faster access. MCP resources for DYNAMIC targets are retrieved dynamically when listing tools. required: - targetId - name - status - createdAt - updatedAt + TargetType: + type: string + enum: + - OPEN_API_SCHEMA + - SMITHY_MODEL + - MCP_SERVER + - LAMBDA + - API_GATEWAY + - CONNECTOR + - AGENTCORE_RUNTIME + - PASSTHROUGH + - PROVIDER + - HTTP_CONNECTOR GatewayMaxResults: type: integer minimum: 1 @@ -11721,6 +15101,72 @@ components: - createdAt - updatedAt - authorizerType + ListHarnessEndpointsResponse: + type: object + properties: + endpoints: + $ref: "#/components/schemas/HarnessEndpoints" + description: The list of harness endpoints. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. + required: + - endpoints + HarnessEndpoints: + type: array + items: + $ref: "#/components/schemas/HarnessEndpoint" + ListHarnessVersionsResponse: + type: object + properties: + harnessVersions: + $ref: "#/components/schemas/HarnessVersionSummaries" + description: The list of harness version summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. + required: + - harnessVersions + HarnessVersionSummaries: + type: array + items: + $ref: "#/components/schemas/HarnessVersionSummary" + HarnessVersionSummary: + description: Summary information about a single version of a harness. + type: object + properties: + harnessId: + $ref: "#/components/schemas/HarnessId" + description: The ID of the harness. + harnessName: + $ref: "#/components/schemas/HarnessName" + description: The name of the harness. + arn: + $ref: "#/components/schemas/HarnessArn" + description: The ARN of the harness. + harnessVersion: + $ref: "#/components/schemas/HarnessVersion" + description: The version of the harness that this summary describes. + status: + $ref: "#/components/schemas/HarnessStatus" + description: The status of this harness version. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when this harness version was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when this harness version was last updated. + failureReason: + $ref: "#/components/schemas/String" + description: Reason why the create or update operation for this harness version failed. + required: + - harnessId + - harnessName + - arn + - harnessVersion + - status + - createdAt + - updatedAt ListHarnessesResponse: type: object properties: @@ -11758,6 +15204,9 @@ components: updatedAt: $ref: "#/components/schemas/DateTimestamp" description: The timestamp when the harness was last updated. + harnessVersion: + $ref: "#/components/schemas/HarnessVersion" + description: The latest version of the harness. required: - harnessId - harnessName @@ -11803,6 +15252,9 @@ components: updatedAt: $ref: "#/components/schemas/Timestamp" description: The timestamp when the memory was last updated. + managedByResourceArn: + $ref: "#/components/schemas/Arn" + description: ARN of the resource managing this memory (e.g. a harness). Null if not managed. required: - createdAt - updatedAt @@ -11900,6 +15352,12 @@ components: failureReason: $ref: "#/components/schemas/String" description: The reason for failure if the online evaluation configuration execution failed. + insights: + $ref: "#/components/schemas/InsightList" + description: The list of insight types configured for this evaluation. + clusteringConfig: + $ref: "#/components/schemas/ClusteringConfig" + description: The clustering configuration for periodic batch evaluation. required: - onlineEvaluationConfigArn - onlineEvaluationConfigId @@ -12038,6 +15496,9 @@ components: lastUpdatedAt: $ref: "#/components/schemas/DateTimestamp" description: The timestamp when the payment manager was last updated. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. required: - paymentManagerArn - paymentManagerId @@ -12086,6 +15547,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the policy. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The current enforcement mode of the policy. definition: $ref: "#/components/schemas/PolicyDefinition" description: The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions. @@ -12420,6 +15884,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the policy. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The current enforcement mode of the policy. required: - policyId - name @@ -12834,7 +16301,13 @@ components: properties: apiKeySecretArn: $ref: "#/components/schemas/Secret" - description: The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager. + apiKeySecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret. + apiKeySecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the API key credential provider. @@ -12853,6 +16326,41 @@ components: - credentialProviderArn - createdTime - lastUpdatedTime + UpdatedDescription: + description: Wrapper for updating an optional Description field with PATCH semantics. When present in an update request, the description is replaced with optionalValue. When absent, the description is left unchanged. To unset the description, include the wrapper with optionalValue not specified. + type: object + properties: + optionalValue: + $ref: "#/components/schemas/Description" + description: Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource. + UpdateCapacityProviderOutput: + type: object + properties: + capacityProviderId: + $ref: "#/components/schemas/CapacityProviderId" + description: The unique identifier of the capacity provider. + capacityProviderArn: + $ref: "#/components/schemas/CapacityProviderArn" + description: The Amazon Resource Name (ARN) of the capacity provider. + name: + $ref: "#/components/schemas/CapacityProviderName" + description: The name of the capacity provider. + status: + $ref: "#/components/schemas/CapacityProviderStatus" + description: The current status of the capacity provider. For possible values, see CapacityProviderStatus. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the capacity provider was created. + lastUpdatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the capacity provider was last updated. + required: + - capacityProviderId + - capacityProviderArn + - name + - status + - createdAt + - lastUpdatedAt UpdateConfigurationBundleRequestCommitMessageString: type: string minLength: 1 @@ -12877,6 +16385,55 @@ components: - bundleId - versionId - updatedAt + UpdateDatasetRequestDescriptionString: + type: string + minLength: 0 + maxLength: 200 + UpdateDatasetResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the updated dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the updated dataset. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dataset was updated. + required: + - datasetArn + - datasetId + - updatedAt + UpdateDatasetExamplesRequestExamplesList: + description: A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type. + type: array + items: + $ref: "#/components/schemas/SensitiveJson" + UpdateDatasetExamplesResponse: + type: object + properties: + datasetArn: + $ref: "#/components/schemas/DatasetArn" + description: The Amazon Resource Name (ARN) of the dataset. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The unique identifier of the dataset. + status: + $ref: "#/components/schemas/DatasetStatus" + description: The current status of the dataset. + updatedCount: + $ref: "#/components/schemas/Long" + description: The number of examples updated. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the examples were updated. + required: + - datasetArn + - datasetId + - status + - updatedCount + - updatedAt UpdateEvaluatorResponse: type: object properties: @@ -12944,6 +16501,9 @@ components: kmsKeyArn: $ref: "#/components/schemas/KmsKeyArn" description: The updated ARN of the KMS key used to encrypt the gateway. + customTransformConfiguration: + $ref: "#/components/schemas/CustomTransformConfiguration" + description: The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses. interceptorConfigurations: $ref: "#/components/schemas/GatewayInterceptorConfigurations" description: The updated interceptor configurations for the gateway. @@ -12956,6 +16516,12 @@ components: exceptionLevel: $ref: "#/components/schemas/ExceptionLevel" description: The level of detail in error messages returned when invoking the gateway. If the value is DEBUG, granular exception messages are returned to help a user debug the gateway. If the value is omitted, a generic error message is returned to the end user. + webAclArn: + $ref: "#/components/schemas/WebAclArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway. + wafConfiguration: + $ref: "#/components/schemas/WafConfiguration" + description: The Amazon Web Services WAF configuration for the gateway. required: - gatewayArn - gatewayId @@ -12964,6 +16530,42 @@ components: - status - name - authorizerType + UpdateGatewayRateLimitResponse: + description: Shared fields for GatewayRateLimit responses. + type: object + properties: + rateLimitId: + $ref: "#/components/schemas/GatewayRateLimitId" + description: The unique identifier of the rate limit. + gatewayIdentifier: + $ref: "#/components/schemas/GatewayIdentifier" + description: The unique identifier of the gateway. + description: + $ref: "#/components/schemas/GatewayRateLimitDescription" + description: The human-readable description of the rate limit. + dimensionKeys: + $ref: "#/components/schemas/DimensionKeys" + description: The ordered list of dimension key names that define the scope of this rate limit. + entries: + $ref: "#/components/schemas/LimitEntries" + description: The list of rule entries that map dimension values to rate configurations. + status: + $ref: "#/components/schemas/GatewayRateLimitStatus" + description: The current status of the rate limit. + createdAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was created. + updatedAt: + $ref: "#/components/schemas/DateTimestamp" + description: The timestamp when the rate limit was last updated. + required: + - rateLimitId + - gatewayIdentifier + - dimensionKeys + - entries + - status + - createdAt + - updatedAt UpdateGatewayRuleResponse: description: Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures. type: object @@ -13093,6 +16695,14 @@ components: description: The updated harness. required: - harness + UpdateHarnessEndpointResponse: + type: object + properties: + endpoint: + $ref: "#/components/schemas/HarnessEndpoint" + description: The updated endpoint. + required: + - endpoint UpdateMemoryInputClientTokenString: type: string minLength: 0 @@ -13272,7 +16882,13 @@ components: properties: clientSecretArn: $ref: "#/components/schemas/Secret" - description: The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager. + description: The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager. + clientSecretJsonKey: + $ref: "#/components/schemas/SecretJsonKeyType" + description: The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret. + clientSecretSource: + $ref: "#/components/schemas/SecretSourceType" + description: The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. name: $ref: "#/components/schemas/CredentialProviderName" description: The name of the OAuth2 credential provider. @@ -13356,6 +16972,9 @@ components: status: $ref: "#/components/schemas/PaymentConnectorStatus" description: The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. + authorizationUrl: + $ref: "#/components/schemas/PaymentConnectorAuthorizationUrl" + description: The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION. required: - paymentConnectorId - paymentManagerId @@ -13418,6 +17037,9 @@ components: status: $ref: "#/components/schemas/PaymentManagerStatus" description: The current status of the updated payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. + kmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. required: - paymentManagerArn - paymentManagerId @@ -13426,13 +17048,6 @@ components: - roleArn - lastUpdatedAt - status - UpdatedDescription: - description: Wrapper for updating an optional Description field with PATCH semantics. When present in an update request, the description is replaced with optionalValue. When absent, the description is left unchanged. To unset the description, include the wrapper with optionalValue not specified. - type: object - properties: - optionalValue: - $ref: "#/components/schemas/Description" - description: Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource. UpdatePolicyResponse: type: object properties: @@ -13457,6 +17072,9 @@ components: status: $ref: "#/components/schemas/PolicyStatus" description: The current status of the updated policy. + enforcementMode: + $ref: "#/components/schemas/EnforcementMode" + description: The current enforcement mode of the updated policy. definition: $ref: "#/components/schemas/PolicyDefinition" description: The updated Cedar policy statement. @@ -13788,6 +17406,153 @@ components: - createdTime - lastUpdatedTime x-stackQL-resources: + dataset_examples: + id: aws.bedrock_agentcore_control.dataset_examples + name: dataset_examples + title: dataset_examples + methods: + add_dataset_examples: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1examples~1add/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_dataset_examples: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1examples~1delete/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_dataset_examples: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1examples/get" + response: + openAPIDocKey: "200" + mediaType: application/json + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ListDatasetExamplesOutputDisplay" + transform: + type: golang_template_json_v0.3.0 + body: '{{- $lst := index . "examples" -}}{{- $tok := index . "nextToken" -}}{"line_items": [{{- if eq (kindOf $lst) "slice" -}}{{- range $i, $v := $lst -}}{{- if $i }},{{ end }}{"example": {{ toJson $v }}}{{- end -}}{{- end -}}]{{- if $tok }}, "nextToken": {{ toJson $tok }}{{- end }}}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_dataset_examples: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1examples~1update/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dataset_examples/methods/list_dataset_examples" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/dataset_examples/methods/add_dataset_examples" + - $ref: "#/components/x-stackQL-resources/dataset_examples/methods/update_dataset_examples" + delete: + - $ref: "#/components/x-stackQL-resources/dataset_examples/methods/delete_dataset_examples" + gateway_rate_limits: + id: aws.bedrock_agentcore_control.gateway_rate_limits + name: gateway_rate_limits + title: gateway_rate_limits + methods: + batch_put_gateway_rate_limits: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits~1batch/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_gateway_rate_limit: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_gateway_rate_limits: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.rateLimits + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_gateway_rate_limit: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits~1{rate_limit_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_gateway_rate_limit: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits~1{rate_limit_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_gateway_rate_limit: + operation: + $ref: "#/paths/~1gateways~1{gateway_identifier}~1rate-limits~1{rate_limit_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/gateway_rate_limits/methods/get_gateway_rate_limit" + - $ref: "#/components/x-stackQL-resources/gateway_rate_limits/methods/list_gateway_rate_limits" + insert: + - $ref: "#/components/x-stackQL-resources/gateway_rate_limits/methods/create_gateway_rate_limit" + update: + - $ref: "#/components/x-stackQL-resources/gateway_rate_limits/methods/update_gateway_rate_limit" + delete: + - $ref: "#/components/x-stackQL-resources/gateway_rate_limits/methods/delete_gateway_rate_limit" agent_runtimes: id: aws.bedrock_agentcore_control.agent_runtimes name: agent_runtimes @@ -14118,6 +17883,74 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/browser_profiles/methods/delete_browser_profile" + capacity_providers: + id: aws.bedrock_agentcore_control.capacity_providers + name: capacity_providers + title: capacity_providers + methods: + create_capacity_provider: + operation: + $ref: "#/paths/~1capacity-providers/put" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_capacity_providers: + operation: + $ref: "#/paths/~1capacity-providers/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.capacityProviders + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_capacity_provider: + operation: + $ref: "#/paths/~1capacity-providers~1{capacity_provider_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + get_capacity_provider: + operation: + $ref: "#/paths/~1capacity-providers~1{capacity_provider_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_capacity_provider: + operation: + $ref: "#/paths/~1capacity-providers~1{capacity_provider_id}/put" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/capacity_providers/methods/get_capacity_provider" + - $ref: "#/components/x-stackQL-resources/capacity_providers/methods/list_capacity_providers" + insert: + - $ref: "#/components/x-stackQL-resources/capacity_providers/methods/create_capacity_provider" + update: + - $ref: "#/components/x-stackQL-resources/capacity_providers/methods/update_capacity_provider" + delete: + - $ref: "#/components/x-stackQL-resources/capacity_providers/methods/delete_capacity_provider" code_interpreters: id: aws.bedrock_agentcore_control.code_interpreters name: code_interpreters @@ -14242,6 +18075,116 @@ components: - $ref: "#/components/x-stackQL-resources/configuration_bundles/methods/update_configuration_bundle" delete: - $ref: "#/components/x-stackQL-resources/configuration_bundles/methods/delete_configuration_bundle" + datasets: + id: aws.bedrock_agentcore_control.datasets + name: datasets + title: datasets + methods: + create_dataset: + operation: + $ref: "#/paths/~1datasets/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_datasets: + operation: + $ref: "#/paths/~1datasets/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.datasets + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + get_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/datasets/methods/get_dataset" + - $ref: "#/components/x-stackQL-resources/datasets/methods/list_datasets" + insert: + - $ref: "#/components/x-stackQL-resources/datasets/methods/create_dataset" + update: + - $ref: "#/components/x-stackQL-resources/datasets/methods/update_dataset" + delete: + - $ref: "#/components/x-stackQL-resources/datasets/methods/delete_dataset" + dataset_versions: + id: aws.bedrock_agentcore_control.dataset_versions + name: dataset_versions + title: dataset_versions + methods: + create_dataset_version: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1versions/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_dataset_versions: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.versions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dataset_versions/methods/list_dataset_versions" + insert: + - $ref: "#/components/x-stackQL-resources/dataset_versions/methods/create_dataset_version" + update: [] + delete: [] evaluators: id: aws.bedrock_agentcore_control.evaluators name: evaluators @@ -14550,6 +18493,8 @@ components: openAPIDocKey: "200" mediaType: application/json objectKey: $.harness + request: + nativeCasing: pascal update_harness: operation: $ref: "#/paths/~1harnesses~1{harness_id}/patch" @@ -14598,6 +18543,75 @@ components: insert: [] update: [] delete: [] + harness_endpoints: + id: aws.bedrock_agentcore_control.harness_endpoints + name: harness_endpoints + title: harness_endpoints + methods: + create_harness_endpoint: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1endpoints/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_harness_endpoints: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1endpoints/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.endpoints + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_harness_endpoint: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1endpoints~1{endpoint_name}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + get_harness_endpoint: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1endpoints~1{endpoint_name}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.endpoint + update_harness_endpoint: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1endpoints~1{endpoint_name}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/harness_endpoints/methods/get_harness_endpoint" + - $ref: "#/components/x-stackQL-resources/harness_endpoints/methods/list_harness_endpoints" + insert: + - $ref: "#/components/x-stackQL-resources/harness_endpoints/methods/create_harness_endpoint" + update: + - $ref: "#/components/x-stackQL-resources/harness_endpoints/methods/update_harness_endpoint" + delete: + - $ref: "#/components/x-stackQL-resources/harness_endpoints/methods/delete_harness_endpoint" memories: id: aws.bedrock_agentcore_control.memories name: memories @@ -15676,6 +19690,62 @@ components: insert: [] update: [] delete: [] + agent_runtime_versions_by_capacity_providers: + id: aws.bedrock_agentcore_control.agent_runtime_versions_by_capacity_providers + name: agent_runtime_versions_by_capacity_providers + title: agent_runtime_versions_by_capacity_providers + methods: + list_agent_runtime_versions_by_capacity_provider: + operation: + $ref: "#/paths/~1capacity-providers~1{capacity_provider_id}~1runtime-versions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.agentRuntimes + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_runtime_versions_by_capacity_providers/methods/list_agent_runtime_versions_by_capacity_provider" + insert: [] + update: [] + delete: [] + harness_versions: + id: aws.bedrock_agentcore_control.harness_versions + name: harness_versions + title: harness_versions + methods: + list_harness_versions: + operation: + $ref: "#/paths/~1harnesses~1{harness_id}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.harnessVersions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/harness_versions/methods/list_harness_versions" + insert: [] + update: [] + delete: [] policy_generation_assets: id: aws.bedrock_agentcore_control.policy_generation_assets name: policy_generation_assets diff --git a/providers/src/aws/v00.00.00000/services/bedrock_data_automation.yaml b/providers/src/aws/v00.00.00000/services/bedrock_data_automation.yaml index 768c5399..91b2b960 100644 --- a/providers/src/aws/v00.00.00000/services/bedrock_data_automation.yaml +++ b/providers/src/aws/v00.00.00000/services/bedrock_data_automation.yaml @@ -1425,6 +1425,8 @@ components: properties: blueprints: $ref: "#/components/schemas/BlueprintItems" + document: + $ref: "#/components/schemas/DocumentCustomOutputConfiguration" BlueprintItems: description: List of Blueprint Item type: array @@ -1442,6 +1444,17 @@ components: $ref: "#/components/schemas/BlueprintStage" required: - blueprintArn + DocumentCustomOutputConfiguration: + description: Custom Configuration of Document + type: object + properties: + fallbackBlueprints: + $ref: "#/components/schemas/FallbackBlueprintItems" + FallbackBlueprintItems: + description: List of Fallback Blueprint Items + type: array + items: + $ref: "#/components/schemas/BlueprintItem" OverrideConfiguration: description: Override configuration type: object diff --git a/providers/src/aws/v00.00.00000/services/bedrock_runtime.yaml b/providers/src/aws/v00.00.00000/services/bedrock_runtime.yaml index 6982074c..6c745988 100644 --- a/providers/src/aws/v00.00.00000/services/bedrock_runtime.yaml +++ b/providers/src/aws/v00.00.00000/services/bedrock_runtime.yaml @@ -201,6 +201,32 @@ paths: application/json: schema: $ref: "#/components/schemas/GetAsyncInvokeResponse" + /guardrail-checks/invoke: + post: + operationId: InvokeGuardrailChecks + description: Evaluates messages against inline guardrail checks. You specify the check configurations directly in the request, and Amazon Bedrock returns per-check results with severity or confidence scores. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + messages: + $ref: "#/components/schemas/GuardrailChecksMessageList" + checks: + $ref: "#/components/schemas/GuardrailChecksConfig" + required: + - messages + - checks + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/InvokeGuardrailChecksResponse" /model/{model_id}/invoke: post: operationId: InvokeModel @@ -254,6 +280,12 @@ paths: schema: $ref: "#/components/schemas/ServiceTierType" description: Specifies the processing tier type used for serving the request. + - name: X-Amzn-Bedrock-Request-Metadata + in: header + required: false + schema: + $ref: "#/components/schemas/RequestMetadataJson" + description: Key-value pairs that you can use to filter invocation logs. requestBody: required: false content: @@ -352,6 +384,12 @@ paths: schema: $ref: "#/components/schemas/ServiceTierType" description: Specifies the processing tier type used for serving the request. + - name: X-Amzn-Bedrock-Request-Metadata + in: header + required: false + schema: + $ref: "#/components/schemas/RequestMetadataJson" + description: Key-value pairs that you can use to filter invocation logs. requestBody: required: false content: @@ -1406,6 +1444,7 @@ components: enum: - user - assistant + - system ContentBlocks: type: array items: @@ -1450,6 +1489,10 @@ components: searchResult: $ref: "#/components/schemas/SearchResultBlock" description: Search result to include in the message. + toolAddition: + $ref: "#/components/schemas/ToolAdditionBlock" + toolRemoval: + $ref: "#/components/schemas/ToolRemovalBlock" ImageBlock: description: Image content for a message. type: object @@ -2075,6 +2118,49 @@ components: SearchResultLocationEndInteger: type: integer minimum: 0 + ToolAdditionBlock: + description: A content block for adding a tool to the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to make a tool available without re-sending the full tool configuration. + type: object + properties: + tool: + $ref: "#/components/schemas/ToolReference" + description: A reference to the tool to add to the available tool set. + required: + - tool + ToolReference: + description: A reference to a tool in the tool configuration. Used with ToolAdditionBlock and ToolRemovalBlock to identify which tool to add or remove mid-conversation. + type: object + properties: + type_: + $ref: "#/components/schemas/ToolReferenceTypeString" + description: The type of tool reference. + name: + $ref: "#/components/schemas/ToolReferenceNameString" + description: The name of the tool. Must match the name of a tool declared in the top-level tool configuration. + serverName: + $ref: "#/components/schemas/ToolReferenceServerNameString" + description: The name of the MCP server that provides the tool. Required when referencing an MCP tool. + ToolReferenceTypeString: + type: string + minLength: 1 + maxLength: 64 + ToolReferenceNameString: + type: string + minLength: 1 + maxLength: 128 + ToolReferenceServerNameString: + type: string + minLength: 1 + maxLength: 128 + ToolRemovalBlock: + description: A content block for removing a tool from the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to remove a tool without re-sending the full tool configuration. + type: object + properties: + tool: + $ref: "#/components/schemas/ToolReference" + description: A reference to the tool to remove from the available tool set. + required: + - tool SystemContentBlocks: type: array items: @@ -2288,6 +2374,9 @@ components: textFormat: $ref: "#/components/schemas/OutputFormat" description: Structured output parameters to control the model's text response. + effort: + $ref: "#/components/schemas/OutputConfigEffortString" + description: The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max. When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels. OutputFormat: description: Structured output parameters to control the model's response. type: object @@ -2328,6 +2417,10 @@ components: description: A description of the JSON schema. required: - schema + OutputConfigEffortString: + type: string + minLength: 0 + maxLength: 16 ConverseResponse: type: object properties: @@ -3005,6 +3098,372 @@ components: minLength: 1 maxLength: 2048 pattern: arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)) + GuardrailChecksMessageList: + description: A list of messages to evaluate. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksMessage" + GuardrailChecksMessage: + description: A message to evaluate against guardrail checks, containing a role and content blocks. + type: object + properties: + role: + $ref: "#/components/schemas/GuardrailChecksRole" + description: The role of the message sender. + content: + $ref: "#/components/schemas/GuardrailChecksContentBlockList" + description: The content blocks for the message. + required: + - role + - content + GuardrailChecksRole: + description: The role of the message sender in the conversation. + type: string + enum: + - user + - assistant + - system + GuardrailChecksContentBlockList: + description: A list of content blocks within a message. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksContentBlock" + GuardrailChecksContentBlock: + description: A content block within a message to evaluate. + type: object + properties: + text: + $ref: "#/components/schemas/GuardrailChecksTextContent" + description: The text content to evaluate. + GuardrailChecksTextContent: + description: The text content of a message content block. Minimum length of 1 character. + type: string + minLength: 1 + GuardrailChecksConfig: + description: The configuration for inline guardrail checks. Specify one or more check types to run against the messages. + type: object + properties: + contentFilter: + $ref: "#/components/schemas/GuardrailChecksContentFilterConfig" + description: The content filter check configuration. + promptAttack: + $ref: "#/components/schemas/GuardrailChecksPromptAttackConfig" + description: The prompt attack check configuration. + sensitiveInformation: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationConfig" + description: The sensitive information check configuration. + GuardrailChecksContentFilterConfig: + description: The configuration for the content filter check, specifying which categories to evaluate. + type: object + properties: + categories: + $ref: "#/components/schemas/GuardrailChecksContentFilterCategoryConfigList" + description: The content filter categories to evaluate. + required: + - categories + GuardrailChecksContentFilterCategoryConfigList: + description: A list of content filter category configurations. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksContentFilterCategoryConfig" + GuardrailChecksContentFilterCategoryConfig: + description: The configuration for a single content filter category to evaluate. + type: object + properties: + category: + $ref: "#/components/schemas/GuardrailChecksContentFilterCategory" + description: The content filter category to evaluate. + required: + - category + GuardrailChecksContentFilterCategory: + description: The category for content filter evaluation. + type: string + enum: + - VIOLENCE + - HATE + - SEXUAL + - MISCONDUCT + - INSULTS + GuardrailChecksPromptAttackConfig: + description: The configuration for the prompt attack check, specifying which categories to evaluate. + type: object + properties: + categories: + $ref: "#/components/schemas/GuardrailChecksPromptAttackCategoryConfigList" + description: The prompt attack categories to evaluate. + required: + - categories + GuardrailChecksPromptAttackCategoryConfigList: + description: A list of prompt attack category configurations. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksPromptAttackCategoryConfig" + GuardrailChecksPromptAttackCategoryConfig: + description: The configuration for a single prompt attack category to evaluate. + type: object + properties: + category: + $ref: "#/components/schemas/GuardrailChecksPromptAttackCategory" + description: The prompt attack category to evaluate. + required: + - category + GuardrailChecksPromptAttackCategory: + description: The category for prompt attack evaluation. + type: string + enum: + - JAILBREAK + - PROMPT_INJECTION + - PROMPT_LEAKAGE + GuardrailChecksSensitiveInformationConfig: + description: The configuration for the sensitive information check, specifying which entity types to detect. + type: object + properties: + entities: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationEntityConfigList" + description: The sensitive information entity types to detect. + required: + - entities + GuardrailChecksSensitiveInformationEntityConfigList: + description: A list of sensitive information entity configurations. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationEntityConfig" + GuardrailChecksSensitiveInformationEntityConfig: + description: The configuration for a single sensitive information entity type to detect. + type: object + properties: + type_: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationEntityType" + description: The PII entity type to detect. + required: + - type_ + GuardrailChecksSensitiveInformationEntityType: + description: The type of personally identifiable information (PII) entity to detect. + type: string + enum: + - ADDRESS + - AGE + - AWS_ACCESS_KEY + - AWS_SECRET_KEY + - CA_HEALTH_NUMBER + - CA_SOCIAL_INSURANCE_NUMBER + - CREDIT_DEBIT_CARD_CVV + - CREDIT_DEBIT_CARD_EXPIRY + - CREDIT_DEBIT_CARD_NUMBER + - DRIVER_ID + - EMAIL + - INTERNATIONAL_BANK_ACCOUNT_NUMBER + - IP_ADDRESS + - LICENSE_PLATE + - MAC_ADDRESS + - NAME + - PASSWORD + - PHONE + - PIN + - SWIFT_CODE + - UK_NATIONAL_HEALTH_SERVICE_NUMBER + - UK_NATIONAL_INSURANCE_NUMBER + - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER + - URL + - USERNAME + - US_BANK_ACCOUNT_NUMBER + - US_BANK_ROUTING_NUMBER + - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER + - US_PASSPORT_NUMBER + - US_SOCIAL_SECURITY_NUMBER + - VEHICLE_IDENTIFICATION_NUMBER + InvokeGuardrailChecksResponse: + type: object + properties: + results: + $ref: "#/components/schemas/GuardrailChecksResults" + description: The per-check results containing findings from the guardrail evaluation. + usage: + $ref: "#/components/schemas/GuardrailChecksUsageResults" + description: The per-check text unit consumption for the guardrail evaluation. + required: + - results + - usage + GuardrailChecksResults: + description: The results from the guardrail checks evaluation, organized by check type. + type: object + properties: + contentFilter: + $ref: "#/components/schemas/GuardrailChecksContentFilterResult" + description: The content filter check results. + promptAttack: + $ref: "#/components/schemas/GuardrailChecksPromptAttackResult" + description: The prompt attack check results. + sensitiveInformation: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResult" + description: The sensitive information check results. + GuardrailChecksContentFilterResult: + description: The content filter check results. + type: object + properties: + results: + $ref: "#/components/schemas/GuardrailChecksContentFilterResultList" + description: The per-category content filter results. + required: + - results + GuardrailChecksContentFilterResultList: + description: A list of content filter evaluation results. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksContentFilterResultEntry" + GuardrailChecksContentFilterResultEntry: + description: The evaluation result for a single content filter category. + type: object + properties: + category: + $ref: "#/components/schemas/GuardrailChecksContentFilterCategory" + description: The content filter category that was evaluated. + severityScore: + $ref: "#/components/schemas/GuardrailChecksContentFilterResultEntrySeverityScoreDouble" + description: The severity score for the category, ranging from 0.0 to 1.0. Higher values indicate greater severity. + required: + - category + - severityScore + GuardrailChecksContentFilterResultEntrySeverityScoreDouble: + type: number + format: double + minimum: 0 + maximum: 1 + GuardrailChecksPromptAttackResult: + description: The prompt attack check results. + type: object + properties: + results: + $ref: "#/components/schemas/GuardrailChecksPromptAttackResultList" + description: The per-category prompt attack results. + required: + - results + GuardrailChecksPromptAttackResultList: + description: A list of prompt attack evaluation results. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksPromptAttackResultEntry" + GuardrailChecksPromptAttackResultEntry: + description: The evaluation result for a single prompt attack category. + type: object + properties: + category: + $ref: "#/components/schemas/GuardrailChecksPromptAttackCategory" + description: The prompt attack category that was evaluated. + severityScore: + $ref: "#/components/schemas/GuardrailChecksPromptAttackResultEntrySeverityScoreDouble" + description: The severity score for the category, ranging from 0.0 to 1.0. Higher values indicate greater severity. + required: + - category + - severityScore + GuardrailChecksPromptAttackResultEntrySeverityScoreDouble: + type: number + format: double + minimum: 0 + maximum: 1 + GuardrailChecksSensitiveInformationResult: + description: The sensitive information check results. + type: object + properties: + results: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultList" + description: The detected sensitive information entities. + truncated: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the results were truncated because the number of detected entities exceeded the maximum limit. + required: + - results + GuardrailChecksSensitiveInformationResultList: + description: A list of sensitive information detection results. + type: array + items: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntry" + GuardrailChecksSensitiveInformationResultEntry: + description: The detection result for a single sensitive information entity found in the evaluated messages. + type: object + properties: + type_: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationEntityType" + description: The PII entity type that was detected. + confidenceScore: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntryConfidenceScoreDouble" + description: The confidence score for the detection, ranging from 0.0 to 1.0. Higher values indicate greater confidence. + beginOffset: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntryBeginOffsetInteger" + description: The start character offset of the detected entity within the content block. + endOffset: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntryEndOffsetInteger" + description: The end character offset of the detected entity within the content block. + messageIndex: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntryMessageIndexInteger" + description: The zero-based index of the message in the input messages array where the entity was detected. + contentIndex: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationResultEntryContentIndexInteger" + description: The zero-based index of the content block within the message where the entity was detected. + required: + - type_ + - confidenceScore + - beginOffset + - endOffset + - messageIndex + - contentIndex + GuardrailChecksSensitiveInformationResultEntryConfidenceScoreDouble: + type: number + format: double + minimum: 0 + maximum: 1 + GuardrailChecksSensitiveInformationResultEntryBeginOffsetInteger: + type: integer + minimum: 0 + GuardrailChecksSensitiveInformationResultEntryEndOffsetInteger: + type: integer + minimum: 0 + GuardrailChecksSensitiveInformationResultEntryMessageIndexInteger: + type: integer + minimum: 0 + GuardrailChecksSensitiveInformationResultEntryContentIndexInteger: + type: integer + minimum: 0 + GuardrailChecksUsageResults: + description: The text unit usage for the guardrail checks evaluation, organized by check type. + type: object + properties: + contentFilter: + $ref: "#/components/schemas/GuardrailChecksContentFilterUsage" + description: The text unit usage for the content filter check. + promptAttack: + $ref: "#/components/schemas/GuardrailChecksPromptAttackUsage" + description: The text unit usage for the prompt attack check. + sensitiveInformation: + $ref: "#/components/schemas/GuardrailChecksSensitiveInformationUsage" + description: The text unit usage for the sensitive information check. + GuardrailChecksContentFilterUsage: + description: The text unit usage for the content filter check. + type: object + properties: + textUnits: + $ref: "#/components/schemas/Integer" + description: The number of text units consumed by the content filter check. + required: + - textUnits + GuardrailChecksPromptAttackUsage: + description: The text unit usage for the prompt attack check. + type: object + properties: + textUnits: + $ref: "#/components/schemas/Integer" + description: The number of text units consumed by the prompt attack check. + required: + - textUnits + GuardrailChecksSensitiveInformationUsage: + description: The text unit usage for the sensitive information check. + type: object + properties: + textUnits: + $ref: "#/components/schemas/Integer" + description: The number of text units consumed by the sensitive information check. + required: + - textUnits MimeType: type: string InvokeModelIdentifier: @@ -3018,6 +3477,10 @@ components: - ENABLED - DISABLED - ENABLED_FULL + RequestMetadataJson: + type: string + minLength: 0 + maxLength: 8500 InvokeModelResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/billing.yaml b/providers/src/aws/v00.00.00000/services/billing.yaml index 53d90ee1..ab28aec6 100644 --- a/providers/src/aws/v00.00.00000/services/billing.yaml +++ b/providers/src/aws/v00.00.00000/services/billing.yaml @@ -177,6 +177,48 @@ paths: application/json: schema: $ref: "#/components/schemas/DisassociateSourceViewsResponse" + /GetBillingPreferences: + post: + operationId: GetBillingPreferences + description: "Retrieves billing preferences for the specified feature. Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, and per-credit options." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.GetBillingPreferences + default: AWSBilling.GetBillingPreferences + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + nextToken: + $ref: "#/components/schemas/PageToken" + description: Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results. + maxResults: + $ref: "#/components/schemas/GetBillingPreferencesRequestMaxResultsInteger" + description: "The maximum number of records to return per page. Range: 1 to 50. Default: 50." + features: + $ref: "#/components/schemas/GetBillingPreferencesRequestFeaturesList" + description: "The feature to retrieve. Specify exactly one value. Valid values: BILLING_ALERTS, RI_SHARING, RI_SHARING_HISTORY, CREDIT_SHARING, CREDIT_SHARING_HISTORY, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS." + filters: + $ref: "#/components/schemas/GetBillingPreferencesRequestFiltersList" + description: Filters to narrow results. Specify exactly one filter when supplied. The supported filter name is PREFERENCE_KEY, which accepts 1 to 10 values to match preference keys. + required: + - features + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetBillingPreferencesResponse" /GetBillingView: post: operationId: GetBillingView @@ -210,6 +252,165 @@ paths: application/json: schema: $ref: "#/components/schemas/GetBillingViewResponse" + /GetCreditAllocationHistory: + post: + operationId: GetCreditAllocationHistory + description: Returns the per-billing-month allocation history for credits applied to an Amazon Web Services account's bills. Traverses the consolidated billing family to capture cross-account credit applications. Supports pagination and optional filtering to a single credit. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.GetCreditAllocationHistory + default: AWSBilling.GetCreditAllocationHistory + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID whose allocation history to retrieve. Must be a 12-digit numeric string. + creditId: + $ref: "#/components/schemas/Long" + description: Filters the result to a single credit. When omitted, returns allocation entries for all credits. + startDate: + $ref: "#/components/schemas/Timestamp" + description: Inclusive start date as Unix epoch seconds. Must be on or before endDate. The range from startDate to endDate cannot exceed 24 billing months. + endDate: + $ref: "#/components/schemas/Timestamp" + description: Inclusive end date as Unix epoch seconds. + nextToken: + $ref: "#/components/schemas/PageToken" + description: Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results. + maxResults: + $ref: "#/components/schemas/GetCreditAllocationHistoryRequestMaxResultsInteger" + description: "The maximum number of records to return per page. Range: 1 to 1000. Default: 100." + required: + - accountId + - startDate + - endDate + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCreditAllocationHistoryResponse" + /GetCredits: + post: + operationId: GetCredits + description: Returns the list of Amazon Web Services account credits for the specified account. Each credit includes its identifier, type, monetary amounts, applicable products, expiration, sharing configuration, and current enabled status. When the caller is the management account of a consolidated billing family and payerAccountFlag is true, the response aggregates credits across the entire family. Otherwise, the response includes only credits owned by the account specified in accountId. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.GetCredits + default: AWSBilling.GetCredits + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + accountId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services account ID. Must be a 12-digit numeric string. + startDate: + $ref: "#/components/schemas/Timestamp" + description: The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date. + endDate: + $ref: "#/components/schemas/Timestamp" + description: The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after startDate. Defaults to the current date when omitted. + payerAccountFlag: + $ref: "#/components/schemas/Boolean" + description: When true and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When false or omitted, returns only credits for the specified accountId. + required: + - accountId + - startDate + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCreditsResponse" + /GetEnterpriseSupportChargeSummary: + post: + operationId: GetEnterpriseSupportChargeSummary + description: Returns a summary of Enterprise Support data aggregated across all accounts in the Enterprise Support profile. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.GetEnterpriseSupportChargeSummary + default: AWSBilling.GetEnterpriseSupportChargeSummary + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + billingMonth: + $ref: "#/components/schemas/EnterpriseSupportBillingMonth" + description: The billing month in YYYY-MM format. This must be a month in the past. + required: + - billingMonth + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEnterpriseSupportChargeSummaryResponse" + /GetEnterpriseSupportContractDetails: + post: + operationId: GetEnterpriseSupportContractDetails + description: Returns Enterprise Support contract details. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.GetEnterpriseSupportContractDetails + default: AWSBilling.GetEnterpriseSupportContractDetails + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + billingMonth: + $ref: "#/components/schemas/EnterpriseSupportBillingMonth" + description: The billing month in YYYY-MM format. This must be a month in the past. + required: + - billingMonth + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEnterpriseSupportContractDetailsResponse" /GetResourcePolicy: post: operationId: GetResourcePolicy @@ -295,6 +496,48 @@ paths: application/json: schema: $ref: "#/components/schemas/ListBillingViewsResponse" + /ListEnterpriseSupportLinkedAccountCharges: + post: + operationId: ListEnterpriseSupportLinkedAccountCharges + description: Returns Support-eligible spend broken down at linked account level. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.ListEnterpriseSupportLinkedAccountCharges + default: AWSBilling.ListEnterpriseSupportLinkedAccountCharges + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + billingMonth: + $ref: "#/components/schemas/EnterpriseSupportBillingMonth" + description: The billing month in YYYY-MM format. This must be a month in the past. + accountId: + $ref: "#/components/schemas/AccountId" + description: An optional linked account ID to filter results to a specific account. + maxResults: + $ref: "#/components/schemas/ListEnterpriseSupportLinkedAccountChargesRequestMaxResultsInteger" + description: The maximum number of results to return per page. + nextToken: + $ref: "#/components/schemas/PageToken" + description: The pagination token for the next page of results. + required: + - billingMonth + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListEnterpriseSupportLinkedAccountChargesResponse" /ListSourceViewsForBillingView: post: operationId: ListSourceViewsForBillingView @@ -367,6 +610,39 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" + /RedeemCredits: + post: + operationId: RedeemCredits + description: Redeems an Amazon Web Services promotional credit code on behalf of the calling account. On success, a new credit is added to the account's credit ledger with the amount, validity period, and applicable products defined by the promotion. The credit is then automatically applied to subsequent bills according to the standard credit application order. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.RedeemCredits + default: AWSBilling.RedeemCredits + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + promoCode: + $ref: "#/components/schemas/PromoCode" + description: The promotional credit code to redeem. + required: + - promoCode + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RedeemCreditsResponse" /TagResource: post: operationId: TagResource @@ -441,6 +717,43 @@ paths: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" + /UpdateBillingPreferences: + post: + operationId: UpdateBillingPreferences + description: Updates billing preferences for the specified feature. Each feature targets a distinct billing capability and has its own set of supported keys. The action sets the value for each provided key; keys not present in the request are unchanged. Sharing keys (RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, and sharing keys under CREDIT_PREFERENCE_OPTIONS) may only be set by the management account of a consolidated billing family. The credit/{creditId}/status key may be set by member accounts for credits they own, or by the management account for any credit in the family. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSBilling.UpdateBillingPreferences + default: AWSBilling.UpdateBillingPreferences + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + feature: + $ref: "#/components/schemas/BillingFeature" + description: "The feature to update. Valid values: BILLING_ALERTS, RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS. The history features (RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY) are read-only and cannot be updated." + billingPreferencesPerKey: + $ref: "#/components/schemas/BillingPreferencesPerKey" + description: Key/value pairs to apply. All keys in a single request must be valid for the specified feature and must not be duplicated. For CREDIT_PREFERENCE_OPTIONS, all keys must reference the same creditId. + required: + - feature + - billingPreferencesPerKey + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateBillingPreferencesResponse" /UpdateBillingView: post: operationId: UpdateBillingView @@ -700,6 +1013,135 @@ components: description: The ARN of the billing view that the source views were disassociated from. required: - arn + PageToken: + type: string + minLength: 1 + maxLength: 4095 + pattern: "[-a-zA-Z0-9+=/_]+" + GetBillingPreferencesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + GetBillingPreferencesRequestFeaturesList: + type: array + items: + $ref: "#/components/schemas/BillingFeature" + BillingFeature: + type: string + enum: + - RI_SHARING + - RI_SHARING_HISTORY + - CREDIT_SHARING + - CREDIT_SHARING_HISTORY + - CREDIT_LEVEL_SHARING + - BILLING_ALERTS + - CREDIT_PREFERENCE_OPTIONS + GetBillingPreferencesRequestFiltersList: + type: array + items: + $ref: "#/components/schemas/BillingFeatureFilter" + BillingFeatureFilter: + description: A filter that narrows the set of preferences returned by GetBillingPreferences. + type: object + properties: + name: + $ref: "#/components/schemas/BillingFeatureFilterName" + description: The filter name. Currently the only supported value is PREFERENCE_KEY. + value: + $ref: "#/components/schemas/BillingFeatureFilterValues" + description: The filter values to match. For PREFERENCE_KEY, supply 1 to 10 preference key values to match. + BillingFeatureFilterName: + type: string + enum: + - PREFERENCE_KEY + BillingFeatureFilterValues: + type: array + items: + $ref: "#/components/schemas/BillingFeatureFilterValue" + BillingFeatureFilterValue: + type: string + minLength: 1 + maxLength: 100 + pattern: "[a-zA-Z0-9-/]+" + GetBillingPreferencesResponse: + type: object + properties: + billingPreferences: + $ref: "#/components/schemas/BillingPreferences" + description: The list of preference entries matching the request. + nextToken: + $ref: "#/components/schemas/PageToken" + description: Pagination token. Present when more pages are available; null when there are no more results. + required: + - billingPreferences + BillingPreferences: + type: array + items: + $ref: "#/components/schemas/BillingPreferenceSummary" + BillingPreferenceSummary: + description: A single billing preference entry returned by GetBillingPreferences. + type: object + properties: + feature: + $ref: "#/components/schemas/BillingFeature" + description: The feature this preference belongs to. + key: + $ref: "#/components/schemas/PreferenceKey" + description: The preference key. Format depends on the feature. + value: + $ref: "#/components/schemas/PreferenceValue" + description: "The preference value. Valid values: ENABLED or DISABLED." + accountName: + $ref: "#/components/schemas/AccountName" + description: The display name of the account. Populated together with accountId; null otherwise. + accountId: + $ref: "#/components/schemas/AccountId" + description: The associated Amazon Web Services account ID. Populated for account-list keys; null otherwise. + billingPeriod: + $ref: "#/components/schemas/BillingPeriod" + description: The billing period associated with the preference change. Populated only for the history features RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY. + required: + - feature + - key + - value + PreferenceKey: + type: string + minLength: 1 + maxLength: 2148 + pattern: "[a-zA-Z0-9-\\/\\*: ]+" + PreferenceValue: + type: string + enum: + - ENABLED + - DISABLED + AccountName: + type: string + minLength: 1 + maxLength: 50 + AccountId: + type: string + pattern: "[0-9]{12}" + BillingPeriod: + description: A specific billing period identified by year and month. + type: object + properties: + year: + $ref: "#/components/schemas/BillingYear" + description: The four-digit year of the billing period. + month: + $ref: "#/components/schemas/Month" + description: The month of the billing period as an integer between 1 and 12. + required: + - year + - month + BillingYear: + type: integer + minimum: 2005 + maximum: 2120 + Month: + type: integer + minimum: 1 + maximum: 12 GetBillingViewResponse: type: object properties: @@ -759,9 +1201,6 @@ components: - CUSTOM - BILLING_TRANSFER - BILLING_TRANSFER_SHOWBACK - AccountId: - type: string - pattern: "[0-9]{12}" Integer: type: integer BillingViewHealthStatus: @@ -796,12 +1235,475 @@ components: - SOURCE_VIEW_DEPTH_EXCEEDED - AGGREGATE_SOURCE - VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT - ResourceArn: - type: string - pattern: arn:aws[a-z-]*:(billing)::[0-9]{12}:[a-zA-Z0-9/:_\+=\.\@-]{0,70}[a-zA-Z0-9] - GetResourcePolicyResponse: - type: object - properties: + Long: + type: integer + format: int64 + GetCreditAllocationHistoryRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + GetCreditAllocationHistoryResponse: + type: object + properties: + creditAllocationHistoryList: + $ref: "#/components/schemas/CreditAllocationHistoryList" + description: Allocation entries sorted by billingMonth in descending order. + partialResults: + $ref: "#/components/schemas/Boolean" + description: true when data could not be retrieved for one or more billing months. The failedMonths field lists which months are missing. + failedMonths: + $ref: "#/components/schemas/FailedMonthsList" + description: Billing months in YYYY-MM format that failed to return data. Non-empty only when partialResults is true. + nextToken: + $ref: "#/components/schemas/PageToken" + description: Pagination token. Present when more pages are available; null when there are no more results. + required: + - partialResults + CreditAllocationHistoryList: + type: array + items: + $ref: "#/components/schemas/CreditAllocationHistoryEntry" + CreditAllocationHistoryEntry: + description: A single entry in the credit allocation history, representing how a credit was applied to a specific service during a billing month. + type: object + properties: + creditId: + $ref: "#/components/schemas/CreditId" + description: The identifier of the credit that was applied. + creditAmount: + $ref: "#/components/schemas/Amount" + description: The amount of credit applied. Negative values represent credits that reduced the bill. + description: + $ref: "#/components/schemas/String" + description: A human-readable description of the credit allocation. + accountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account the credit was applied to. + appliedServiceName: + $ref: "#/components/schemas/String" + description: The Amazon Web Services service the credit was applied to. + billingMonth: + $ref: "#/components/schemas/BillingMonth" + description: The billing month of the application in YYYY-MM format. + isEstimatedBill: + $ref: "#/components/schemas/Boolean" + description: true when the entry was applied to an in-flight bill that has not yet been finalized. + required: + - creditId + - creditAmount + - accountId + - appliedServiceName + - billingMonth + - isEstimatedBill + CreditId: + type: string + minLength: 1 + maxLength: 32 + pattern: "[0-9]+" + Amount: + description: A monetary amount with a currency code. Used throughout the Billing API to represent credit balances, allocations, and adjustments. + type: object + properties: + currencyCode: + $ref: "#/components/schemas/CurrencyCode" + description: The ISO 4217 currency code for the amount (for example, USD). + currencyAmount: + $ref: "#/components/schemas/CurrencyAmount" + description: The amount as a decimal string (for example, "743.21"). Negative values represent credits that reduce a bill. + required: + - currencyCode + - currencyAmount + CurrencyCode: + type: string + pattern: "[A-Z]{3}" + CurrencyAmount: + type: string + pattern: "[0-9]+(.[0-9]+)" + String: + type: string + BillingMonth: + type: string + minLength: 1 + maxLength: 7 + FailedMonthsList: + type: array + items: + $ref: "#/components/schemas/BillingMonth" + GetCreditsResponse: + type: object + properties: + credits: + $ref: "#/components/schemas/CreditDataList" + description: The list of credits matching the request. Returns an empty list when no credits exist. + CreditDataList: + type: array + items: + $ref: "#/components/schemas/CreditData" + CreditData: + description: Detailed information about an Amazon Web Services credit, including its identifier, type, monetary amounts, applicable products, sharing configuration, and current enabled status. + type: object + properties: + creditId: + $ref: "#/components/schemas/CreditId" + description: The unique identifier for the credit. + accountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID that owns the credit. + creditType: + $ref: "#/components/schemas/String" + description: "The type of credit. Examples: Promotion, Refund, TrueUp." + initialAmount: + $ref: "#/components/schemas/Amount" + description: The initial amount of the credit when it was issued. + remainingAmount: + $ref: "#/components/schemas/Amount" + description: The unused balance of the credit. + estimatedAmount: + $ref: "#/components/schemas/Amount" + description: The estimated remaining balance, including in-flight (open) bills that have not yet been finalized. + applicableProductNames: + $ref: "#/components/schemas/ProductNames" + description: The names of Amazon Web Services services this credit applies to. + description: + $ref: "#/components/schemas/String" + description: A human-readable description of the credit. + startDate: + $ref: "#/components/schemas/Timestamp" + description: The date the credit becomes valid, as Unix epoch seconds. + endDate: + $ref: "#/components/schemas/Timestamp" + description: The date the credit expires, as Unix epoch seconds. + exhaustDate: + $ref: "#/components/schemas/Timestamp" + description: The date the credit balance reached zero, as Unix epoch seconds. + applicationType: + $ref: "#/components/schemas/ApplicationType" + description: "When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS." + shareableAccounts: + $ref: "#/components/schemas/ShareableAccountIds" + description: The Amazon Web Services account IDs entitled to apply this credit. + accountHasCreditSharingEnabled: + $ref: "#/components/schemas/Boolean" + description: Whether the owning account has account-level credit sharing turned on. + creditConsoleVisibility: + $ref: "#/components/schemas/String" + description: The display configuration for the credit in the Amazon Web Services Billing console. + creditSharingType: + $ref: "#/components/schemas/CreditSharingType" + description: "The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE." + costCategoryArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when creditSharingType is COST_CATEGORY_RULE. + ruleName: + $ref: "#/components/schemas/String" + description: The rule name within the Cost Category. Present only when creditSharingType is COST_CATEGORY_RULE. + creditStatus: + $ref: "#/components/schemas/CreditStatus" + description: "Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED." + purchaseTypeApplications: + $ref: "#/components/schemas/PurchaseTypeApplications" + description: Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types. + required: + - creditId + - accountId + - creditType + - initialAmount + - remainingAmount + - description + - startDate + ProductNames: + type: array + items: + $ref: "#/components/schemas/ProductName" + ProductName: + type: string + minLength: 1 + maxLength: 128 + ApplicationType: + type: string + enum: + - BEFORE_CROSS_SERVICE_DISCOUNTS + - AFTER_DISCOUNTS + ShareableAccountIds: + type: array + items: + $ref: "#/components/schemas/AccountId" + CreditSharingType: + type: string + enum: + - DEFAULT + - DISABLED + - CUSTOM + - COST_CATEGORY_RULE + CreditStatus: + type: string + enum: + - ENABLED + - DISABLED + PurchaseTypeApplications: + type: array + items: + $ref: "#/components/schemas/PurchaseType" + PurchaseType: + type: string + minLength: 1 + maxLength: 64 + EnterpriseSupportBillingMonth: + description: The billing month in YYYY-MM format. This must be a month in the past. + type: string + pattern: \d{4}-(0[1-9]|1[0-2]) + GetEnterpriseSupportChargeSummaryResponse: + description: The response structure for GetEnterpriseSupportChargeSummary. + type: object + properties: + payerAccountId: + $ref: "#/components/schemas/AccountId" + description: The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile. + billingMonth: + $ref: "#/components/schemas/EnterpriseSupportBillingMonth" + description: The billing month in YYYY-MM format. This must be a month in the past. + billingPeriodStartDate: + $ref: "#/components/schemas/Timestamp" + description: The start date of the billing period. + billingPeriodEndDate: + $ref: "#/components/schemas/Timestamp" + description: The end date of the billing period. + isEstimated: + $ref: "#/components/schemas/Boolean" + description: When true, the Support charge amount is estimated. When false, the Support charge amount is finalized. + billDate: + $ref: "#/components/schemas/Timestamp" + description: The date the bill was generated. + supportCharge: + $ref: "#/components/schemas/String" + description: The Support charge amount for the account. + totalSupportCharge: + $ref: "#/components/schemas/String" + description: The total Support charge amount for all accounts in the Support profile. + supportDiscount: + $ref: "#/components/schemas/String" + description: The support discount amount. + totalSupportEligibleSpend: + $ref: "#/components/schemas/String" + description: The total Support-eligible Spend from all accounts in the Support profile. This includes eligible spend from usage of Amazon Web Services, Reserved Instances, and Savings Plans. + totalSupportEligibleUsageSpend: + $ref: "#/components/schemas/String" + description: The total Support-eligible spend from usage of Amazon Web Services from all accounts in the Support profile. + totalSupportEligibleReservedInstanceSpend: + $ref: "#/components/schemas/String" + description: The total Support-eligible Reserved Instance spend from all accounts in the Support profile. + totalSupportEligibleSavingsPlanSpend: + $ref: "#/components/schemas/String" + description: The total Support-eligible Savings Plan spend from all accounts in the Support profile. + supportChargePercentage: + $ref: "#/components/schemas/String" + description: The percentage applied to the total Support-eligible spend to calculate the total Support charge across all accounts in the Support profile. + supportEffectivePricingPlan: + $ref: "#/components/schemas/PricingPlan" + description: The effective pricing plan used for the support charge calculation. + required: + - payerAccountId + - billingMonth + - billingPeriodStartDate + - billingPeriodEndDate + - isEstimated + - billDate + - supportCharge + - totalSupportCharge + - supportDiscount + - totalSupportEligibleSpend + - totalSupportEligibleUsageSpend + - totalSupportEligibleReservedInstanceSpend + - totalSupportEligibleSavingsPlanSpend + - supportChargePercentage + - supportEffectivePricingPlan + PricingPlan: + description: A pricing plan for Enterprise Support billing. + type: object + properties: + pricingPlanId: + $ref: "#/components/schemas/String" + description: The unique identifier for the pricing plan. + name: + $ref: "#/components/schemas/String" + description: The name of the pricing plan. + description: + $ref: "#/components/schemas/String" + description: A description of the pricing plan. + startDate: + $ref: "#/components/schemas/Timestamp" + description: The start date of the pricing plan. + endDate: + $ref: "#/components/schemas/Timestamp" + description: The end date of the pricing plan. + planDiscountPercent: + $ref: "#/components/schemas/String" + description: The discount percentage applied by this pricing plan. + discountAppliesToMinimumCharge: + $ref: "#/components/schemas/Boolean" + description: Whether the discount applies to the minimum Support charge. + minimumCharge: + $ref: "#/components/schemas/String" + description: The minimum Support charge amount for this pricing plan. + tiered: + $ref: "#/components/schemas/String" + description: Whether the pricing plan uses tiered pricing. + tiers: + $ref: "#/components/schemas/PricingPlanTierList" + description: The pricing tiers within this plan. + required: + - tiers + PricingPlanTierList: + description: A list of pricing plan tiers. + type: array + items: + $ref: "#/components/schemas/PricingPlanTier" + PricingPlanTier: + description: A tier within an Enterprise Support pricing plan. + type: object + properties: + tierMinimum: + $ref: "#/components/schemas/String" + description: The minimum spend threshold for this tier. + tierMaximum: + $ref: "#/components/schemas/String" + description: The maximum spend threshold for this tier. + baseCharge: + $ref: "#/components/schemas/String" + description: The base charge for this tier. + additionalPercentageOfAggregateCharges: + $ref: "#/components/schemas/String" + description: The additional percentage applied to aggregate charges in this tier. + aggregateChargesAdjustment: + $ref: "#/components/schemas/String" + description: The adjustment applied to aggregate charges. + incremental: + $ref: "#/components/schemas/Boolean" + description: Whether the tier charges are calculated incrementally. + increment: + $ref: "#/components/schemas/String" + description: The increment amount for incremental tier calculations. + incrementCharge: + $ref: "#/components/schemas/String" + description: The charge per increment. + required: + - tierMinimum + - baseCharge + - additionalPercentageOfAggregateCharges + - aggregateChargesAdjustment + - incremental + GetEnterpriseSupportContractDetailsResponse: + description: The response structure for GetEnterpriseSupportContractDetails. + type: object + properties: + isContractActive: + $ref: "#/components/schemas/Boolean" + description: When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive. + supportAllocationMethod: + $ref: "#/components/schemas/String" + description: "The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract." + supportReservedInstanceAmortizationStartDate: + $ref: "#/components/schemas/Timestamp" + description: When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods. + supportReservedInstanceTreatmentMethod: + $ref: "#/components/schemas/String" + description: "The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started)." + supportSavingsPlansAmortizationStartDate: + $ref: "#/components/schemas/Timestamp" + description: This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend. + supportSavingsPlansTreatmentMethod: + $ref: "#/components/schemas/String" + description: "The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started)." + supportProrateStartDate: + $ref: "#/components/schemas/Timestamp" + description: The start date for accounts subscribed or unsubscribed to Support billing during the billing month. + contractPayerAccountIds: + $ref: "#/components/schemas/ContractAccountList" + description: The list of accounts covered by the Enterprise Support contract. + chargedPayerAccountIds: + $ref: "#/components/schemas/ChargeAccountList" + description: The list of payer accounts and their charge allocation percentages. + additionalSupportCharge: + $ref: "#/components/schemas/AdditionalChargeList" + description: Any Additional support charges applied to the contract. + additionalSupportEligibleUsageSpend: + $ref: "#/components/schemas/AdditionalChargeList" + description: Any Additional support-eligible usage spend charges. + pricingPlans: + $ref: "#/components/schemas/PricingPlanList" + description: The pricing plans associated with this Enterprise Support contract. + required: + - supportAllocationMethod + - contractPayerAccountIds + - chargedPayerAccountIds + - pricingPlans + ContractAccountList: + description: A list of accounts that appear in the Enterprise Support Contract. + type: array + items: + $ref: "#/components/schemas/ContractAccount" + ContractAccount: + description: An account that is covered by the Enterprise Support contract. + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" + description: The account ID. + isGdn: + $ref: "#/components/schemas/Boolean" + description: When true, Support charges are calculated on charges before private discounts. When false, they are calculated after private discounts. + required: + - accountId + - isGdn + ChargeAccountList: + description: A list of charge accounts. + type: array + items: + $ref: "#/components/schemas/ChargeAccount" + ChargeAccount: + description: An account that is charged all or a portion of the total Support charge and the percentage of the charge allocated to it. + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" + description: The account ID. + chargePercentage: + $ref: "#/components/schemas/String" + description: The percentage of the total Support charge allocated to this account. This is 0.0 when supportAllocationMethod = Proportional. + required: + - accountId + - chargePercentage + AdditionalChargeList: + description: A list of additional charges. + type: array + items: + $ref: "#/components/schemas/AdditionalCharge" + AdditionalCharge: + description: An additional charge applied to an Enterprise Support contract. + type: object + properties: + description: + $ref: "#/components/schemas/String" + description: A description of the additional charge. + amount: + $ref: "#/components/schemas/String" + description: The charge amount. + chargeType: + $ref: "#/components/schemas/String" + description: The type of additional charge. + required: + - description + PricingPlanList: + description: A list of pricing plans. + type: array + items: + $ref: "#/components/schemas/PricingPlan" + ResourceArn: + type: string + pattern: arn:aws[a-z-]*:(billing)::[0-9]{12}:[a-zA-Z0-9/:_\+=\.\@-]{0,70}[a-zA-Z0-9] + GetResourcePolicyResponse: + type: object + properties: resourceArn: $ref: "#/components/schemas/ResourceArn" description: The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to. @@ -863,10 +1765,6 @@ components: type: integer minimum: 1 maximum: 100 - PageToken: - type: string - minLength: 1 - maxLength: 2047 ListBillingViewsResponse: type: object properties: @@ -907,6 +1805,106 @@ components: healthStatus: $ref: "#/components/schemas/BillingViewHealthStatus" description: The current health status of the billing view. + ListEnterpriseSupportLinkedAccountChargesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListEnterpriseSupportLinkedAccountChargesResponse: + description: The response structure for ListEnterpriseSupportLinkedAccountCharges. + type: object + properties: + linkedAccount: + $ref: "#/components/schemas/LinkedAccountChargeList" + description: The list of Enterprise Support charges per linked account. + nextToken: + $ref: "#/components/schemas/PageToken" + description: The pagination token for the next page of results. + required: + - linkedAccount + LinkedAccountChargeList: + description: A list of linked account charges. + type: array + items: + $ref: "#/components/schemas/LinkedAccountCharge" + LinkedAccountCharge: + description: Enterprise Support charges for a linked account. + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" + description: The linked account ID. + payerAccountId: + $ref: "#/components/schemas/AccountId" + description: The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile. + accountType: + $ref: "#/components/schemas/String" + description: The type of account. + billableSeconds: + $ref: "#/components/schemas/Long" + description: The number of billable seconds in the billing period based on when the account was subscribed to Enterprise Support. + totalSeconds: + $ref: "#/components/schemas/Long" + description: The total number of seconds in the billing period. + totalSupportEligibleSpend: + $ref: "#/components/schemas/String" + description: The total support-eligible spend for this account. + proratedTotalSupportEligibleSpend: + $ref: "#/components/schemas/String" + description: The prorated total support-eligible spend based on when the account was subscribed to Enterprise Support. + linkedTimePeriods: + $ref: "#/components/schemas/TimePeriodList" + description: The time periods during which this account was linked. + subscriptionTimePeriods: + $ref: "#/components/schemas/TimePeriodList" + description: The subscription time periods for this account. + totalSupportEligibleReservedInstanceSpend: + $ref: "#/components/schemas/String" + description: The total support-eligible Reserved Instance spend for this account. + totalSupportEligibleSavingsPlanSpend: + $ref: "#/components/schemas/String" + description: The total support-eligible Savings Plan spend for this account. + supportEligibleSpendByService: + $ref: "#/components/schemas/ServiceLevelAccountUsageList" + description: The support-eligible spend broken down by service. + required: + - accountId + - payerAccountId + - billableSeconds + - totalSeconds + - totalSupportEligibleSpend + - proratedTotalSupportEligibleSpend + TimePeriodList: + description: A list of time periods. + type: array + items: + $ref: "#/components/schemas/EnterpriseSupportTimePeriod" + EnterpriseSupportTimePeriod: + description: A time period for Enterprise Support billing. + type: object + properties: + beginDate: + $ref: "#/components/schemas/Timestamp" + description: The begin date of the time period. + endDate: + $ref: "#/components/schemas/Timestamp" + description: The end date of the time period. + required: + - beginDate + ServiceLevelAccountUsageList: + description: A list of service-level account usages. + type: array + items: + $ref: "#/components/schemas/ServiceLevelAccountUsage" + ServiceLevelAccountUsage: + description: Service-level usage details by account. + type: object + properties: + serviceCode: + $ref: "#/components/schemas/String" + description: The service code for which to return Support-eligible spend data. + totalSupportEligibleSpend: + $ref: "#/components/schemas/String" + description: The total support-eligible spend for the service. ListSourceViewsForBillingViewRowDisplay: type: object properties: @@ -926,6 +1924,13 @@ components: resourceTags: $ref: "#/components/schemas/ResourceTagList" description: A list of tag key value pairs that are associated with the resource. + PromoCode: + type: string + minLength: 1 + maxLength: 256 + pattern: .*[^<>"&\%|' ]*.* + RedeemCreditsResponse: + type: object TagResourceResponse: type: object ResourceTagKeyList: @@ -934,6 +1939,25 @@ components: $ref: "#/components/schemas/ResourceTagKey" UntagResourceResponse: type: object + BillingPreferencesPerKey: + type: array + items: + $ref: "#/components/schemas/BillingPreferenceForKey" + BillingPreferenceForKey: + description: A single key/value entry used to update a billing preference. + type: object + properties: + key: + $ref: "#/components/schemas/PreferenceKey" + description: The preference key. Format depends on the feature being updated. + value: + $ref: "#/components/schemas/PreferenceValue" + description: "The preference value. Valid values: ENABLED or DISABLED." + required: + - key + - value + UpdateBillingPreferencesResponse: + type: object UpdateBillingViewResponse: type: object properties: @@ -1072,6 +2096,161 @@ components: - $ref: "#/components/x-stackQL-resources/billing_views/methods/update_billing_view" delete: - $ref: "#/components/x-stackQL-resources/billing_views/methods/delete_billing_view" + billing_preferences: + id: aws.billing.billing_preferences + name: billing_preferences + title: billing_preferences + methods: + get_billing_preferences: + operation: + $ref: "#/paths/~1GetBillingPreferences/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_billing_preferences: + operation: + $ref: "#/paths/~1UpdateBillingPreferences/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/billing_preferences/methods/get_billing_preferences" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/billing_preferences/methods/update_billing_preferences" + delete: [] + credit_allocation_histories: + id: aws.billing.credit_allocation_histories + name: credit_allocation_histories + title: credit_allocation_histories + methods: + get_credit_allocation_history: + operation: + $ref: "#/paths/~1GetCreditAllocationHistory/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.creditAllocationHistoryList + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/credit_allocation_histories/methods/get_credit_allocation_history" + insert: [] + update: [] + delete: [] + credits: + id: aws.billing.credits + name: credits + title: credits + methods: + get_credits: + operation: + $ref: "#/paths/~1GetCredits/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + redeem_credits: + operation: + $ref: "#/paths/~1RedeemCredits/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/credits/methods/get_credits" + insert: [] + update: [] + delete: [] + enterprise_support_charge_summaries: + id: aws.billing.enterprise_support_charge_summaries + name: enterprise_support_charge_summaries + title: enterprise_support_charge_summaries + methods: + get_enterprise_support_charge_summary: + operation: + $ref: "#/paths/~1GetEnterpriseSupportChargeSummary/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/enterprise_support_charge_summaries/methods/get_enterprise_support_charge_summary" + insert: [] + update: [] + delete: [] + enterprise_support_contract_details: + id: aws.billing.enterprise_support_contract_details + name: enterprise_support_contract_details + title: enterprise_support_contract_details + methods: + get_enterprise_support_contract_details: + operation: + $ref: "#/paths/~1GetEnterpriseSupportContractDetails/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/enterprise_support_contract_details/methods/get_enterprise_support_contract_details" + insert: [] + update: [] + delete: [] resource_policies: id: aws.billing.resource_policies name: resource_policies @@ -1096,6 +2275,38 @@ components: insert: [] update: [] delete: [] + enterprise_support_linked_account_charges: + id: aws.billing.enterprise_support_linked_account_charges + name: enterprise_support_linked_account_charges + title: enterprise_support_linked_account_charges + methods: + list_enterprise_support_linked_account_charges: + operation: + $ref: "#/paths/~1ListEnterpriseSupportLinkedAccountCharges/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.linkedAccount + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/enterprise_support_linked_account_charges/methods/list_enterprise_support_linked_account_charges" + insert: [] + update: [] + delete: [] source_views_for_billing_views: id: aws.billing.source_views_for_billing_views name: source_views_for_billing_views diff --git a/providers/src/aws/v00.00.00000/services/budgets.yaml b/providers/src/aws/v00.00.00000/services/budgets.yaml index c42cee06..9187a267 100644 --- a/providers/src/aws/v00.00.00000/services/budgets.yaml +++ b/providers/src/aws/v00.00.00000/services/budgets.yaml @@ -1175,7 +1175,7 @@ components: properties: BudgetName: $ref: "#/components/schemas/BudgetName" - description: "The name of a budget. The name must be unique within an account. The : and \\ characters, and the \"/action/\" substring, aren't allowed in BudgetName." + description: "The name of a budget. The name must be unique within an account. The : and \\ characters, and the \"/action/\" substring, aren't allowed in BudgetName. Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected." BudgetLimit: $ref: "#/components/schemas/Spend" description: The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget. BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions. @@ -1225,7 +1225,7 @@ components: - TimeUnit - BudgetType BudgetName: - description: A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed. + description: A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed. Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected. type: string minLength: 1 maxLength: 100 diff --git a/providers/src/aws/v00.00.00000/services/ce.yaml b/providers/src/aws/v00.00.00000/services/ce.yaml index b6ad0cc0..92d91196 100644 --- a/providers/src/aws/v00.00.00000/services/ce.yaml +++ b/providers/src/aws/v00.00.00000/services/ce.yaml @@ -3024,6 +3024,9 @@ components: LookBackTimePeriod: $ref: "#/components/schemas/DateInterval" description: The time period associated with the analysis. + SavingsPlansTargetCoverage: + $ref: "#/components/schemas/SavingsPlansTargetCoverage" + description: Specifies the target Savings Plans coverage as a percentage from 10 to 100. This field is required when AnalysisType is TARGET_AVERAGE_COVERAGE. It defines the target average hourly coverage that the recommended Savings Plans commitment should achieve over the lookback period. required: - AnalysisType - SavingsPlansToAdd @@ -3043,6 +3046,7 @@ components: enum: - MAX_SAVINGS - CUSTOM_COMMITMENT + - TARGET_AVERAGE_COVERAGE SavingsPlansToAdd: type: array items: @@ -3107,6 +3111,10 @@ components: minLength: 36 maxLength: 36 pattern: ^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$ + SavingsPlansTargetCoverage: + type: integer + minimum: 10 + maximum: 100 MetricNames: type: array items: diff --git a/providers/src/aws/v00.00.00000/services/chime_sdk_voice.yaml b/providers/src/aws/v00.00.00000/services/chime_sdk_voice.yaml index 375b9770..2f4986de 100644 --- a/providers/src/aws/v00.00.00000/services/chime_sdk_voice.yaml +++ b/providers/src/aws/v00.00.00000/services/chime_sdk_voice.yaml @@ -25,7 +25,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -160,7 +160,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/NextTokenString" description: The token used to retrieve the next page of results. - name: max-results in: query @@ -178,13 +178,13 @@ paths: /voice-connectors/{voice_connector_id}/proxy-sessions: post: operationId: CreateProxySession - description: Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. + description: "Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -219,13 +219,13 @@ paths: $ref: "#/components/schemas/CreateProxySessionResponse" get: operationId: ListProxySessions - description: Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. + description: "Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: status in: query @@ -365,6 +365,7 @@ paths: required: - TriggerType - TriggerValue + - TargetApplications responses: "201": description: Success @@ -474,6 +475,8 @@ paths: $ref: "#/components/schemas/VoiceConnectorGroupName" VoiceConnectorItems: $ref: "#/components/schemas/VoiceConnectorItemList" + CallDistributionType: + $ref: "#/components/schemas/CallDistributionType" required: - Name responses: @@ -677,13 +680,13 @@ paths: /voice-connectors/{voice_connector_id}/proxy-sessions/{proxy_session_id}: delete: operationId: DeleteProxySession - description: Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. + description: "Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: proxy_session_id in: path @@ -696,13 +699,13 @@ paths: description: Success get: operationId: GetProxySession - description: Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. + description: "Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: proxy_session_id in: path @@ -719,13 +722,13 @@ paths: $ref: "#/components/schemas/GetProxySessionResponse" post: operationId: UpdateProxySession - description: Updates the specified proxy session details, such as voice or SMS capabilities. + description: "Updates the specified proxy session details, such as voice or SMS capabilities. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: proxy_session_id in: path @@ -882,7 +885,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": @@ -895,7 +898,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -912,7 +915,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -944,7 +947,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": @@ -957,7 +960,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -974,7 +977,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1003,7 +1006,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The ID of the Voice Connector for which to delete the external system configuration. responses: "204": @@ -1016,7 +1019,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The ID of the Voice Connector for which to return information about the external system configuration. responses: "200": @@ -1033,7 +1036,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The ID of the Voice Connector for which to add the external system configuration. requestBody: required: false @@ -1105,6 +1108,8 @@ paths: $ref: "#/components/schemas/VoiceConnectorGroupName" VoiceConnectorItems: $ref: "#/components/schemas/VoiceConnectorItemList" + CallDistributionType: + $ref: "#/components/schemas/CallDistributionType" required: - Name - VoiceConnectorItems @@ -1124,7 +1129,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": @@ -1137,7 +1142,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1154,7 +1159,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1175,26 +1180,26 @@ paths: /voice-connectors/{voice_connector_id}/programmable-numbers/proxy: delete: operationId: DeleteVoiceConnectorProxy - description: Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. + description: "Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": description: Success get: operationId: GetVoiceConnectorProxy - description: Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. + description: "Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1205,13 +1210,13 @@ paths: $ref: "#/components/schemas/GetVoiceConnectorProxyResponse" put: operationId: PutVoiceConnectorProxy - description: Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. + description: "Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions." parameters: - name: voice_connector_id in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1247,7 +1252,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": @@ -1260,7 +1265,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1277,7 +1282,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1306,7 +1311,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "204": @@ -1319,7 +1324,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1336,7 +1341,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1363,7 +1368,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1506,7 +1511,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1572,7 +1577,7 @@ paths: description: Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account. parameters: [] requestBody: - required: false + required: true content: application/json: schema: @@ -1580,6 +1585,8 @@ paths: properties: VoiceConnector: $ref: "#/components/schemas/VoiceConnectorSettings" + required: + - VoiceConnector responses: "204": description: Success @@ -1728,7 +1735,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: speaker_search_task_id in: path @@ -1752,7 +1759,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1769,7 +1776,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -1798,7 +1805,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1816,7 +1823,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: voice_tone_analysis_task_id in: path @@ -1942,7 +1949,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. responses: "200": @@ -1960,7 +1967,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: false @@ -2061,7 +2068,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -2097,7 +2104,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. requestBody: required: true @@ -2131,7 +2138,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: speaker_search_task_id in: path @@ -2151,7 +2158,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. - name: voice_tone_analysis_task_id in: path @@ -2326,9 +2333,9 @@ components: schema: type: string schemas: - NonEmptyString: + VoiceConnectorId: type: string - pattern: .*\S.* + pattern: ([a-z0-9]{21,22}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) E164PhoneNumberList: type: array items: @@ -2383,8 +2390,12 @@ components: - VoiceConnectorGroupAssociationsExist - PhoneNumberAssociationsExist - Gone + - Validation String: type: string + NonEmptyString: + type: string + pattern: .*\S.* AssociatePhoneNumbersWithVoiceConnectorGroupResponse: type: object properties: @@ -2474,7 +2485,7 @@ components: $ref: "#/components/schemas/Iso8601Timestamp" description: The updated phone number order time stamp, in ISO 8601 format. FocDate: - $ref: "#/components/schemas/Iso8601Timestamp" + $ref: "#/components/schemas/String" description: The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order. GuidString: type: string @@ -2521,11 +2532,6 @@ components: Iso8601Timestamp: type: string format: date-time - NonEmptyString128: - type: string - minLength: 1 - maxLength: 128 - pattern: .*\S.* ParticipantPhoneNumberList: type: array items: @@ -2585,7 +2591,7 @@ components: type: object properties: VoiceConnectorId: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. ProxySessionId: $ref: "#/components/schemas/NonEmptyString128" @@ -2623,6 +2629,11 @@ components: GeoMatchParams: $ref: "#/components/schemas/GeoMatchParams" description: The country and area code for the proxy phone number. + NonEmptyString128: + type: string + minLength: 1 + maxLength: 128 + pattern: .*\S.* String128: type: string maxLength: 128 @@ -2846,7 +2857,7 @@ components: type: object properties: VoiceConnectorId: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector's ID. AwsRegion: $ref: "#/components/schemas/VoiceConnectorAwsRegion" @@ -2871,10 +2882,10 @@ components: description: The ARN of the Voice Connector. IntegrationType: $ref: "#/components/schemas/VoiceConnectorIntegrationType" - description: The connectors for use with Amazon Connect. + description: The connectors for use with Connect Customer. NetworkType: $ref: "#/components/schemas/NetworkType" - description: The type of network of the Voice Connector. Either IPv4 only or dual-stack (IPv4 and IPv6). + description: The type of network for the Voice Connector. VoiceConnectorGroupName: type: string minLength: 1 @@ -2889,18 +2900,22 @@ components: type: object properties: VoiceConnectorId: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. Priority: $ref: "#/components/schemas/VoiceConnectorItemPriority" description: The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight. required: - VoiceConnectorId - - Priority VoiceConnectorItemPriority: type: integer minimum: 1 maximum: 99 + CallDistributionType: + type: string + enum: + - PriorityWeightedDistribution + - LoadBalancedDistribution CreateVoiceConnectorGroupResponse: type: object properties: @@ -2929,6 +2944,8 @@ components: VoiceConnectorGroupArn: $ref: "#/components/schemas/NonEmptyString" description: The ARN of the Voice Connector group. + CallDistributionType: + $ref: "#/components/schemas/CallDistributionType" NonEmptyString256: type: string minLength: 1 @@ -3048,8 +3065,13 @@ components: type: object properties: CdrBucket: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/S3BucketName" description: The S3 bucket that stores the Voice Connector's call detail records. + S3BucketName: + type: string + minLength: 1 + maxLength: 64 + pattern: (?!(^xn--|.+-s3alias$))^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$ GetPhoneNumberResponse: type: object properties: @@ -3066,6 +3088,8 @@ components: E164PhoneNumber: $ref: "#/components/schemas/E164PhoneNumber" description: The phone number, in E.164 format. + PhoneNumberArn: + $ref: "#/components/schemas/NonEmptyString" Country: $ref: "#/components/schemas/Alpha2CountryCode" description: "The phone number's country. Format: ISO 3166-1 alpha-2." @@ -3296,7 +3320,7 @@ components: type: object properties: VoiceConnectorId: - $ref: "#/components/schemas/NonEmptyString128" + $ref: "#/components/schemas/VoiceConnectorId" description: The Voice Connector ID. TransactionId: $ref: "#/components/schemas/NonEmptyString256" @@ -3678,6 +3702,9 @@ components: type: array items: $ref: "#/components/schemas/ListAvailableVoiceConnectorRegionsRowDisplay" + NextTokenString: + type: string + maxLength: 65535 ResultMax: type: integer minimum: 1 @@ -3708,9 +3735,6 @@ components: type: array items: $ref: "#/components/schemas/PhoneNumber" - NextTokenString: - type: string - maxLength: 65535 ListProxySessionsResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/cleanrooms.yaml b/providers/src/aws/v00.00.00000/services/cleanrooms.yaml index cfae6e61..6d222265 100644 --- a/providers/src/aws/v00.00.00000/services/cleanrooms.yaml +++ b/providers/src/aws/v00.00.00000/services/cleanrooms.yaml @@ -224,7 +224,6 @@ paths: required: - members - name - - description - creatorMemberAbilities - creatorDisplayName - queryLogStatus @@ -729,6 +728,113 @@ paths: application/json: schema: $ref: "#/components/schemas/ListIdNamespaceAssociationsOutput" + /memberships/{membership_identifier}/intermediateTables: + post: + operationId: CreateIntermediateTable + description: Creates an intermediate table in a membership. The intermediate table is owned by the member with the CAN_QUERY ability. To populate the table with results, use PopulateIntermediateTable. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership where the intermediate table is created. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/DisplayName" + description: + $ref: "#/components/schemas/ResourceDescription" + populationAnalysisConfiguration: + $ref: "#/components/schemas/PopulationAnalysisConfiguration" + kmsKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + retentionInDays: + $ref: "#/components/schemas/CreateIntermediateTableInputRetentionInDaysInteger" + tags: + $ref: "#/components/schemas/TagMap" + required: + - name + - populationAnalysisConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIntermediateTableOutput" + get: + operationId: ListIntermediateTables + description: Lists intermediate tables owned by the caller in a membership. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership for which to list intermediate tables. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListIntermediateTablesOutput" + /memberships/{membership_identifier}/intermediateTables/{intermediate_table_identifier}/analysisRule: + post: + operationId: CreateIntermediateTableAnalysisRule + description: Creates an analysis rule for an intermediate table. Only the CUSTOM analysis rule type is supported. Only the intermediate table owner can call this operation. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table for which to create the analysis rule. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + analysisRuleType: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + analysisRulePolicy: + $ref: "#/components/schemas/IntermediateTableAnalysisRulePolicy" + required: + - analysisRuleType + - analysisRulePolicy + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIntermediateTableAnalysisRuleOutput" /memberships: post: operationId: CreateMembership @@ -1582,6 +1688,188 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateIdNamespaceAssociationOutput" + /memberships/{membership_identifier}/intermediateTables/{intermediate_table_identifier}: + delete: + operationId: DeleteIntermediateTable + description: Deletes an intermediate table. The delete is idempotent. Only the intermediate table owner can call this operation. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table to delete. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntermediateTableOutput" + get: + operationId: GetIntermediateTable + description: Retrieves an intermediate table. Returns the full details of the intermediate table, including schema, table dependencies, inherited constraints, child resources, and status. Only the intermediate table owner can call this operation. + parameters: + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table to retrieve. + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntermediateTableOutput" + patch: + operationId: UpdateIntermediateTable + description: Updates an intermediate table. You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call this operation. + parameters: + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table to update. + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + description: + $ref: "#/components/schemas/ResourceDescription" + kmsKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + columns: + $ref: "#/components/schemas/IntermediateTableColumnList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateIntermediateTableOutput" + /memberships/{membership_identifier}/intermediateTables/{intermediate_table_identifier}/analysisRule/{analysis_rule_type}: + delete: + operationId: DeleteIntermediateTableAnalysisRule + description: Deletes an analysis rule from an intermediate table. After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule is attached. Only the intermediate table owner can call this operation. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table from which to delete the analysis rule. + - name: analysis_rule_type + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + description: The type of analysis rule to delete. Currently, only CUSTOM is supported. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntermediateTableAnalysisRuleOutput" + get: + operationId: GetIntermediateTableAnalysisRule + description: Retrieves the analysis rule for an intermediate table. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table for which to retrieve the analysis rule. + - name: analysis_rule_type + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + description: The type of analysis rule to retrieve. Currently, only CUSTOM is supported. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntermediateTableAnalysisRuleOutput" + patch: + operationId: UpdateIntermediateTableAnalysisRule + description: Updates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table for which to update the analysis rule. + - name: analysis_rule_type + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + description: The type of analysis rule to update. Currently, only CUSTOM is supported. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + analysisRulePolicy: + $ref: "#/components/schemas/IntermediateTableAnalysisRulePolicy" + required: + - analysisRulePolicy + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateIntermediateTableAnalysisRuleOutput" /collaborations/{collaboration_identifier}/member/{account_id}: delete: operationId: DeleteMember @@ -1666,6 +1954,8 @@ paths: $ref: "#/components/schemas/MembershipProtectedQueryResultConfiguration" defaultJobResultConfiguration: $ref: "#/components/schemas/MembershipProtectedJobResultConfiguration" + membershipPaymentConfiguration: + $ref: "#/components/schemas/UpdateMembershipPaymentConfiguration" responses: "200": description: Success @@ -1756,6 +2046,61 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdatePrivacyBudgetTemplateOutput" + /memberships/{membership_identifier}/disallowIntermediateTable: + post: + operationId: DisallowIntermediateTable + description: Marks an intermediate table as invalid when it references the caller's base table. The data provider (base table owner) calls this operation, not the intermediate table owner. By default, the operation also marks all descendant intermediate tables as invalid. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table to disallow. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + intermediateTableName: + $ref: "#/components/schemas/DisplayName" + includeDescendants: + $ref: "#/components/schemas/Boolean" + required: + - intermediateTableName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisallowIntermediateTableOutput" + /memberships/{membership_identifier}/analysislogexports/{analysis_log_export_identifier}: + get: + operationId: GetAnalysisLogExport + description: Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure. Poll this operation until the status is SUCCESS or FAILED. An export can't be canceled after it starts. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: A unique identifier for the membership that the analysis log export belongs to. Currently accepts the membership ID. + - name: analysis_log_export_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/AnalysisLogExportIdentifier" + description: The unique identifier of the analysis log export to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAnalysisLogExportOutput" /collaborations/{collaboration_identifier}/analysistemplates/{analysis_template_arn}: get: operationId: GetCollaborationAnalysisTemplate @@ -2080,6 +2425,82 @@ paths: application/json: schema: $ref: "#/components/schemas/GetSchemaAnalysisRuleOutput" + /memberships/{membership_identifier}/analysislogexports: + get: + operationId: ListAnalysisLogExports + description: Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: A unique identifier for the membership to list analysis log exports for. Currently accepts the membership ID. + - name: analysisIdentifier + in: query + required: false + schema: + $ref: "#/components/schemas/UUID" + description: A filter on the unique identifier of the protected query that the analysis logs were exported for. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/AnalysisLogExportStatus" + description: A filter on the status of the analysis log export. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAnalysisLogExportsOutput" + post: + operationId: StartAnalysisLogExport + description: Starts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own. Use the exported logs to diagnose a query that failed or that ran more slowly than you expected. Clean Rooms exports a redacted copy of the Spark logs instead of the raw logs. Analyze the exported logs with the tooling of your choice, such as Spark History Server. For details about what the exported logs contain, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs-contents.html. The export runs asynchronously and returns with a status of IN_PROGRESS. Call GetAnalysisLogExport to poll for the final status. To use this operation, you must have the CAN_EXPORT_QUERY_ANALYSIS_LOG ability for your membership. You must also be the query runner or the query payer. Having the ability alone is not sufficient. The query must have reached a terminal state, and it must have reached the execution stage. A query that failed validation or that was canceled before it started produces no Spark logs. Log export isn't supported for queries that use differential privacy, and isn't supported for PySpark jobs. The destination bucket must be in the same Amazon Web Services Region as the collaboration. Cross-Region export isn't supported. For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs.html. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: A unique identifier for the membership to export the analysis logs for. Currently accepts a membership ID. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + analysisId: + $ref: "#/components/schemas/UUID" + analysisType: + $ref: "#/components/schemas/LogExportAnalysisType" + resultConfiguration: + $ref: "#/components/schemas/AnalysisLogExportResultConfiguration" + required: + - analysisId + - analysisType + - resultConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartAnalysisLogExportOutput" /collaborations/{collaboration_identifier}/analysistemplates: get: operationId: ListCollaborationAnalysisTemplates @@ -2242,6 +2663,42 @@ paths: application/json: schema: $ref: "#/components/schemas/ListCollaborationPrivacyBudgetsOutput" + /memberships/{membership_identifier}/intermediateTables/{intermediate_table_identifier}/versions: + get: + operationId: ListIntermediateTableVersions + description: Lists the version history of an intermediate table. Each call to PopulateIntermediateTable creates a new version. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table for which to list versions. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListIntermediateTableVersionsOutput" /collaborations/{collaboration_identifier}/members: get: operationId: ListMembers @@ -2375,6 +2832,8 @@ paths: $ref: "#/components/schemas/ProtectedJobResultConfigurationInput" computeConfiguration: $ref: "#/components/schemas/ProtectedJobComputeConfiguration" + jobComputePayerAccountId: + $ref: "#/components/schemas/AccountId" required: - type - jobParameters @@ -2446,6 +2905,8 @@ paths: $ref: "#/components/schemas/ProtectedQueryResultConfiguration" computeConfiguration: $ref: "#/components/schemas/ComputeConfiguration" + queryComputePayerAccountId: + $ref: "#/components/schemas/AccountId" required: - type - sqlParameters @@ -2594,6 +3055,43 @@ paths: application/json: schema: $ref: "#/components/schemas/PopulateIdMappingTableOutput" + /memberships/{membership_identifier}/intermediateTables/{intermediate_table_identifier}/populate: + post: + operationId: PopulateIntermediateTable + description: Runs the stored query of an intermediate table and makes the results available for querying. Each call creates a new version. Use GetProtectedQuery with the returned analysis ID to track progress. Only the intermediate table owner can call this operation. + parameters: + - name: intermediate_table_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table to populate. + - name: membership_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership that contains the intermediate table. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + parameters: + $ref: "#/components/schemas/ParameterMap" + computeConfiguration: + $ref: "#/components/schemas/IntermediateTableComputeConfiguration" + analysisPayerAccountId: + $ref: "#/components/schemas/AccountId" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PopulateIntermediateTableOutput" /memberships/{membership_identifier}/previewprivacyimpact: post: operationId: PreviewPrivacyImpact @@ -3282,6 +3780,7 @@ components: enum: - TABLE - ID_MAPPING_TABLE + - INTERMEDIATE_TABLE SchemaStatusDetailList: type: array items: @@ -3344,6 +3843,12 @@ components: - ADDITIONAL_ANALYSES_NOT_ALLOWED - RESULT_RECEIVERS_NOT_ALLOWED - ANALYSIS_RULE_TYPES_NOT_COMPATIBLE + - INTERMEDIATE_TABLE_NOT_POPULATED + - INTERMEDIATE_TABLE_ANALYSIS_RULE_MISSING + - INTERMEDIATE_TABLE_BASE_TABLE_REMOVED + - INTERMEDIATE_TABLE_INHERITED_CONSTRAINTS_VIOLATED + - INTERMEDIATE_TABLE_DISALLOWED_BY_DATA_PROVIDER + - INTERMEDIATE_TABLE_RETENTION_PERIOD_EXPIRED SchemaConfigurationList: type: array items: @@ -3369,6 +3874,12 @@ components: idMappingTable: $ref: "#/components/schemas/IdMappingTableSchemaTypeProperties" description: The ID mapping table for the schema type properties. + intermediateTable: + $ref: "#/components/schemas/IntermediateTableSchemaTypeProperties" + description: The schema type properties for an intermediate table. + configuredTableAssociation: + $ref: "#/components/schemas/ConfiguredTableAssociationSchemaTypeProperties" + description: The schema type properties for a configured table association. IdMappingTableSchemaTypeProperties: description: Additional properties that are specific to the type of the associated schema. type: object @@ -3376,6 +3887,9 @@ components: idMappingTableInputSource: $ref: "#/components/schemas/IdMappingTableInputSourceList" description: Defines which ID namespace associations are used to create the ID mapping table. + idMappingTableId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the ID mapping table. required: - idMappingTableInputSource IdMappingTableInputSourceList: @@ -3400,6 +3914,24 @@ components: enum: - SOURCE - TARGET + IntermediateTableSchemaTypeProperties: + description: Contains the schema type properties for an intermediate table. + type: object + properties: + intermediateTableId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the intermediate table. + required: + - intermediateTableId + ConfiguredTableAssociationSchemaTypeProperties: + description: Contains the schema type properties for a configured table association. + type: object + properties: + configuredTableAssociationId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the configured table association. + required: + - configuredTableAssociationId BatchGetSchemaErrorList: type: array items: @@ -3686,7 +4218,7 @@ components: enum: - COUNT_DISTINCT AnalysisRuleCustom: - description: A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy. + description: A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy, minimum aggregation thresholds, and comparison controls. type: object properties: allowedAnalyses: @@ -3704,6 +4236,18 @@ components: differentialPrivacy: $ref: "#/components/schemas/DifferentialPrivacyConfiguration" description: The differential privacy configuration. + aggregationThresholds: + $ref: "#/components/schemas/AggregationThresholdList" + description: The aggregation thresholds that each query output group must satisfy. Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when allowedAnalyses allows only jobs. + comparisonControls: + $ref: "#/components/schemas/ComparisonControls" + description: The controls that restrict how a query can compare the columns in the configured table. You can't use comparison controls with differential privacy, or when allowedAnalyses allows only jobs. + allowedResultReceivers: + $ref: "#/components/schemas/AllowedResultReceivers" + description: The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the configured table. + allowedAdditionalAnalyses: + $ref: "#/components/schemas/AllowedAdditionalAnalyses" + description: The list of allowed additional analyses for the custom analysis rule. required: - allowedAnalyses AnalysisRuleCustomAllowedAnalysesList: @@ -3736,11 +4280,103 @@ components: description: Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect. type: object properties: - name: - $ref: "#/components/schemas/ColumnName" - description: The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules. + name: + $ref: "#/components/schemas/ColumnName" + description: The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules. + required: + - name + AggregationThresholdList: + type: array + items: + $ref: "#/components/schemas/AggregationThreshold" + AggregationThreshold: + description: Specifies the minimum number of distinct identities that each query output group must represent. + type: object + properties: + identityColumns: + $ref: "#/components/schemas/AggregationThresholdIdentityColumnsList" + description: The identity column, such as user_id, whose distinct values Clean Rooms counts to enforce minimum aggregation thresholds. Currently, you can specify only one column, and its data type must be string, varchar, or char. + minimumIdentityCount: + $ref: "#/components/schemas/AggregationThresholdMinimumIdentityCountInteger" + description: The minimum number of distinct identities that each query output group must represent. This threshold applies to all output columns in the table. To override this threshold for a specific column, use outputColumnThresholds. + type_: + $ref: "#/components/schemas/AggregationThresholdType" + description: The type of aggregation that the threshold enforces. Currently, the only supported value is COUNT_DISTINCT, which counts the distinct values in the identity column. + outputColumnThresholds: + $ref: "#/components/schemas/OutputColumnThresholdList" + description: The per-column overrides of minimumIdentityCount. An output column without an override uses minimumIdentityCount. + allowedAggregateExpressionType: + $ref: "#/components/schemas/AllowedAggregateExpressionType" + description: "Specifies whether a query can aggregate a transformed column. This applies to the arguments of both aggregate and window functions. Valid values are: COLUMNS_ONLY – A query can aggregate only a direct column reference, such as SUM(amount), or a constant. Clean Rooms rejects a query that transforms a column and then aggregates it, such as SUM(amount * 2) or SUM(ROUND(amount)). ANY_EXPRESSION – A query can aggregate any expression. This includes arithmetic, such as SUM(price * quantity); a cast, such as SUM(CAST(amount AS DECIMAL)); a nested function call, such as SUM(COALESCE(amount, 0)); and a conditional, such as SUM(CASE WHEN region = 'EU' THEN amount ELSE 0 END)." + required: + - identityColumns + - minimumIdentityCount + - type_ + - allowedAggregateExpressionType + AggregationThresholdIdentityColumnsList: + type: array + items: + $ref: "#/components/schemas/AnalysisRuleColumnName" + AggregationThresholdMinimumIdentityCountInteger: + type: integer + minimum: 2 + maximum: 100000 + AggregationThresholdType: + type: string + enum: + - COUNT_DISTINCT + OutputColumnThresholdList: + type: array + items: + $ref: "#/components/schemas/OutputColumnThreshold" + OutputColumnThreshold: + description: Specifies the minimum number of distinct identities for an individual output column. This value overrides the table-wide minimumIdentityCount that you set in AggregationThreshold. + type: object + properties: + outputColumnName: + $ref: "#/components/schemas/AnalysisRuleColumnName" + description: The name of the output column that the override applies to. You can specify each column only once. + minimumIdentityCount: + $ref: "#/components/schemas/OutputColumnThresholdMinimumIdentityCountInteger" + description: The minimum number of distinct identities that each query output group must represent for this column. Specify 0 to exempt the column from the threshold, or a value of 2 or greater to enforce a threshold. + required: + - outputColumnName + - minimumIdentityCount + OutputColumnThresholdMinimumIdentityCountInteger: + type: integer + minimum: 0 + maximum: 100000 + AllowedAggregateExpressionType: + type: string + enum: + - COLUMNS_ONLY + - ANY_EXPRESSION + ComparisonControls: + description: Specifies how a query can compare the columns in a table, including literal comparisons and column-to-column comparisons. + type: object + properties: + allowedLiteralComparisonColumns: + $ref: "#/components/schemas/AnalysisRuleColumnList" + description: The columns that a query can compare to literal values, for example, in a WHERE clause. Clean Rooms rejects a query that compares any other column to a literal value. Specify an empty list to block literal comparison on every column. You can't specify a column that you also use as an identity column in an aggregation threshold. + allowedColumnComparisonColumns: + $ref: "#/components/schemas/AnalysisRuleColumnList" + description: The columns that a query can compare to another column, for example, in a join, a WHERE clause, a GROUP BY clause, or a window function. Clean Rooms rejects a query that uses any other column in a column-to-column comparison. Specify an empty list to block column-to-column comparison on every column. required: - - name + - allowedLiteralComparisonColumns + - allowedColumnComparisonColumns + AllowedResultReceivers: + type: array + items: + $ref: "#/components/schemas/AccountId" + AllowedAdditionalAnalyses: + type: array + items: + $ref: "#/components/schemas/AdditionalAnalysesResourceArn" + AdditionalAnalysesResourceArn: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*) AnalysisRuleIdMappingTable: description: Defines details for the analysis rule ID mapping table. type: object @@ -3809,19 +4445,6 @@ components: allowedAdditionalAnalyses: $ref: "#/components/schemas/AllowedAdditionalAnalyses" description: The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. - AllowedResultReceivers: - type: array - items: - $ref: "#/components/schemas/AccountId" - AllowedAdditionalAnalyses: - type: array - items: - $ref: "#/components/schemas/AdditionalAnalysesResourceArn" - AdditionalAnalysesResourceArn: - type: string - minLength: 0 - maxLength: 256 - pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*) ConfiguredTableAssociationAnalysisRuleAggregation: description: The configured table association analysis rule applied to a configured table with the aggregation analysis rule. type: object @@ -3953,6 +4576,12 @@ components: description: Disallowed output columns differentialPrivacy: $ref: "#/components/schemas/DifferentialPrivacyConfiguration" + aggregationThresholds: + $ref: "#/components/schemas/AggregationThresholdList" + description: The aggregation thresholds for the consolidated policy. + comparisonControls: + $ref: "#/components/schemas/ComparisonControls" + description: The comparison controls for the consolidated policy. allowedResultReceivers: $ref: "#/components/schemas/AllowedResultReceivers" description: The allowed result receivers. @@ -4124,6 +4753,7 @@ components: - CAN_QUERY - CAN_RECEIVE_RESULTS - CAN_RUN_JOB + - CAN_EXPORT_QUERY_ANALYSIS_LOG MLMemberAbilities: description: The ML member abilities for a collaboration member. type: object @@ -4168,7 +4798,7 @@ components: properties: isResponsible: $ref: "#/components/schemas/Boolean" - description: Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE). Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query. + description: Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE). One or more members can be configured as payer candidates for query compute costs. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. required: - isResponsible MLPaymentConfig: @@ -4190,7 +4820,7 @@ components: properties: isResponsible: $ref: "#/components/schemas/Boolean" - description: Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE). Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query. + description: Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE). One or more members can be configured as payer candidates for model training costs. If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. required: - isResponsible ModelInferencePaymentConfig: @@ -4199,7 +4829,7 @@ components: properties: isResponsible: $ref: "#/components/schemas/Boolean" - description: Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE). Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query. + description: Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE). One or more members can be configured as payer candidates for model inference costs. If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. required: - isResponsible SyntheticDataGenerationPaymentConfig: @@ -4217,7 +4847,7 @@ components: properties: isResponsible: $ref: "#/components/schemas/Boolean" - description: Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE). Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs. + description: Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE). One or more members can be configured as payer candidates for query and job compute costs. An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs. required: - isResponsible CollaborationName: @@ -4227,9 +4857,9 @@ components: pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]* CollaborationDescription: type: string - minLength: 1 + minLength: 0 maxLength: 255 - pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]* + pattern: (?!\s+$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]* DataEncryptionMetadata: description: The settings for client-side encryption for cryptographic computing. type: object @@ -4276,6 +4906,8 @@ components: - ADD_MEMBER - GRANT_RECEIVE_RESULTS_ABILITY - REVOKE_RECEIVE_RESULTS_ABILITY + - GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY + - REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY AllowedResultRegions: type: array items: @@ -4440,7 +5072,11 @@ components: description: The Amazon Web Services account ID of the member to add to the collaboration. memberAbilities: $ref: "#/components/schemas/MemberAbilities" - description: "The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration. The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB. Set the value of memberAbilities to [] to allow a member to contribute data. Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results." + description: "The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration. The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB. Set the value of memberAbilities to [] to allow a member to contribute data. Set the value of memberAbilities to [CAN_RECEIVE_RESULTS] to allow a member to contribute data and receive results. Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG] so that the member can export the analysis logs for a protected query. Having this ability isn't sufficient on its own: You can export logs only for queries that you ran or paid for." + mlMemberAbilities: + $ref: "#/components/schemas/MLMemberAbilities" + paymentConfiguration: + $ref: "#/components/schemas/PaymentConfiguration" displayName: $ref: "#/components/schemas/DisplayName" description: Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members. @@ -4538,6 +5174,14 @@ components: - GRANT_RECEIVE_RESULTS_ABILITY - REVOKE_RECEIVE_RESULTS_ABILITY - EDIT_AUTO_APPROVED_CHANGE_TYPES + - ADD_PAYER_CANDIDATE + - REMOVE_PAYER_CANDIDATE + - GRANT_CAN_RECEIVE_MODEL_OUTPUT + - GRANT_CAN_RECEIVE_INFERENCE_OUTPUT + - REVOKE_CAN_RECEIVE_MODEL_OUTPUT + - REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT + - GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY + - REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY ConfiguredAudienceModelArn: type: string minLength: 20 @@ -5005,6 +5649,9 @@ components: updateTime: $ref: "#/components/schemas/Timestamp" description: The time the configured table association was last updated. + childResources: + $ref: "#/components/schemas/ChildResourceList" + description: The child resources that depend on this configured table association. required: - arn - id @@ -5031,6 +5678,47 @@ components: - AGGREGATION - LIST - CUSTOM + ChildResourceList: + type: array + items: + $ref: "#/components/schemas/ChildResource" + ChildResource: + description: Contains information about a child resource of a given resource in a collaboration. + type: object + properties: + resourceId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the child resource. + resourceType: + $ref: "#/components/schemas/ChildResourceType" + description: The type of the child resource. + resourceName: + $ref: "#/components/schemas/DisplayName" + description: The name of the child resource. + ownerAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the member who owns the child resource. + resourceStatus: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the child resource. + required: + - resourceType + - resourceName + - ownerAccountId + ChildResourceType: + type: string + enum: + - INTERMEDIATE_TABLE + ResourceStatus: + type: string + enum: + - CREATED + - POPULATE_STARTED + - POPULATE_SUCCESS + - POPULATE_FAILED + - DISALLOWED_BY_DATA_PROVIDER + - BASE_TABLE_REMOVED + - RETENTION_PERIOD_EXPIRED ConfiguredTableAssociationIdentifier: type: string minLength: 36 @@ -5151,6 +5839,9 @@ components: kmsKeyArn: $ref: "#/components/schemas/KMSKeyArn" description: The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. + childResources: + $ref: "#/components/schemas/ChildResourceList" + description: The child resources that depend on this ID mapping table. required: - id - arn @@ -5277,30 +5968,543 @@ components: minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" - IdNamespaceAssociationArn: - type: string - minLength: 0 - maxLength: 256 - pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+ - IdNamespaceAssociationInputReferenceProperties: - description: Provides the information for the ID namespace association input reference properties. + IdNamespaceAssociationArn: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+ + IdNamespaceAssociationInputReferenceProperties: + description: Provides the information for the ID namespace association input reference properties. + type: object + properties: + idNamespaceType: + $ref: "#/components/schemas/IdNamespaceType" + description: The ID namespace type for this ID namespace association. + idMappingWorkflowsSupported: + $ref: "#/components/schemas/IdMappingWorkflowsSupported" + description: Defines how ID mapping workflows are supported for this ID namespace association. + required: + - idNamespaceType + - idMappingWorkflowsSupported + IdMappingWorkflowsSupported: + type: array + items: + $ref: "#/components/schemas/Document" + Document: + type: object + PopulationAnalysisConfiguration: + description: Contains the configuration that defines the analysis used to populate an intermediate table. + type: object + properties: + sqlParameters: + $ref: "#/components/schemas/PopulationAnalysisSqlParameters" + description: The SQL parameters for the population analysis, including the query string or analysis template ARN. + PopulationAnalysisSqlParameters: + description: Contains the SQL parameters used to populate an intermediate table. + type: object + properties: + queryString: + $ref: "#/components/schemas/PopulationAnalysisSqlParametersQueryStringString" + description: The SQL query string used to populate the intermediate table. + analysisTemplateArn: + $ref: "#/components/schemas/AnalysisTemplateArn" + description: The Amazon Resource Name (ARN) of the analysis template to use for populating the intermediate table. + PopulationAnalysisSqlParametersQueryStringString: + type: string + minLength: 0 + maxLength: 500000 + CreateIntermediateTableInputRetentionInDaysInteger: + type: integer + minimum: 1 + maximum: 365 + CreateIntermediateTableOutput: + type: object + properties: + intermediateTable: + $ref: "#/components/schemas/IntermediateTable" + description: The intermediate table that was created. + required: + - intermediateTable + IntermediateTable: + description: Contains the details of an intermediate table in Clean Rooms. An intermediate table stores a query definition and its materialized results within a collaboration. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the intermediate table. + arn: + $ref: "#/components/schemas/IntermediateTableArn" + description: The Amazon Resource Name (ARN) of the intermediate table. + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the intermediate table. + description: + $ref: "#/components/schemas/ResourceDescription" + description: The description of the intermediate table. + membershipArn: + $ref: "#/components/schemas/MembershipArn" + description: The Amazon Resource Name (ARN) of the membership that contains the intermediate table. + membershipId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the membership that contains the intermediate table. + collaborationArn: + $ref: "#/components/schemas/CollaborationArn" + description: The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table. + collaborationId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the collaboration that contains the intermediate table. + childResources: + $ref: "#/components/schemas/ChildResourceList" + description: The child resources that depend on this intermediate table. + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time the intermediate table was created. + updateTime: + $ref: "#/components/schemas/Timestamp" + description: The time the intermediate table was last updated. + status: + $ref: "#/components/schemas/IntermediateTableStatus" + description: The current status of the intermediate table. + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status of the intermediate table. + kmsKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the intermediate table data. + populationAnalysisConfiguration: + $ref: "#/components/schemas/PopulationAnalysisConfiguration" + description: The analysis configuration that defines the query used to populate the intermediate table. + retentionInDays: + $ref: "#/components/schemas/Integer" + description: The number of days that populated data is retained before expiring. + tableDependencies: + $ref: "#/components/schemas/DependencyList" + description: The list of base tables that this intermediate table depends on. + intermediateTableVersion: + $ref: "#/components/schemas/IntermediateTableActiveVersion" + description: The details of the currently active version of the intermediate table. + analysisRuleTypes: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleTypeList" + description: The types of analysis rules associated with the intermediate table. + schema: + $ref: "#/components/schemas/IntermediateTableSchema" + description: The schema of the intermediate table, containing column definitions. Available after the table has been successfully populated. + required: + - id + - arn + - name + - membershipArn + - membershipId + - collaborationArn + - collaborationId + - createTime + - updateTime + - status + - populationAnalysisConfiguration + IntermediateTableArn: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership\/[\d\w-]+\/intermediatetable\/[\d\w-]+ + IntermediateTableStatus: + type: string + enum: + - CREATED + - POPULATE_STARTED + - POPULATE_SUCCESS + - POPULATE_FAILED + - DISALLOWED_BY_DATA_PROVIDER + - BASE_TABLE_REMOVED + - RETENTION_PERIOD_EXPIRED + Integer: + type: integer + DependencyList: + type: array + items: + $ref: "#/components/schemas/IntermediateTableDependency" + IntermediateTableDependency: + description: Contains information about a base table that an intermediate table depends on. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the dependency table. + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the dependency table. + type_: + $ref: "#/components/schemas/BaseTableDependencyType" + description: The type of the dependency table. + parentType: + $ref: "#/components/schemas/BaseTableParentType" + description: The type of dependency, either direct or indirect. A direct dependency is a table explicitly referenced in the stored query. An indirect dependency is a table referenced through another intermediate table. + creatorAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the member who owns the dependency table. + required: + - id + - name + - type_ + - parentType + - creatorAccountId + BaseTableDependencyType: + type: string + enum: + - TABLE + - INTERMEDIATE_TABLE + - ID_MAPPING_TABLE + BaseTableParentType: + type: string + enum: + - DIRECT + - INDIRECT + IntermediateTableActiveVersion: + description: Contains the details of the currently active version of an intermediate table. + type: object + properties: + versionId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the active version. + analysisId: + $ref: "#/components/schemas/AnalysisIdentifier" + description: The identifier of the protected query that created this version. + analysisType: + $ref: "#/components/schemas/PopulateIntermediateTableAnalysisType" + description: The type of analysis that created this version. + kmsKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data. + parameters: + type: object + properties: {} + description: The runtime parameters that were used when populating this version. + inheritedConstraints: + $ref: "#/components/schemas/IntermediateTableInheritedConstraints" + description: The privacy constraints inherited from parent tables at the time this version was populated. + expirationTime: + $ref: "#/components/schemas/Timestamp" + description: The time when this version expires based on the retention period. + required: + - versionId + - analysisId + - analysisType + - inheritedConstraints + AnalysisIdentifier: + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + PopulateIntermediateTableAnalysisType: + type: string + enum: + - QUERY + IntermediateTableInheritedConstraints: + description: Contains the privacy constraints inherited from parent tables for an intermediate table version. + type: object + properties: + additionalAnalyses: + $ref: "#/components/schemas/InheritedAdditionalAnalyses" + description: The inherited additional analyses constraint. + allowedAdditionalAnalyses: + $ref: "#/components/schemas/InheritedAllowedAdditionalAnalyses" + description: The inherited allowed additional analyses constraint. + allowedResultReceivers: + $ref: "#/components/schemas/InheritedAllowedResultReceivers" + description: The inherited allowed result receivers constraint. + disallowedOutputColumns: + $ref: "#/components/schemas/InheritedDisallowedOutputColumns" + description: The inherited disallowed output columns constraint. + InheritedAdditionalAnalyses: + description: Contains the inherited additional analyses constraint and its sources from parent tables. + type: object + properties: + value: + $ref: "#/components/schemas/AdditionalAnalyses" + description: The effective additional analyses setting inherited from parent tables. + sources: + $ref: "#/components/schemas/InheritedAdditionalAnalysesSourceList" + description: The list of parent tables that contribute to this inherited constraint. + required: + - value + - sources + InheritedAdditionalAnalysesSourceList: + type: array + items: + $ref: "#/components/schemas/InheritedAdditionalAnalysesSource" + InheritedAdditionalAnalysesSource: + description: Contains information about a parent table that contributes an additional analyses constraint. + type: object + properties: + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the parent table. + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the parent table. + type_: + $ref: "#/components/schemas/BaseTableDependencyType" + description: The type of the parent table. + value: + $ref: "#/components/schemas/AdditionalAnalyses" + description: The additional analyses setting defined on the parent table. + sourceAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the member who owns the parent table. + required: + - name + - id + - type_ + - value + - sourceAccountId + InheritedAllowedAdditionalAnalyses: + description: Contains the inherited allowed additional analyses constraint and its sources from parent tables. + type: object + properties: + value: + $ref: "#/components/schemas/AllowedAdditionalAnalyses" + description: The effective list of allowed additional analyses inherited from parent tables. + sources: + $ref: "#/components/schemas/InheritedAllowedAdditionalAnalysesSourceList" + description: The list of parent tables that contribute to this inherited constraint. + required: + - value + - sources + InheritedAllowedAdditionalAnalysesSourceList: + type: array + items: + $ref: "#/components/schemas/InheritedAllowedAdditionalAnalysesSource" + InheritedAllowedAdditionalAnalysesSource: + description: Contains information about a parent table that contributes an allowed additional analyses constraint. + type: object + properties: + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the parent table. + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the parent table. + type_: + $ref: "#/components/schemas/BaseTableDependencyType" + description: The type of the parent table. + value: + $ref: "#/components/schemas/AllowedAdditionalAnalyses" + description: The allowed additional analyses defined on the parent table. + sourceAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the member who owns the parent table. + required: + - name + - id + - type_ + - value + - sourceAccountId + InheritedAllowedResultReceivers: + description: Contains the inherited allowed result receivers constraint and its sources from parent tables. + type: object + properties: + value: + $ref: "#/components/schemas/AccountIdList" + description: The effective list of Amazon Web Services account IDs allowed to receive results, inherited from parent tables. + sources: + $ref: "#/components/schemas/InheritedAllowedResultReceiversSourceList" + description: The list of parent tables that contribute to this inherited constraint. + required: + - value + - sources + AccountIdList: + type: array + items: + $ref: "#/components/schemas/AccountId" + InheritedAllowedResultReceiversSourceList: + type: array + items: + $ref: "#/components/schemas/InheritedAllowedResultReceiversSource" + InheritedAllowedResultReceiversSource: + description: Contains information about a parent table that contributes an allowed result receivers constraint. + type: object + properties: + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the parent table. + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the parent table. + type_: + $ref: "#/components/schemas/BaseTableDependencyType" + description: The type of the parent table. + value: + $ref: "#/components/schemas/AccountIdList" + description: The allowed result receiver account IDs defined on the parent table. + sourceAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the member who owns the parent table. + required: + - name + - id + - type_ + - value + - sourceAccountId + InheritedDisallowedOutputColumns: + description: Contains the inherited disallowed output columns constraint and the column lineage tracing each column to its source. + type: object + properties: + value: + $ref: "#/components/schemas/AnalysisRuleColumnNameList" + description: The list of column names that are disallowed from appearing in query output, inherited from parent tables. + columnLineage: + $ref: "#/components/schemas/ColumnLineageList" + description: The lineage information that traces each disallowed output column back to its source in a parent table. + required: + - value + - columnLineage + AnalysisRuleColumnNameList: + type: array + items: + $ref: "#/components/schemas/AnalysisRuleColumnName" + ColumnLineageList: + type: array + items: + $ref: "#/components/schemas/ColumnLineageEntry" + ColumnLineageEntry: + description: Contains column lineage information that traces a disallowed output column back to its source in a base table. + type: object + properties: + column: + $ref: "#/components/schemas/AnalysisRuleColumnName" + description: The name of the column in the intermediate table. + sourceColumn: + $ref: "#/components/schemas/AnalysisRuleColumnName" + description: The name of the column in the source table. + sourceName: + $ref: "#/components/schemas/DisplayName" + description: The name of the source table. + sourceId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the source table. + sourceType: + $ref: "#/components/schemas/BaseTableDependencyType" + description: The type of the source table. + sourceAccountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID of the owner of the source table. + required: + - column + - sourceColumn + - sourceName + - sourceId + - sourceType + - sourceAccountId + IntermediateTableAnalysisRuleTypeList: + type: array + items: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + IntermediateTableAnalysisRuleType: + type: string + enum: + - CUSTOM + IntermediateTableSchema: + description: Contains the schema definition of an intermediate table. + type: object + properties: + columns: + $ref: "#/components/schemas/ColumnList" + description: The list of columns in the intermediate table schema. + required: + - columns + IntermediateTableIdentifier: + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + IntermediateTableAnalysisRulePolicy: + description: Contains the policy for an intermediate table analysis rule. type: object properties: - idNamespaceType: - $ref: "#/components/schemas/IdNamespaceType" - description: The ID namespace type for this ID namespace association. - idMappingWorkflowsSupported: - $ref: "#/components/schemas/IdMappingWorkflowsSupported" - description: Defines how ID mapping workflows are supported for this ID namespace association. - required: - - idNamespaceType - - idMappingWorkflowsSupported - IdMappingWorkflowsSupported: + v1: + $ref: "#/components/schemas/IntermediateTableAnalysisRulePolicyV1" + description: The version 1 policy for the analysis rule. + IntermediateTableAnalysisRulePolicyV1: + description: Contains the version 1 policy for an intermediate table analysis rule. + type: object + properties: + custom: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleCustom" + description: The custom analysis rule policy. + IntermediateTableAnalysisRuleCustom: + description: Contains the custom analysis rule configuration for an intermediate table. + type: object + properties: + allowedAnalyses: + $ref: "#/components/schemas/AllowedAnalysesList" + description: The list of allowed analyses that can be performed on the intermediate table. + additionalAnalyses: + $ref: "#/components/schemas/AdditionalAnalyses" + description: The setting that controls whether additional analyses are allowed on the intermediate table. + allowedAdditionalAnalyses: + $ref: "#/components/schemas/AllowedAdditionalAnalyses" + description: The list of allowed additional analyses for the intermediate table. + allowedAnalysisProviders: + $ref: "#/components/schemas/AllowedAnalysisProviderList" + description: The list of Amazon Web Services account IDs for the allowed analysis providers. + allowedResultReceivers: + $ref: "#/components/schemas/AllowedResultReceivers" + description: The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the intermediate table. + differentialPrivacy: + $ref: "#/components/schemas/DifferentialPrivacyConfiguration" + disallowedOutputColumns: + $ref: "#/components/schemas/AnalysisRuleColumnList" + description: The list of columns that are not allowed in the query output. + aggregationThresholds: + $ref: "#/components/schemas/AggregationThresholdList" + description: The aggregation thresholds that each query output group must satisfy. Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when allowedAnalyses allows only jobs. + comparisonControls: + $ref: "#/components/schemas/ComparisonControls" + description: The controls that restrict how a query can compare the columns in the intermediate table. You can't use comparison controls with differential privacy, or when allowedAnalyses allows only jobs. + AllowedAnalysesList: type: array items: - $ref: "#/components/schemas/Document" - Document: + $ref: "#/components/schemas/AnalysisTemplateArnOrQueryWildcard" + AllowedAnalysisProviderList: + type: array + items: + $ref: "#/components/schemas/AccountId" + CreateIntermediateTableAnalysisRuleOutput: + type: object + properties: + analysisRule: + $ref: "#/components/schemas/IntermediateTableAnalysisRule" + description: The analysis rule that was created for the intermediate table. + required: + - analysisRule + IntermediateTableAnalysisRule: + description: Contains the details of an analysis rule for an intermediate table. type: object + properties: + intermediateTableIdentifier: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the intermediate table associated with this analysis rule. + intermediateTableArn: + $ref: "#/components/schemas/IntermediateTableArn" + description: The Amazon Resource Name (ARN) of the intermediate table associated with this analysis rule. + analysisRulePolicy: + $ref: "#/components/schemas/IntermediateTableAnalysisRulePolicy" + description: The policy of the analysis rule. + analysisRuleType: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleType" + description: The type of the analysis rule. + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time the analysis rule was created. + updateTime: + $ref: "#/components/schemas/Timestamp" + description: The time the analysis rule was last updated. + required: + - intermediateTableIdentifier + - intermediateTableArn + - analysisRulePolicy + - analysisRuleType + - createTime + - updateTime MembershipQueryLogStatus: type: string enum: @@ -5471,7 +6675,7 @@ components: properties: isResponsible: $ref: "#/components/schemas/Boolean" - description: "Indicates whether the collaboration member has accepted to pay for job compute costs (TRUE) or has not accepted to pay for query and job compute costs (FALSE). There is only one member who pays for queries and jobs. An error message is returned for the following reasons: If you set the value to FALSE but you are responsible to pay for query and job compute costs. If you set the value to TRUE but you are not responsible to pay for query and job compute costs." + description: "Indicates whether the collaboration member has accepted to pay for job compute costs (TRUE) or has not accepted to pay for query and job compute costs (FALSE). There can be one or more members who are designated as payer candidates for queries and jobs. An error message is returned for the following reasons: If you set the value to FALSE but you are responsible to pay for query and job compute costs. If you set the value to TRUE but you are not responsible to pay for query and job compute costs." required: - isResponsible CreateMembershipOutput: @@ -5654,7 +6858,7 @@ components: type: string minLength: 0 maxLength: 200 - pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredtableassociation/[\d\w-]+ + pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+ CreatePrivacyBudgetTemplateOutput: type: object properties: @@ -5778,12 +6982,129 @@ components: type: object DeleteIdNamespaceAssociationOutput: type: object + DeleteIntermediateTableOutput: + type: object + DeleteIntermediateTableAnalysisRuleOutput: + type: object DeleteMemberOutput: type: object DeleteMembershipOutput: type: object DeletePrivacyBudgetTemplateOutput: type: object + DisallowIntermediateTableOutput: + type: object + AnalysisLogExportIdentifier: + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + GetAnalysisLogExportOutput: + type: object + properties: + analysisLogExport: + $ref: "#/components/schemas/AnalysisLogExport" + description: The analysis log export processing metadata. + required: + - analysisLogExport + AnalysisLogExport: + description: An export of the redacted Apache Spark logs for a protected query. + type: object + properties: + analysisLogExportId: + $ref: "#/components/schemas/AnalysisLogExportIdentifier" + description: The unique identifier of the analysis log export. + analysisId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the protected query that the analysis logs were exported for. + analysisType: + $ref: "#/components/schemas/LogExportAnalysisType" + description: The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported. + membershipId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the membership that the analysis log export belongs to. + status: + $ref: "#/components/schemas/AnalysisLogExportStatus" + description: "The status of the analysis log export. Possible values are: IN_PROGRESS – The export is currently running. SUCCESS – The export completed successfully. FAILED – The export failed. See the error field for details." + resultConfiguration: + $ref: "#/components/schemas/AnalysisLogExportResultConfiguration" + description: Contains the details needed to write the exported analysis logs. + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time the analysis log export was created. + updateTime: + $ref: "#/components/schemas/Timestamp" + description: The time the analysis log export was last updated. + error: + $ref: "#/components/schemas/AnalysisLogExportError" + description: The analysis log export error. This is present only when the export status is FAILED. + required: + - analysisLogExportId + - analysisId + - analysisType + - membershipId + - status + - resultConfiguration + - createTime + - updateTime + LogExportAnalysisType: + type: string + enum: + - PROTECTED_QUERY + AnalysisLogExportStatus: + type: string + enum: + - IN_PROGRESS + - SUCCESS + - FAILED + AnalysisLogExportResultConfiguration: + description: Contains configurations for analysis log export results. + type: object + properties: + outputConfiguration: + $ref: "#/components/schemas/AnalysisLogExportOutputConfiguration" + description: The configuration for analysis log export results. + required: + - outputConfiguration + AnalysisLogExportOutputConfiguration: + description: Contains configuration details for analysis log export output. + type: object + properties: + s3: + $ref: "#/components/schemas/AnalysisLogExportS3OutputConfiguration" + description: Required configuration for an analysis log export with an s3 output type. + required: + - s3 + AnalysisLogExportS3OutputConfiguration: + description: Contains output information for an analysis log export with an S3 output type. The exported logs are written under the bucket and key prefix that you specify. The path includes the collaboration ID, the protected query ID, and the analysis log export ID. Because the path includes the export ID, exporting the same query more than once doesn't overwrite the logs from an earlier export. The exported logs are encrypted using the default encryption configuration of the destination bucket. Clean Rooms doesn't accept a KMS key for log export. To encrypt the exported logs with a customer managed key, configure the bucket's default encryption to use that key before you export. + type: object + properties: + bucket: + $ref: "#/components/schemas/AnalysisLogExportS3OutputConfigurationBucketString" + description: The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration. + keyPrefix: + $ref: "#/components/schemas/KeyPrefix" + description: The S3 key prefix under which the exported analysis logs are written. Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export. + required: + - bucket + AnalysisLogExportS3OutputConfigurationBucketString: + type: string + minLength: 3 + maxLength: 63 + pattern: .*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).* + AnalysisLogExportError: + description: The analysis log export error. + type: object + properties: + code: + $ref: "#/components/schemas/String" + description: The error code for the analysis log export. + message: + $ref: "#/components/schemas/String" + description: The message for the analysis log export error. + required: + - code + - message GetAnalysisTemplateOutput: type: object properties: @@ -6040,6 +7361,22 @@ components: description: The ID namespace association that you requested. required: - idNamespaceAssociation + GetIntermediateTableOutput: + type: object + properties: + intermediateTable: + $ref: "#/components/schemas/IntermediateTable" + description: The intermediate table retrieved. + required: + - intermediateTable + GetIntermediateTableAnalysisRuleOutput: + type: object + properties: + analysisRule: + $ref: "#/components/schemas/IntermediateTableAnalysisRule" + description: The analysis rule for the intermediate table. + required: + - analysisRule GetMembershipOutput: type: object properties: @@ -6106,6 +7443,9 @@ components: computeConfiguration: $ref: "#/components/schemas/ProtectedJobComputeConfiguration" description: The compute configuration for the protected job. + jobComputePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that pays for the job compute costs. required: - id - membershipId @@ -6351,6 +7691,9 @@ components: computeConfiguration: $ref: "#/components/schemas/ComputeConfiguration" description: The compute configuration for the protected query. + queryComputePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that pays for the query compute costs. required: - id - membershipId @@ -6407,6 +7750,9 @@ components: distribute: $ref: "#/components/schemas/ProtectedQueryDistributeOutputConfiguration" description: Required configuration for a protected query with a distribute output type. + intermediateTable: + $ref: "#/components/schemas/IntermediateTableOutputConfiguration" + description: The intermediate table output configuration, present when the protected query was triggered by a populate operation. ProtectedQueryMemberOutputConfiguration: description: Contains configuration details for the protected query member output. type: object @@ -6437,6 +7783,23 @@ components: $ref: "#/components/schemas/ProtectedQueryS3OutputConfiguration" member: $ref: "#/components/schemas/ProtectedQueryMemberOutputConfiguration" + IntermediateTableOutputConfiguration: + description: Contains the output configuration of an intermediate table when a protected query populates it. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the intermediate table. + arn: + $ref: "#/components/schemas/IntermediateTableArn" + description: The Amazon Resource Name (ARN) of the intermediate table. + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the intermediate table. + required: + - id + - arn + - name ProtectedQueryStatistics: description: Contains statistics about the execution of the protected query. type: object @@ -6600,10 +7963,11 @@ components: enum: - CR.1X - CR.4X + - CR.8X WorkerComputeConfigurationNumberInteger: type: integer minimum: 2 - maximum: 400 + maximum: 1024 GetSchemaOutput: type: object properties: @@ -6628,6 +7992,46 @@ components: type: integer minimum: 1 maximum: 100 + ListAnalysisLogExportsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. + analysisLogExports: + $ref: "#/components/schemas/AnalysisLogExportSummaryList" + description: A list of analysis log exports. + required: + - analysisLogExports + AnalysisLogExportSummaryList: + type: array + items: + $ref: "#/components/schemas/AnalysisLogExportSummary" + AnalysisLogExportSummary: + description: A summary of an analysis log export, including its identifier, status, analysis type, and creation time. Returned by ListAnalysisLogExports. + type: object + properties: + analysisLogExportId: + $ref: "#/components/schemas/AnalysisLogExportIdentifier" + description: The unique identifier of the analysis log export. + analysisId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the protected query that the analysis logs were exported for. + analysisType: + $ref: "#/components/schemas/LogExportAnalysisType" + description: The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported. + status: + $ref: "#/components/schemas/AnalysisLogExportStatus" + description: "The status of the analysis log export. Possible values are: IN_PROGRESS – The export is currently running. SUCCESS – The export completed successfully. FAILED – The export failed." + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time the analysis log export was created. + required: + - analysisLogExportId + - analysisId + - analysisType + - status + - createTime ListAnalysisTemplatesOutput: type: object properties: @@ -7443,68 +8847,194 @@ components: properties: nextToken: $ref: "#/components/schemas/PaginationToken" - description: The token value provided to access the next page of results. - idNamespaceAssociationSummaries: - $ref: "#/components/schemas/IdNamespaceAssociationSummaryList" - description: The summary information of the ID namespace associations that you requested. + description: The token value provided to access the next page of results. + idNamespaceAssociationSummaries: + $ref: "#/components/schemas/IdNamespaceAssociationSummaryList" + description: The summary information of the ID namespace associations that you requested. + required: + - idNamespaceAssociationSummaries + IdNamespaceAssociationSummaryList: + type: array + items: + $ref: "#/components/schemas/IdNamespaceAssociationSummary" + IdNamespaceAssociationSummary: + description: Detailed information about the ID namespace association. + type: object + properties: + membershipId: + $ref: "#/components/schemas/MembershipIdentifier" + description: The unique identifier of the membership resource for this ID namespace association. + membershipArn: + $ref: "#/components/schemas/MembershipArn" + description: The Amazon Resource Name (ARN) of the membership resource for this ID namespace association. + collaborationArn: + $ref: "#/components/schemas/CollaborationArn" + description: The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association. + collaborationId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the collaboration that contains this ID namespace association. + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time at which this ID namespace association was created. + updateTime: + $ref: "#/components/schemas/Timestamp" + description: The most recent time at which this ID namespace association has been updated. + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of this ID namespace association. + arn: + $ref: "#/components/schemas/IdNamespaceAssociationArn" + description: The Amazon Resource Name (ARN) of this ID namespace association. + inputReferenceConfig: + $ref: "#/components/schemas/IdNamespaceAssociationInputReferenceConfig" + description: The input reference configuration details for this ID namespace association. + name: + $ref: "#/components/schemas/GenericResourceName" + description: The name of the ID namespace association. + description: + $ref: "#/components/schemas/ResourceDescription" + description: The description of the ID namespace association. + inputReferenceProperties: + $ref: "#/components/schemas/IdNamespaceAssociationInputReferencePropertiesSummary" + description: The input reference properties for this ID namespace association. + required: + - membershipId + - membershipArn + - collaborationArn + - collaborationId + - createTime + - updateTime + - id + - arn + - inputReferenceConfig + - name + - inputReferenceProperties + ListIntermediateTableVersionsOutput: + type: object + properties: + intermediateTableVersionSummaries: + $ref: "#/components/schemas/IntermediateTableVersionSummaryList" + description: The list of intermediate table version summaries. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. + required: + - intermediateTableVersionSummaries + IntermediateTableVersionSummaryList: + type: array + items: + $ref: "#/components/schemas/IntermediateTableVersionSummary" + IntermediateTableVersionSummary: + description: Contains summary information about a version of an intermediate table. + type: object + properties: + versionId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the version. + tableId: + $ref: "#/components/schemas/IntermediateTableIdentifier" + description: The unique identifier of the intermediate table that this version belongs to. + createTime: + $ref: "#/components/schemas/Timestamp" + description: The time the version was created. + analysisId: + $ref: "#/components/schemas/AnalysisIdentifier" + description: The identifier of the protected query that created this version. + status: + $ref: "#/components/schemas/IntermediateTableVersionStatus" + description: The status of the version. + analysisType: + $ref: "#/components/schemas/PopulateIntermediateTableAnalysisType" + description: The type of analysis that created this version. + kmsKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt this version's data. + expirationTime: + $ref: "#/components/schemas/Timestamp" + description: The time when this version expires based on the retention period. + required: + - versionId + - tableId + - createTime + - analysisId + - status + - analysisType + IntermediateTableVersionStatus: + type: string + enum: + - POPULATE_STARTED + - POPULATE_SUCCESS + - POPULATE_FAILED + - RETENTION_PERIOD_EXPIRED + ListIntermediateTablesOutput: + type: object + properties: + intermediateTableSummaries: + $ref: "#/components/schemas/IntermediateTableSummaryList" + description: The list of intermediate table summaries. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The pagination token that's used to fetch the next set of results. required: - - idNamespaceAssociationSummaries - IdNamespaceAssociationSummaryList: + - intermediateTableSummaries + IntermediateTableSummaryList: type: array items: - $ref: "#/components/schemas/IdNamespaceAssociationSummary" - IdNamespaceAssociationSummary: - description: Detailed information about the ID namespace association. + $ref: "#/components/schemas/IntermediateTableSummary" + IntermediateTableSummary: + description: Contains summary information about an intermediate table. type: object properties: - membershipId: - $ref: "#/components/schemas/MembershipIdentifier" - description: The unique identifier of the membership resource for this ID namespace association. + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the intermediate table. + arn: + $ref: "#/components/schemas/IntermediateTableArn" + description: The Amazon Resource Name (ARN) of the intermediate table. + name: + $ref: "#/components/schemas/DisplayName" + description: The name of the intermediate table. + description: + $ref: "#/components/schemas/ResourceDescription" + description: The description of the intermediate table. membershipArn: $ref: "#/components/schemas/MembershipArn" - description: The Amazon Resource Name (ARN) of the membership resource for this ID namespace association. + description: The Amazon Resource Name (ARN) of the membership that contains the intermediate table. + membershipId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the membership that contains the intermediate table. collaborationArn: $ref: "#/components/schemas/CollaborationArn" - description: The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association. + description: The Amazon Resource Name (ARN) of the collaboration that contains the intermediate table. collaborationId: $ref: "#/components/schemas/UUID" - description: The unique identifier of the collaboration that contains this ID namespace association. + description: The unique identifier of the collaboration that contains the intermediate table. createTime: $ref: "#/components/schemas/Timestamp" - description: The time at which this ID namespace association was created. + description: The time the intermediate table was created. updateTime: $ref: "#/components/schemas/Timestamp" - description: The most recent time at which this ID namespace association has been updated. - id: - $ref: "#/components/schemas/UUID" - description: The unique identifier of this ID namespace association. - arn: - $ref: "#/components/schemas/IdNamespaceAssociationArn" - description: The Amazon Resource Name (ARN) of this ID namespace association. - inputReferenceConfig: - $ref: "#/components/schemas/IdNamespaceAssociationInputReferenceConfig" - description: The input reference configuration details for this ID namespace association. - name: - $ref: "#/components/schemas/GenericResourceName" - description: The name of the ID namespace association. - description: - $ref: "#/components/schemas/ResourceDescription" - description: The description of the ID namespace association. - inputReferenceProperties: - $ref: "#/components/schemas/IdNamespaceAssociationInputReferencePropertiesSummary" - description: The input reference properties for this ID namespace association. + description: The time the intermediate table was last updated. + status: + $ref: "#/components/schemas/IntermediateTableStatus" + description: The current status of the intermediate table. + retentionInDays: + $ref: "#/components/schemas/Integer" + description: The number of days that populated data is retained before expiring. + analysisRuleTypes: + $ref: "#/components/schemas/IntermediateTableAnalysisRuleTypeList" + description: The types of analysis rules associated with the intermediate table. required: - - membershipId + - id + - arn + - name - membershipArn + - membershipId - collaborationArn - collaborationId - createTime - updateTime - - id - - arn - - inputReferenceConfig - - name - - inputReferenceProperties + - status ListMembersOutput: type: object properties: @@ -7790,6 +9320,9 @@ components: receiverConfigurations: $ref: "#/components/schemas/ProtectedJobReceiverConfigurations" description: The receiver configurations for the protected job. + jobComputePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that pays for the job compute costs. required: - id - membershipId @@ -7872,6 +9405,12 @@ components: receiverConfigurations: $ref: "#/components/schemas/ReceiverConfigurationsList" description: The receiver configuration. + queryComputePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that pays for the query compute costs. + intermediateTableConfiguration: + $ref: "#/components/schemas/IntermediateTableOutputConfiguration" + description: The intermediate table configuration, present when the protected query was triggered by a populate operation. required: - id - membershipId @@ -8002,6 +9541,31 @@ components: description: The unique identifier of the mapping job that will populate the ID mapping table. required: - idMappingJobId + ParameterMap: + type: object + properties: {} + IntermediateTableComputeConfiguration: + description: Contains the compute configuration for an intermediate table population operation. + type: object + properties: + queryComputeConfiguration: + $ref: "#/components/schemas/WorkerComputeConfiguration" + PopulateIntermediateTableOutput: + type: object + properties: + analysisId: + $ref: "#/components/schemas/AnalysisIdentifier" + description: The identifier for the protected query execution that populated the intermediate table. + analysisType: + $ref: "#/components/schemas/PopulateIntermediateTableAnalysisType" + description: The type of analysis performed to populate the intermediate table. + versionId: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the version created by this population operation. + required: + - analysisId + - analysisType + - versionId PreviewPrivacyImpactParametersInput: description: Specifies the updated epsilon and noise parameters to preview. The preview allows you to see how the maximum number of each type of aggregation function would change with the new parameters. type: object @@ -8066,6 +9630,14 @@ components: DifferentialPrivacyPreviewAggregationMaxCountInteger: type: integer minimum: 0 + StartAnalysisLogExportOutput: + type: object + properties: + analysisLogExport: + $ref: "#/components/schemas/AnalysisLogExport" + description: The analysis log export that was started. The status is IN_PROGRESS. + required: + - analysisLogExport ProtectedJobType: type: string enum: @@ -8213,6 +9785,54 @@ components: description: The updated ID namespace association. required: - idNamespaceAssociation + IntermediateTableColumnList: + type: array + items: + $ref: "#/components/schemas/IntermediateTableColumn" + IntermediateTableColumn: + description: Contains the name and type of a column in an intermediate table. + type: object + properties: + name: + $ref: "#/components/schemas/ColumnName" + description: The name of the column. + type_: + $ref: "#/components/schemas/IntermediateTableColumnTypeString" + description: The data type of the column. + required: + - name + - type_ + IntermediateTableColumnTypeString: + type: string + minLength: 1 + maxLength: 1024 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + UpdateIntermediateTableOutput: + type: object + properties: + intermediateTable: + $ref: "#/components/schemas/IntermediateTable" + description: The updated intermediate table. + required: + - intermediateTable + UpdateIntermediateTableAnalysisRuleOutput: + type: object + properties: + analysisRule: + $ref: "#/components/schemas/IntermediateTableAnalysisRule" + description: The updated analysis rule for the intermediate table. + required: + - analysisRule + UpdateMembershipPaymentConfiguration: + description: An object representing the payment responsibilities to update for the membership. + type: object + properties: + queryCompute: + $ref: "#/components/schemas/MembershipQueryComputePaymentConfig" + machineLearning: + $ref: "#/components/schemas/MembershipMLPaymentConfig" + jobCompute: + $ref: "#/components/schemas/MembershipJobComputePaymentConfig" UpdateMembershipOutput: type: object properties: @@ -9046,6 +10666,144 @@ components: - $ref: "#/components/x-stackQL-resources/id_namespace_associations/methods/update_id_namespace_association" delete: - $ref: "#/components/x-stackQL-resources/id_namespace_associations/methods/delete_id_namespace_association" + intermediate_tables: + id: aws.cleanrooms.intermediate_tables + name: intermediate_tables + title: intermediate_tables + methods: + create_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_intermediate_tables: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.intermediateTableSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + get_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.intermediateTable + update_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + disallow_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1disallowIntermediateTable/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + populate_intermediate_table: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1populate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/intermediate_tables/methods/get_intermediate_table" + - $ref: "#/components/x-stackQL-resources/intermediate_tables/methods/list_intermediate_tables" + insert: + - $ref: "#/components/x-stackQL-resources/intermediate_tables/methods/create_intermediate_table" + update: + - $ref: "#/components/x-stackQL-resources/intermediate_tables/methods/update_intermediate_table" + delete: + - $ref: "#/components/x-stackQL-resources/intermediate_tables/methods/delete_intermediate_table" + intermediate_table_analysis_rules: + id: aws.cleanrooms.intermediate_table_analysis_rules + name: intermediate_table_analysis_rules + title: intermediate_table_analysis_rules + methods: + create_intermediate_table_analysis_rule: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1analysisRule/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_intermediate_table_analysis_rule: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1analysisRule~1{analysis_rule_type}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + get_intermediate_table_analysis_rule: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1analysisRule~1{analysis_rule_type}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.analysisRule + update_intermediate_table_analysis_rule: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1analysisRule~1{analysis_rule_type}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/intermediate_table_analysis_rules/methods/get_intermediate_table_analysis_rule" + insert: + - $ref: "#/components/x-stackQL-resources/intermediate_table_analysis_rules/methods/create_intermediate_table_analysis_rule" + update: + - $ref: "#/components/x-stackQL-resources/intermediate_table_analysis_rules/methods/update_intermediate_table_analysis_rule" + delete: + - $ref: "#/components/x-stackQL-resources/intermediate_table_analysis_rules/methods/delete_intermediate_table_analysis_rule" memberships: id: aws.cleanrooms.memberships name: memberships @@ -9103,6 +10861,17 @@ components: config: requestBodyTranslate: algorithm: naive + start_analysis_log_export: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1analysislogexports/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive start_protected_job: operation: $ref: "#/paths/~1memberships~1{membership_identifier}~1protectedJobs/post" @@ -9248,6 +11017,42 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/members/methods/delete_member" + analysis_log_exports: + id: aws.cleanrooms.analysis_log_exports + name: analysis_log_exports + title: analysis_log_exports + methods: + get_analysis_log_export: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1analysislogexports~1{analysis_log_export_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.analysisLogExport + list_analysis_log_exports: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1analysislogexports/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.analysisLogExports + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/analysis_log_exports/methods/get_analysis_log_export" + - $ref: "#/components/x-stackQL-resources/analysis_log_exports/methods/list_analysis_log_exports" + insert: [] + update: [] + delete: [] collaboration_configured_audience_model_associations: id: aws.cleanrooms.collaboration_configured_audience_model_associations name: collaboration_configured_audience_model_associations @@ -9480,6 +11285,34 @@ components: insert: [] update: [] delete: [] + intermediate_table_versions: + id: aws.cleanrooms.intermediate_table_versions + name: intermediate_table_versions + title: intermediate_table_versions + methods: + list_intermediate_table_versions: + operation: + $ref: "#/paths/~1memberships~1{membership_identifier}~1intermediateTables~1{intermediate_table_identifier}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.intermediateTableVersionSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/intermediate_table_versions/methods/list_intermediate_table_versions" + insert: [] + update: [] + delete: [] privacy_budgets: id: aws.cleanrooms.privacy_budgets name: privacy_budgets diff --git a/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml b/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml index 4ead205f..bd970880 100644 --- a/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml +++ b/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml @@ -421,6 +421,8 @@ paths: $ref: "#/components/schemas/KmsKeyArn" tags: $ref: "#/components/schemas/TagMap" + payerConfiguration: + $ref: "#/components/schemas/PayerConfiguration" required: - configuredModelAlgorithmAssociations - inputChannel @@ -504,6 +506,8 @@ paths: $ref: "#/components/schemas/KmsKeyArn" tags: $ref: "#/components/schemas/TagMap" + mlModelTrainingPayerAccountId: + $ref: "#/components/schemas/AccountId" required: - name - configuredModelAlgorithmAssociationArn @@ -1528,6 +1532,8 @@ paths: $ref: "#/components/schemas/KmsKeyArn" tags: $ref: "#/components/schemas/TagMap" + mlModelInferencePayerAccountId: + $ref: "#/components/schemas/AccountId" required: - name - trainedModelArn @@ -2230,6 +2236,7 @@ components: enum: - CR.1X - CR.4X + - CR.8X WorkerComputeConfigurationNumberInteger: type: integer minimum: 2 @@ -2252,6 +2259,21 @@ components: type: integer minimum: 1 maximum: 30 + PayerConfiguration: + description: Specifies which member accounts are responsible for paying for compute and synthetic data generation costs in a Clean Rooms ML collaboration. + type: object + properties: + computePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying compute costs. + syntheticDataPayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying synthetic data generation costs. + AccountId: + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]{12}" CreateMLInputChannelResponse: type: object properties: @@ -2612,11 +2634,6 @@ components: minLength: 1 maxLength: 128 pattern: "[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?" - AccountId: - type: string - minLength: 12 - maxLength: 12 - pattern: "[0-9]{12}" CreateTrainingDatasetResponse: type: object properties: @@ -2911,6 +2928,9 @@ components: syntheticDataConfiguration: $ref: "#/components/schemas/SyntheticDataConfiguration" description: The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data. + payerConfiguration: + $ref: "#/components/schemas/PayerConfiguration" + description: The payer configuration for the ML input channel. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the ML input channel was created. @@ -3212,6 +3232,9 @@ components: trainingContainerImageDigest: $ref: "#/components/schemas/String" description: Information about the training container image. + mlModelTrainingPayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model training costs. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the trained model was created. @@ -3516,6 +3539,9 @@ components: syntheticDataConfiguration: $ref: "#/components/schemas/SyntheticDataConfiguration" description: The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data. + payerConfiguration: + $ref: "#/components/schemas/PayerConfiguration" + description: The payer configuration for the ML input channel. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the ML input channel was created. @@ -3631,6 +3657,9 @@ components: trainingContainerImageDigest: $ref: "#/components/schemas/String" description: Information about the training image container. + mlModelTrainingPayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model training costs. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the trained model was created. @@ -3738,6 +3767,9 @@ components: type: object properties: {} description: "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256 Unicode characters in UTF-8. If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit." + mlModelInferencePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model inference costs. required: - createTime - updateTime @@ -4240,6 +4272,9 @@ components: description: $ref: "#/components/schemas/ResourceDescription" description: The description of the ML input channel. + payerConfiguration: + $ref: "#/components/schemas/PayerConfiguration" + description: The payer configuration for the ML input channel. required: - createTime - updateTime @@ -4407,6 +4442,9 @@ components: logsStatusDetails: $ref: "#/components/schemas/String" description: Details about the logs status for the trained model inference job. + mlModelInferencePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model inference costs. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the trained model inference job was created. @@ -4482,6 +4520,9 @@ components: creatorAccountId: $ref: "#/components/schemas/AccountId" description: The account ID of the member that created the trained model. + mlModelTrainingPayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model training costs. required: - createTime - updateTime @@ -4682,6 +4723,9 @@ components: description: $ref: "#/components/schemas/ResourceDescription" description: The description of the ML input channel. + payerConfiguration: + $ref: "#/components/schemas/PayerConfiguration" + description: The payer configuration for the ML input channel. required: - createTime - updateTime @@ -4770,6 +4814,9 @@ components: logsStatusDetails: $ref: "#/components/schemas/String" description: Details about the log status for the trained model inference job. + mlModelInferencePayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model inference costs. createTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The time at which the trained model inference job was created. @@ -4838,6 +4885,9 @@ components: configuredModelAlgorithmAssociationArn: $ref: "#/components/schemas/ConfiguredModelAlgorithmAssociationArn" description: The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model. + mlModelTrainingPayerAccountId: + $ref: "#/components/schemas/AccountId" + description: The account ID of the member that is responsible for paying for model training costs. required: - createTime - updateTime diff --git a/providers/src/aws/v00.00.00000/services/cloud9.yaml b/providers/src/aws/v00.00.00000/services/cloud9.yaml index dd9f860a..35a8daa5 100644 --- a/providers/src/aws/v00.00.00000/services/cloud9.yaml +++ b/providers/src/aws/v00.00.00000/services/cloud9.yaml @@ -56,7 +56,7 @@ paths: description: The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance. imageId: $ref: "#/components/schemas/ImageId" - description: "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path. We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported. From December 16, 2024, Ubuntu 18.04 will be removed from the list of available imageIds for Cloud9. This change is necessary as Ubuntu 18.04 has ended standard support on May 31, 2023. This change will only affect direct API consumers, and not Cloud9 console users. Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04. AMI aliases Amazon Linux 2: amazonlinux-2-x86_64 Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64 Ubuntu 18.04: ubuntu-18.04-x86_64 Ubuntu 22.04: ubuntu-22.04-x86_64 SSM paths Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64 Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64 Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64 Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64" + description: "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path. We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported. From December 16, 2024, Ubuntu 18.04 will be removed from the list of available imageIds for Cloud9. This change is necessary as Ubuntu 18.04 has ended standard support on May 31, 2023. This change will only affect direct API consumers, and not Cloud9 console users. Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04. AMI aliases Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64 Ubuntu 22.04: ubuntu-22.04-x86_64 SSM paths Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64 Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64" automaticStopTimeMinutes: $ref: "#/components/schemas/AutomaticStopTimeMinutes" description: The number of minutes until the running instance is shut down after the environment has last been used. diff --git a/providers/src/aws/v00.00.00000/services/cloudformation.yaml b/providers/src/aws/v00.00.00000/services/cloudformation.yaml index e6708a6e..91e54030 100644 --- a/providers/src/aws/v00.00.00000/services/cloudformation.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudformation.yaml @@ -423,6 +423,18 @@ paths: description: Determines how CloudFormation handles configuration drift during deployment. REVERT_DRIFT – Creates a drift-aware change set that brings actual resource states in line with template definitions. Provides a three-way comparison between actual state, previous deployment state, and desired state. For more information, see Using drift-aware change sets in the CloudFormation User Guide. schema: $ref: "#/components/schemas/DeploymentMode" + - name: DeploymentConfig + in: query + required: false + description: The deployment configuration for this stack operation, including the deployment mode. + schema: + $ref: "#/components/schemas/DeploymentConfig" + - name: DisableValidation + in: query + required: false + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" + schema: + $ref: "#/components/schemas/DisableValidation" responses: "200": description: Success @@ -627,6 +639,18 @@ paths: description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" schema: $ref: "#/components/schemas/RetainExceptOnCreate" + - name: DeploymentConfig + in: query + required: false + description: The deployment configuration for this stack operation, including the deployment mode. + schema: + $ref: "#/components/schemas/DeploymentConfig" + - name: DisableValidation + in: query + required: false + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" + schema: + $ref: "#/components/schemas/DisableValidation" responses: "200": description: Success @@ -1135,6 +1159,12 @@ paths: description: "Specifies the deletion mode for the stack. Possible values are: STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter. FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure." schema: $ref: "#/components/schemas/DeletionMode" + - name: DeploymentConfig + in: query + required: false + description: The deployment configuration for this stack operation, including the deployment mode. + schema: + $ref: "#/components/schemas/DeploymentConfig" responses: "200": description: Success @@ -1520,7 +1550,7 @@ paths: - name: StackName in: query required: false - description: The name or unique stack ID for which you want to retrieve events. + description: The name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe. schema: $ref: "#/components/schemas/StackNameOrId" - name: ChangeSetName @@ -4587,6 +4617,12 @@ paths: description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" schema: $ref: "#/components/schemas/RetainExceptOnCreate" + - name: DeploymentConfig + in: query + required: false + description: The deployment configuration for this stack operation, including the deployment mode. + schema: + $ref: "#/components/schemas/DeploymentConfig" responses: "200": description: Success @@ -4810,7 +4846,7 @@ paths: - name: UniqueId in: query required: true - description: A unique ID of the signal. When you signal Amazon EC2 instances or Amazon EC2 Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. + description: A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. schema: $ref: "#/components/schemas/ResourceSignalUniqueId" - name: Status @@ -5195,6 +5231,18 @@ paths: description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" schema: $ref: "#/components/schemas/RetainExceptOnCreate" + - name: DeploymentConfig + in: query + required: false + description: The deployment configuration for this stack operation, including the deployment mode. + schema: + $ref: "#/components/schemas/DeploymentConfig" + - name: DisableValidation + in: query + required: false + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" + schema: + $ref: "#/components/schemas/DisableValidation" responses: "200": description: Success @@ -5983,6 +6031,26 @@ components: type: string enum: - REVERT_DRIFT + DeploymentConfig: + description: The deployment configuration for a stack operation, including the deployment mode. + type: object + properties: + Mode: + $ref: "#/components/schemas/DeploymentConfigMode" + description: "Specifies the deployment mode for the stack operation. Possible values are: STANDARD - Use the standard deployment behavior, ensuring resources are ready to serve traffic before completing the operation. This is the default. You do not need to specify this value explicitly. EXPRESS - Complete the stack operation when resource configuration is applied, without waiting for resources to become ready to serve traffic. Resources continue becoming ready in the background." + DisableRollback: + $ref: "#/components/schemas/DisableRollback" + description: "Specifies whether to disable rollback of the stack if the stack operation fails. Default: false" + DeploymentConfigMode: + type: string + enum: + - STANDARD + - EXPRESS + DisableRollback: + type: boolean + DisableValidation: + description: "Boolean to enable or disable pre-deployment validations in changeset and stack operations: true: disable pre-deployment validations. false: enable pre-deployment validations." + type: boolean CreateChangeSetOutputDisplay: type: object properties: @@ -6054,6 +6122,12 @@ components: DeploymentMode: $ref: "#/components/schemas/DeploymentMode" description: Determines how CloudFormation handles configuration drift during deployment. REVERT_DRIFT – Creates a drift-aware change set that brings actual resource states in line with template definitions. Provides a three-way comparison between actual state, previous deployment state, and desired state. For more information, see Using drift-aware change sets in the CloudFormation User Guide. + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfig" + description: The deployment configuration for this stack operation, including the deployment mode. + DisableValidation: + $ref: "#/components/schemas/DisableValidation" + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" required: - StackName - ChangeSetName @@ -6126,8 +6200,6 @@ components: description: The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy. required: - GeneratedTemplateName - DisableRollback: - type: boolean TimeoutMinutes: type: integer minimum: 1 @@ -6214,6 +6286,12 @@ components: RetainExceptOnCreate: $ref: "#/components/schemas/RetainExceptOnCreate" description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfig" + description: The deployment configuration for this stack operation, including the deployment mode. + DisableValidation: + $ref: "#/components/schemas/DisableValidation" + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" required: - StackName StackSetName: @@ -6624,6 +6702,9 @@ components: DeletionMode: $ref: "#/components/schemas/DeletionMode" description: "Specifies the deletion mode for the stack. Possible values are: STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter. FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure." + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfig" + description: The deployment configuration for this stack operation, including the deployment mode. required: - StackName RetainStacks: @@ -6935,7 +7016,7 @@ components: properties: StackName: $ref: "#/components/schemas/StackNameOrId" - description: The name or unique stack ID for which you want to retrieve events. + description: The name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe. ChangeSetName: $ref: "#/components/schemas/ChangeSetNameOrId" description: The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events. @@ -7615,6 +7696,9 @@ components: DisableRollback: type: boolean description: "Boolean to enable or disable rollback on stack creation failures: true: disable rollback. false: enable rollback." + DeploymentConfig: + type: string + description: The deployment configuration for the stack, including the deployment mode used for stack operations. NotificationARNs: type: string description: Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published. @@ -9428,6 +9512,9 @@ components: RetainExceptOnCreate: $ref: "#/components/schemas/RetainExceptOnCreate" description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfig" + description: The deployment configuration for this stack operation, including the deployment mode. required: - StackName SetStackPolicyInput: @@ -9520,7 +9607,7 @@ components: description: The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template. UniqueId: $ref: "#/components/schemas/ResourceSignalUniqueId" - description: A unique ID of the signal. When you signal Amazon EC2 instances or Amazon EC2 Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. + description: A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. Status: $ref: "#/components/schemas/ResourceSignalStatus" description: The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update. @@ -9725,6 +9812,12 @@ components: RetainExceptOnCreate: $ref: "#/components/schemas/RetainExceptOnCreate" description: "When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain. Default: false" + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfig" + description: The deployment configuration for this stack operation, including the deployment mode. + DisableValidation: + $ref: "#/components/schemas/DisableValidation" + description: "Set to true to disable pre-deployment validations in changeset or stack operations. Default: false" required: - StackName UpdateStackInstancesOutputDisplay: diff --git a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml index 082ec9f2..7e3fa342 100644 --- a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml @@ -18,6 +18,43 @@ servers: description: AWS region description: Regional endpoint for cloudwatch paths: + /AssociateDatasetKmsKey: + post: + operationId: AssociateDatasetKmsKey + description: "Associates an Amazon Web Services Key Management Service (Amazon Web Services KMS) customer managed key with the specified dataset. After this operation completes, all data published to the dataset is encrypted at rest using the specified KMS key. Callers must have kms:Decrypt permission on the key to read the encrypted data. Only the default dataset is supported. The default dataset is implicit for every account in every Region — you do not need to create it before calling this operation. You can call AssociateDatasetKmsKey on a dataset that is already associated with a KMS key to replace the existing key with a different one. To replace a key, the caller must have kms:Decrypt permission on both the current key and the new key. The KMS key that you specify must meet all of the following requirements: It must be a symmetric encryption KMS key (key spec SYMMETRIC_DEFAULT, key usage ENCRYPT_DECRYPT). Asymmetric keys, HMAC keys, and key material types other than SYMMETRIC_DEFAULT are not supported. It must be enabled and not pending deletion. Its key policy must grant the CloudWatch service principal (cloudwatch.amazonaws.com) these permissions: kms:DescribeKey, kms:GenerateDataKey, kms:Encrypt, kms:Decrypt, and kms:ReEncrypt*. Amazon CloudWatch requires these permissions to manage the data on your behalf. The calling principal must have kms:Decrypt permission on the key. It must be specified as a fully qualified key ARN. Key IDs, aliases, and alias ARNs are not accepted. It must be in the same Amazon Web Services Region as the dataset. Before completing the association, Amazon CloudWatch validates the key by performing a series of dry-run KMS operations. Service-principal checks run first to verify that the key policy grants the required access to Amazon CloudWatch. These checks include kms:DescribeKey, kms:GenerateDataKey, kms:Encrypt, kms:Decrypt, and kms:ReEncrypt*. After those succeed, a kms:Decrypt dry-run is run with the caller's credentials to verify that the calling principal can use the key. When you are replacing an existing key, the caller's kms:Decrypt dry-run is run on the current key first, and only then on the new key. If any of these checks fails, the operation fails and the existing key association (if any) remains unchanged. Common failure causes include the key being disabled, the key policy not granting the required permissions to Amazon CloudWatch, or the caller lacking kms:Decrypt permission on the key. For more information about using customer managed keys with Amazon CloudWatch, see Encryption at rest with customer managed keys in the Amazon CloudWatch User Guide." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - GraniteServiceVersion20100801.AssociateDatasetKmsKey + default: GraniteServiceVersion20100801.AssociateDatasetKmsKey + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + DatasetIdentifier: + $ref: "#/components/schemas/DatasetIdentifier" + description: Specifies the identifier of the dataset that you want to associate the KMS key with. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format arn:aws:cloudwatch:Region:account-id:dataset/default. + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: Specifies the Amazon Resource Name (ARN) of the customer managed KMS key to associate with the dataset. The key must be a symmetric encryption KMS key (SYMMETRIC_DEFAULT) in the same Amazon Web Services Region as the dataset. The ARN must be in the format arn:aws:kms:Region:account-id:key/key-id . Key IDs, aliases, and alias ARNs are not accepted. For more information about KMS key ARNs, see Key ARN in the Amazon Web Services Key Management Service Developer Guide. + required: + - DatasetIdentifier + - KmsKeyArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AssociateDatasetKmsKeyOutput" /DeleteAlarmMuteRule: post: operationId: DeleteAlarmMuteRule @@ -50,7 +87,7 @@ paths: /DeleteAlarms: post: operationId: DeleteAlarms - description: Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation. If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result in no alarms being deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. + description: Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation. Log alarms cannot be batch deleted. If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result in no alarms being deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. parameters: - name: X-Amz-Target in: header @@ -97,6 +134,9 @@ paths: schema: type: object properties: + AnomalyDetectorId: + $ref: "#/components/schemas/AnomalyDetectorId" + description: Specifies the unique identifier of the anomaly detector to delete. If you specify this parameter, you do not need to specify a metric to identify the detector. Namespace: $ref: "#/components/schemas/Namespace" description: The namespace associated with the anomaly detection model to delete. @@ -284,7 +324,7 @@ paths: description: The unique identifier of a specific alarm contributor to filter the alarm history results. AlarmTypes: $ref: "#/components/schemas/AlarmTypes" - description: Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned. + description: Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned. HistoryItemType: $ref: "#/components/schemas/HistoryItemType" description: The type of alarm histories to retrieve. @@ -339,7 +379,7 @@ paths: description: An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. If this parameter is specified, you cannot specify AlarmNames. AlarmTypes: $ref: "#/components/schemas/AlarmTypes" - description: Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account. For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account. If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms. + description: Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms or log alarms exist in the account. For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms or log alarms, even if they exist in the account. If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms or log alarms. If you specify LogAlarms, the operation returns only a list of log alarms, and does not return any metric alarms or composite alarms. ChildrenOfAlarmName: $ref: "#/components/schemas/AlarmName" description: If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned. If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error. Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter. @@ -438,6 +478,9 @@ paths: schema: type: object properties: + AnomalyDetectorIds: + $ref: "#/components/schemas/AnomalyDetectorIds" + description: Specifies the unique identifiers of the anomaly detectors to describe. You can specify up to 50 identifiers. If you specify this parameter, you cannot also specify the Namespace, MetricName, Dimensions, or AnomalyDetectorTypes metric filters. NextToken: $ref: "#/components/schemas/NextToken" description: Use the token returned by the previous operation to request the next page of results. @@ -559,6 +602,39 @@ paths: application/json: schema: $ref: "#/components/schemas/DisableInsightRulesOutput" + /DisassociateDatasetKmsKey: + post: + operationId: DisassociateDatasetKmsKey + description: Removes the customer managed Amazon Web Services Key Management Service (Amazon Web Services KMS) key association from the specified dataset. After this operation completes, data that you publish to the dataset is encrypted at rest using an Amazon Web Services owned key managed by Amazon CloudWatch. Only the default dataset is supported. To call this operation, the dataset must currently have a customer managed KMS key associated with it. If the dataset has no associated KMS key, the operation fails with ResourceNotFoundException. Amazon CloudWatch performs a dry-run kms:Decrypt call on the key as part of this operation. This verifies that the caller is authorized to use the currently associated key. The caller must have kms:Decrypt permission on the currently associated key, and the key must be enabled and accessible. If the key has been disabled or scheduled for deletion, you must first re-enable or restore it before you can disassociate it from the dataset. Disassociating a KMS key from a dataset does not immediately remove the kms:Decrypt requirement on data plane operations. For up to three hours after disassociation, callers must continue to have kms:Decrypt permission on the previously associated key. Some data may still be encrypted with that key during this window. After this enforcement window elapses, the kms:Decrypt requirement is lifted. For more information about using customer managed keys with Amazon CloudWatch, see Encryption at rest with customer managed keys in the Amazon CloudWatch User Guide. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - GraniteServiceVersion20100801.DisassociateDatasetKmsKey + default: GraniteServiceVersion20100801.DisassociateDatasetKmsKey + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + DatasetIdentifier: + $ref: "#/components/schemas/DatasetIdentifier" + description: Specifies the identifier of the dataset from which to remove the KMS key association. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format arn:aws:cloudwatch:Region:account-id:dataset/default. + required: + - DatasetIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisassociateDatasetKmsKeyOutput" /EnableAlarmActions: post: operationId: EnableAlarmActions @@ -687,6 +763,39 @@ paths: application/json: schema: $ref: "#/components/schemas/GetDashboardOutput" + /GetDataset: + post: + operationId: GetDataset + description: Returns information about the specified dataset. This includes its identifier, Amazon Resource Name (ARN), and any customer managed Amazon Web Services Key Management Service (Amazon Web Services KMS) key that is currently associated with it. Only the default dataset is supported. The default dataset is implicit for every account in every Region — you can call GetDataset for it without first creating it. If no customer managed KMS key has been associated with the dataset, the response omits the KmsKeyArn field, indicating that data is encrypted at rest using an Amazon Web Services owned key managed by Amazon CloudWatch. To associate a customer managed KMS key with a dataset, use AssociateDatasetKmsKey. To remove the association, use DisassociateDatasetKmsKey. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - GraniteServiceVersion20100801.GetDataset + default: GraniteServiceVersion20100801.GetDataset + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + DatasetIdentifier: + $ref: "#/components/schemas/DatasetIdentifier" + description: Specifies the identifier of the dataset to retrieve. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format arn:aws:cloudwatch:Region:account-id:dataset/default. + required: + - DatasetIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDatasetOutput" /GetInsightRuleReport: post: operationId: GetInsightRuleReport @@ -1421,6 +1530,81 @@ paths: application/json: schema: $ref: "#/components/schemas/PutInsightRuleOutput" + /PutLogAlarm: + post: + operationId: PutLogAlarm + description: "Creates or updates a log alarm. A log alarm evaluates the results of a CloudWatch Logs scheduled query against the configured threshold and comparison operator to determine its state. When you create a log alarm, the operation creates a service-managed CloudWatch Logs scheduled query that runs the query string you provide on the schedule you configure. Each scheduled query execution returns one or more aggregated values determined by the AggregationExpression, and each aggregated value is compared against the alarm Threshold to determine the alarm state. The alarm uses M-out-of-N evaluation: if QueryResultsToAlarm out of the most recent QueryResultsToEvaluate query results breach the threshold, the alarm transitions to ALARM. Log alarms support the alarm states (OK, ALARM, INSUFFICIENT_DATA). Configure transition actions using OKActions, AlarmActions, and InsufficientDataActions. If you call this operation with the name of an existing log alarm, the operation replaces the previous configuration of that alarm. Permissions To create or update a log alarm, you must have the cloudwatch:PutLogAlarm permission. The IAM role specified in ScheduledQueryRoleARN must grant the CloudWatch Alarms service permission to execute scheduled queries on the specified log groups. If you set ActionLogLineCount, the role specified in ActionLogLineRoleArn must grant permission to retrieve log events for inclusion in alarm notifications." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - GraniteServiceVersion20100801.PutLogAlarm + default: GraniteServiceVersion20100801.PutLogAlarm + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + AlarmName: + $ref: "#/components/schemas/AlarmName" + description: The name for the alarm. This name must be unique within the Amazon Web Services account and Region. + AlarmDescription: + $ref: "#/components/schemas/AlarmDescription" + description: The description for the alarm. + ScheduledQueryConfiguration: + $ref: "#/components/schemas/ScheduledQueryConfiguration" + description: The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression. + ActionLogLineCount: + $ref: "#/components/schemas/ActionLogLineCount" + description: The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included. + ActionLogLineRoleArn: + $ref: "#/components/schemas/ActionLogLineRoleArn" + description: The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when ActionLogLineCount is greater than 0. + ActionsEnabled: + $ref: "#/components/schemas/ActionsEnabled" + description: Indicates whether actions should be executed during any changes to the alarm state. The default is true. + OKActions: + $ref: "#/components/schemas/ResourceList" + description: "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: Amazon SNS actions: arn:aws:sns:region:account-id:sns-topic-name Lambda actions: Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name" + AlarmActions: + $ref: "#/components/schemas/ResourceList" + description: "The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: Amazon SNS actions: arn:aws:sns:region:account-id:sns-topic-name Lambda actions: Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name Systems Manager actions: arn:aws:ssm:region:account-id:opsitem:severity" + InsufficientDataActions: + $ref: "#/components/schemas/ResourceList" + description: "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: Amazon SNS actions: arn:aws:sns:region:account-id:sns-topic-name Lambda actions: Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name" + QueryResultsToEvaluate: + $ref: "#/components/schemas/QueryResultsToEvaluate" + description: The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100. + QueryResultsToAlarm: + $ref: "#/components/schemas/QueryResultsToAlarm" + description: The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation). Must be less than or equal to QueryResultsToEvaluate. + Threshold: + $ref: "#/components/schemas/Threshold" + description: The value to compare with the aggregated query result. + ComparisonOperator: + $ref: "#/components/schemas/ComparisonOperator" + description: The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold. + TreatMissingData: + $ref: "#/components/schemas/TreatMissingData" + description: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. If this parameter is omitted, the default behavior of missing is used. + Tags: + $ref: "#/components/schemas/TagList" + description: A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms. + required: + - AlarmName + - ScheduledQueryConfiguration + - QueryResultsToEvaluate + - QueryResultsToAlarm + - ComparisonOperator + responses: + "200": + description: Success /PutManagedInsightRules: post: operationId: PutManagedInsightRules @@ -1541,6 +1725,9 @@ paths: ThresholdMetricId: $ref: "#/components/schemas/MetricId" description: If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page. If your alarm uses this parameter, it cannot have Auto Scaling actions. + EvaluationWindow: + $ref: "#/components/schemas/EvaluationWindow" + description: The evaluation window that the alarm uses to select the range of metric data that it evaluates. Specify either a sliding window or a wall clock window. If you omit this parameter, the alarm uses a sliding window. A sliding window advances each time the alarm is evaluated, forming a rolling time window. A wall clock window aligns the evaluated range to fixed clock boundaries, such as the top of the hour or the start of the day. You can use EvaluationWindow with any type of metric alarm except alarms that are based on a PromQL query. For more information, see Alarm evaluation windows in the CloudWatch User Guide. EvaluationCriteria: $ref: "#/components/schemas/EvaluationCriteria" description: The evaluation criteria for the alarm. For each PutMetricAlarm operation, you must specify either MetricName, a Metrics array, or an EvaluationCriteria. If you use the EvaluationCriteria parameter, you cannot include the Namespace, MetricName, Dimensions, Period, Unit, Statistic, ExtendedStatistic, Metrics, Threshold, ComparisonOperator, ThresholdMetricId, EvaluationPeriods, or DatapointsToAlarm parameters of PutMetricAlarm in the same operation. Instead, all evaluation parameters are defined within this structure. For an example of how to use this parameter, see the PromQL alarm example on this page. @@ -1927,6 +2114,18 @@ components: schema: type: string schemas: + DatasetIdentifier: + type: string + minLength: 1 + maxLength: 2048 + pattern: (default|arn:[a-zA-Z0-9-]+:cloudwatch:[a-zA-Z0-9-]*:\d{12}:dataset/default) + KmsKeyArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:[a-zA-Z0-9-]+:kms:[a-zA-Z0-9-]+:\d{12}:key/[a-f0-9-]+ + AssociateDatasetKmsKeyOutput: + type: object Name: type: string minLength: 1 @@ -1939,6 +2138,11 @@ components: type: string minLength: 1 maxLength: 255 + AnomalyDetectorId: + type: string + minLength: 1 + maxLength: 128 + pattern: "[A-Za-z0-9_./:%()+-]+" Namespace: type: string minLength: 1 @@ -2235,6 +2439,7 @@ components: enum: - CompositeAlarm - MetricAlarm + - LogAlarm HistoryItemType: type: string enum: @@ -2325,6 +2530,9 @@ components: MetricAlarms: $ref: "#/components/schemas/MetricAlarms" description: The information about any metric alarms returned by the operation. + LogAlarms: + $ref: "#/components/schemas/LogAlarms" + description: The information about any log alarms returned by the operation. NextToken: $ref: "#/components/schemas/NextToken" description: The token that marks the start of the next batch of returned results. @@ -2526,6 +2734,9 @@ components: StateTransitionedTimestamp: $ref: "#/components/schemas/Timestamp" description: The date and time that the alarm's StateValue most recently changed. + EvaluationWindow: + $ref: "#/components/schemas/EvaluationWindow" + description: The evaluation window that the alarm uses to select the range of metric data that it evaluates. This is either a sliding window or a wall clock window. For more information, see Alarm evaluation windows in the CloudWatch User Guide. EvaluationCriteria: $ref: "#/components/schemas/EvaluationCriteria" description: The evaluation criteria for the alarm. @@ -2575,6 +2786,30 @@ components: - PARTIAL_DATA - EVALUATION_FAILURE - EVALUATION_ERROR + EvaluationWindow: + description: The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs. This is a union type. Set exactly one of its members, SlidingWindow or WallClockWindow. If you don't set EvaluationWindow, the alarm uses a SlidingWindow by default. For more information, see Alarm evaluation windows in the CloudWatch User Guide. + type: object + properties: + WallClockWindow: + $ref: "#/components/schemas/WallClockWindow" + description: A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week. + SlidingWindow: + $ref: "#/components/schemas/SlidingWindow" + description: A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window. + WallClockWindow: + description: An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone. When you use a wall clock window, the alarm's period must be 1 minute (60 seconds), 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day (86,400 seconds), or 1 week (604,800 seconds). Other period values aren't supported with a wall clock window. Choose a wall clock window when your monitoring is tied to a business or calendar period, such as daily reports, batch jobs, or backups, or when you want alarm evaluations to match the periods shown on a metric dashboard. + type: object + properties: + Timezone: + $ref: "#/components/schemas/Timezone" + description: The time zone to use when the alarm aligns the evaluation window to clock boundaries. You can specify an IANA time zone name (for example, America/New_York), a fixed UTC offset (for example, +05:30), or an offset-prefixed identifier (for example, UTC+05:30). The offset must be aligned to a multiple of 5 minutes. If you don't specify a time zone, CloudWatch uses UTC. The time zone affects window alignment for all periods, including periods of one hour or shorter. + Timezone: + type: string + minLength: 1 + maxLength: 50 + SlidingWindow: + description: An evaluation window that advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window. A sliding window has no additional configuration options. Choose a sliding window when you need the fastest detection and the calendar boundaries of the data don't matter, such as for continuous performance, latency, or resource-exhaustion monitoring. + type: object EvaluationCriteria: description: The evaluation criteria for an alarm. This is a union type that currently supports PromQLCriteria. type: object @@ -2613,12 +2848,201 @@ components: type: integer minimum: 10 maximum: 3600 + LogAlarms: + type: array + items: + $ref: "#/components/schemas/LogAlarm" + LogAlarm: + description: The details about a log alarm. + type: object + properties: + AlarmName: + $ref: "#/components/schemas/AlarmName" + description: The name of the alarm. + AlarmArn: + $ref: "#/components/schemas/AlarmArn" + description: The Amazon Resource Name (ARN) of the alarm. + AlarmDescription: + $ref: "#/components/schemas/AlarmDescription" + description: The description of the alarm. + AlarmConfigurationUpdatedTimestamp: + $ref: "#/components/schemas/Timestamp" + description: The time stamp of the last update to the alarm configuration. + ActionsEnabled: + $ref: "#/components/schemas/ActionsEnabled" + description: Indicates whether actions should be executed during any changes to the alarm state. + OKActions: + $ref: "#/components/schemas/ResourceList" + description: The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). + AlarmActions: + $ref: "#/components/schemas/ResourceList" + description: The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). + InsufficientDataActions: + $ref: "#/components/schemas/ResourceList" + description: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). + StateValue: + $ref: "#/components/schemas/StateValue" + description: The state value for the alarm. + StateReason: + $ref: "#/components/schemas/StateReason" + description: An explanation for the alarm state, in text format. + StateReasonData: + $ref: "#/components/schemas/StateReasonData" + description: An explanation for the alarm state, in JSON format. + StateUpdatedTimestamp: + $ref: "#/components/schemas/Timestamp" + description: The time stamp of the last update to the value of either the StateValue or EvaluationState parameters. + ScheduledQueryConfiguration: + $ref: "#/components/schemas/ScheduledQueryConfiguration" + description: The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query. + QueryResultsToEvaluate: + $ref: "#/components/schemas/QueryResultsToEvaluate" + description: The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation). + QueryResultsToAlarm: + $ref: "#/components/schemas/QueryResultsToAlarm" + description: The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation). + Threshold: + $ref: "#/components/schemas/Threshold" + description: The value to compare with the aggregated query result. + ComparisonOperator: + $ref: "#/components/schemas/ComparisonOperator" + description: The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. + TreatMissingData: + $ref: "#/components/schemas/TreatMissingData" + description: How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing. + StateTransitionedTimestamp: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the alarm's StateValue most recently changed. + EvaluationState: + $ref: "#/components/schemas/EvaluationState" + description: If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details. If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved. If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete. + ActionLogLineCount: + $ref: "#/components/schemas/ActionLogLineCount" + description: The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included. + ActionLogLineRoleArn: + $ref: "#/components/schemas/ActionLogLineRoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0. + ScheduledQueryConfiguration: + description: The configuration of the CloudWatch Logs scheduled query that backs a log alarm. + type: object + properties: + QueryString: + $ref: "#/components/schemas/QueryString" + description: "The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters." + LogGroupIdentifiers: + $ref: "#/components/schemas/LogGroupIdentifiers" + description: The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries. + QueryARN: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses. + ScheduledQueryRoleARN: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups. + ScheduleConfiguration: + $ref: "#/components/schemas/ScheduleConfiguration" + description: The schedule and time-range offset configuration for the underlying scheduled query. + AggregationExpression: + $ref: "#/components/schemas/AggregationExpression" + description: "The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters." + Tags: + $ref: "#/components/schemas/TagList" + description: A list of key-value pairs to associate with the underlying scheduled query resource. + required: + - QueryString + - ScheduledQueryRoleARN + - ScheduleConfiguration + - AggregationExpression + QueryString: + type: string + minLength: 0 + maxLength: 10000 + LogGroupIdentifiers: + type: array + items: + $ref: "#/components/schemas/AmazonResourceName" + AmazonResourceName: + type: string + minLength: 1 + maxLength: 1024 + ScheduleConfiguration: + description: Contains the schedule expression and time-range offsets that define when a scheduled query runs and what time range each execution covers. + type: object + properties: + ScheduleExpression: + $ref: "#/components/schemas/ScheduleExpression" + description: The schedule expression that defines how often the underlying CloudWatch Logs scheduled query runs. Specify a rate() expression, for example rate(5 minutes). + StartTimeOffset: + $ref: "#/components/schemas/StartTimeOffset" + description: The offset, in seconds, before the scheduled execution time at which the query time range begins. For example, an offset of 360 (6 minutes) on a query running at 12:05:00 starts the query time range at 11:59:00. + EndTimeOffset: + $ref: "#/components/schemas/EndTimeOffset" + description: The offset, in seconds, before the scheduled execution time at which the query time range ends. Must be non-negative and less than StartTimeOffset. The default is 0. + required: + - ScheduleExpression + - StartTimeOffset + ScheduleExpression: + type: string + minLength: 1 + maxLength: 256 + StartTimeOffset: + type: integer + format: int64 + minimum: 1 + maximum: 2592000 + EndTimeOffset: + type: integer + format: int64 + minimum: 0 + maximum: 2592000 + AggregationExpression: + type: string + minLength: 1 + maxLength: 2048 + TagList: + type: array + items: + $ref: "#/components/schemas/Tag" + Tag: + description: A key-value pair associated with a CloudWatch resource. + type: object + properties: + Key: + $ref: "#/components/schemas/TagKey" + description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. + Value: + $ref: "#/components/schemas/TagValue" + description: The value for the specified tag key. + required: + - Key + - Value + TagKey: + type: string + minLength: 1 + maxLength: 128 + TagValue: + type: string + minLength: 0 + maxLength: 256 + QueryResultsToEvaluate: + type: integer + minimum: 1 + QueryResultsToAlarm: + type: integer + minimum: 1 + ActionLogLineCount: + type: integer + ActionLogLineRoleArn: + type: string DescribeAlarmsForMetricOutput: type: object properties: MetricAlarms: $ref: "#/components/schemas/MetricAlarms" description: The information for each alarm with the specified metric. + AnomalyDetectorIds: + type: array + items: + $ref: "#/components/schemas/AnomalyDetectorId" MaxReturnedResultsCount: type: integer minimum: 1 @@ -2648,6 +3072,9 @@ components: description: An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed. If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account. type: object properties: + AnomalyDetectorId: + $ref: "#/components/schemas/AnomalyDetectorId" + description: The unique identifier of the anomaly detector. The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account. Namespace: $ref: "#/components/schemas/Namespace" description: The namespace of the metric associated with the anomaly detection model. @@ -2787,6 +3214,8 @@ components: Failures: $ref: "#/components/schemas/BatchFailures" description: An array listing the rules that could not be disabled. You cannot disable built-in rules. + DisassociateDatasetKmsKeyOutput: + type: object EnableInsightRulesOutput: type: object properties: @@ -2863,10 +3292,6 @@ components: type: string minLength: 1 maxLength: 50 - Timezone: - type: string - minLength: 1 - maxLength: 50 MuteTargets: description: Specifies which alarms an alarm mute rule applies to. You can target up to 100 specific alarms by name. When a mute rule is active, the targeted alarms continue to evaluate metrics and transition between states, but their configured actions are muted. type: object @@ -2904,6 +3329,31 @@ components: type: string DashboardBody: type: string + GetDatasetOutput: + type: object + properties: + DatasetId: + $ref: "#/components/schemas/DatasetId" + description: Returns the identifier of the dataset. + Arn: + $ref: "#/components/schemas/DatasetArn" + description: Returns the Amazon Resource Name (ARN) of the dataset, in the format arn:aws:cloudwatch:Region:account-id:dataset/dataset-id . + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: Returns the Amazon Resource Name (ARN) of the customer managed Amazon Web Services KMS key that is currently associated with the dataset, if any. If the dataset is not associated with a customer managed KMS key, this field is not included in the response and the dataset is encrypted at rest using an Amazon Web Services owned key. + required: + - DatasetId + - Arn + DatasetId: + type: string + minLength: 7 + maxLength: 7 + pattern: default + DatasetArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:[a-zA-Z0-9-]+:cloudwatch:[a-zA-Z0-9-]*:\d{12}:dataset/default InsightRuleUnboundInteger: type: integer InsightRuleMetricList: @@ -3207,10 +3657,6 @@ components: IncludeLinkedAccountsMetrics: $ref: "#/components/schemas/IncludeLinkedAccountsMetrics" description: If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to. - AmazonResourceName: - type: string - minLength: 1 - maxLength: 1024 MetricStreamFilters: type: array items: @@ -3515,33 +3961,12 @@ components: Tags: $ref: "#/components/schemas/TagList" description: The list of tag keys and values associated with the resource you specified. - TagList: - type: array - items: - $ref: "#/components/schemas/Tag" - Tag: - description: A key-value pair associated with a CloudWatch resource. - type: object - properties: - Key: - $ref: "#/components/schemas/TagKey" - description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. - Value: - $ref: "#/components/schemas/TagValue" - description: The value for the specified tag key. - required: - - Key - - Value - TagKey: - type: string - minLength: 1 - maxLength: 128 - TagValue: - type: string - minLength: 0 - maxLength: 256 PutAnomalyDetectorOutput: type: object + properties: + AnomalyDetectorId: + $ref: "#/components/schemas/AnomalyDetectorId" + description: The unique identifier of the anomaly detector that you created or updated. PutDashboardOutput: type: object properties: @@ -3718,6 +4143,58 @@ components: UntagResourceOutput: type: object x-stackQL-resources: + datasets: + id: aws.cloudwatch.datasets + name: datasets + title: datasets + methods: + associate_dataset_kms_key: + operation: + $ref: "#/paths/~1AssociateDatasetKmsKey/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + disassociate_dataset_kms_key: + operation: + $ref: "#/paths/~1DisassociateDatasetKmsKey/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_dataset: + operation: + $ref: "#/paths/~1GetDataset/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/datasets/methods/get_dataset" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/datasets/methods/associate_dataset_kms_key" + - $ref: "#/components/x-stackQL-resources/datasets/methods/disassociate_dataset_kms_key" + delete: [] alarm_mute_rules: id: aws.cloudwatch.alarm_mute_rules name: alarm_mute_rules @@ -3865,6 +4342,18 @@ components: config: requestBodyTranslate: algorithm: naive + put_log_alarm: + operation: + $ref: "#/paths/~1PutLogAlarm/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive put_metric_alarm: operation: $ref: "#/paths/~1PutMetricAlarm/post" @@ -3896,6 +4385,7 @@ components: update: - $ref: "#/components/x-stackQL-resources/alarms/methods/set_alarm_state" replace: + - $ref: "#/components/x-stackQL-resources/alarms/methods/put_log_alarm" - $ref: "#/components/x-stackQL-resources/alarms/methods/put_composite_alarm" - $ref: "#/components/x-stackQL-resources/alarms/methods/put_metric_alarm" delete: diff --git a/providers/src/aws/v00.00.00000/services/codebuild.yaml b/providers/src/aws/v00.00.00000/services/codebuild.yaml index bffe40ca..120f45ef 100644 --- a/providers/src/aws/v00.00.00000/services/codebuild.yaml +++ b/providers/src/aws/v00.00.00000/services/codebuild.yaml @@ -1936,6 +1936,9 @@ paths: autoRetryLimitOverride: $ref: "#/components/schemas/WrapperInt" description: The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times. + hostKernelOverride: + $ref: "#/components/schemas/HostKernel" + description: The host operating system kernel for this build that overrides the one specified in the build project. required: - projectName responses: @@ -3027,6 +3030,9 @@ components: dockerServer: $ref: "#/components/schemas/DockerServer" description: A DockerServer object to use for this build project. + hostKernel: + $ref: "#/components/schemas/HostKernel" + description: "The host operating system kernel used for on-demand builds in the build project. The host kernel does not affect the build environment operating system, which is determined by the image you specify. Valid values are: LINUX_KERNEL_4: Runs on an Amazon Linux 2 host (kernel 4.x). LINUX_KERNEL_6: Runs on an Amazon Linux 2023 host (kernel 6.x). LINUX_KERNEL_LATEST: Runs on the latest supported host kernel. This setting applies to the LINUX_CONTAINER, ARM_CONTAINER, LINUX_EC2, and ARM_EC2 environment types. It is not applicable to Windows, Lambda, or Mac environment types." required: - type_ - image @@ -3152,7 +3158,7 @@ components: description: A list of one or more security groups IDs. Security groups configured for Docker servers should allow ingress network traffic from the VPC configured in the project. They should allow ingress on port 9876. status: $ref: "#/components/schemas/DockerServerStatus" - description: A DockerServerStatus object to use for this docker server. + description: A DockerServerStatus object to use for this docker server. Note that status is only an output and cannot be passed in as an input. required: - computeType SecurityGroupIds: @@ -3169,6 +3175,12 @@ components: message: $ref: "#/components/schemas/String" description: A message associated with the status of a docker server. + HostKernel: + type: string + enum: + - LINUX_KERNEL_4 + - LINUX_KERNEL_6 + - LINUX_KERNEL_LATEST LogsConfig: description: Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both. type: object diff --git a/providers/src/aws/v00.00.00000/services/codecommit.yaml b/providers/src/aws/v00.00.00000/services/codecommit.yaml index 8c31fdd2..bdfb607d 100644 --- a/providers/src/aws/v00.00.00000/services/codecommit.yaml +++ b/providers/src/aws/v00.00.00000/services/codecommit.yaml @@ -1064,6 +1064,58 @@ paths: application/json: schema: $ref: "#/components/schemas/GetBlobOutput" + /GetBlobDifferences: + post: + operationId: GetBlobDifferences + description: Returns a structured, line-level diff between two blob versions in a repository. The diff is returned as an ordered list of hunks, where each hunk represents a contiguous run of changed lines together with any surrounding unchanged context lines. Results are paginated. Use MaxResults and NextToken to retrieve additional pages. For the typical usage workflow, see GetDifferences. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - CodeCommit_20150413.GetBlobDifferences + default: CodeCommit_20150413.GetBlobDifferences + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + repositoryName: + $ref: "#/components/schemas/RepositoryName" + description: The name of the repository that contains the blobs to compare. + afterBlobId: + $ref: "#/components/schemas/ObjectId" + description: The ID of the "after" (destination) blob in the diff. Typically the value of afterBlob.blobId from a Difference object returned by GetDifferences. + beforeBlobId: + $ref: "#/components/schemas/ObjectId" + description: The ID of the "before" (source) blob in the diff. Typically the value of beforeBlob.blobId from a Difference object returned by GetDifferences. If you do not specify a value, the operation returns a diff against an empty before-state. This is equivalent to treating the file as newly added. + contextLines: + $ref: "#/components/schemas/DiffContext" + description: The number of unchanged lines of context to include before and after each block of changes in a hunk. Valid values are 0 through 20. Defaults to 3. + ignoreWhitespace: + $ref: "#/components/schemas/IgnoreWhiteSpaces" + description: Specifies whether to ignore whitespace-only changes when computing the diff. When true, the operation treats lines that differ only in whitespace as unchanged. Defaults to false. + MaxResults: + $ref: "#/components/schemas/Limit" + description: The maximum number of DiffHunk entries to return in a single response page. Defaults to 100. + NextToken: + $ref: "#/components/schemas/NextToken" + description: An enumeration token that returns the next batch of results when present in a request. + required: + - repositoryName + - afterBlobId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetBlobDifferencesOutput" /GetBranch: post: operationId: GetBranch @@ -1307,7 +1359,7 @@ paths: /GetDifferences: post: operationId: GetDifferences - description: Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be limited to a specified path. + description: Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be limited to a specified path. For line-level diff details, pass the beforeBlob.blobId and afterBlob.blobId values from a Difference object to GetBlobDifferences. parameters: - name: X-Amz-Target in: header @@ -4648,6 +4700,90 @@ components: blob: type: string format: byte + DiffContext: + type: integer + IgnoreWhiteSpaces: + type: boolean + Limit: + type: integer + GetBlobDifferencesOutput: + type: object + properties: + hunks: + $ref: "#/components/schemas/DiffHunkList" + description: An ordered list of diff hunks. Each hunk represents a contiguous run of changed and adjacent context lines. The list is empty when the blobs are identical or when the content is binary. The list is also empty when a paginated request has already returned all hunks in earlier pages, in which case NextToken is also null. + isBinary: + $ref: "#/components/schemas/CapitalBoolean" + description: Specifies whether the operation treated the diff content as binary. When true, the operation does not compute a line-level diff and hunks is empty. + beforeBlobSize: + $ref: "#/components/schemas/ObjectSize" + description: The size, in bytes, of the blob identified by beforeBlobId. Returns 0 when you do not specify beforeBlobId. + afterBlobSize: + $ref: "#/components/schemas/ObjectSize" + description: The size, in bytes, of the blob identified by afterBlobId. + NextToken: + $ref: "#/components/schemas/NextToken" + description: An enumeration token that can be used in a request to return the next batch of DiffHunk entries. null when the response contains the final page of the diff. + required: + - hunks + - isBinary + - afterBlobSize + DiffHunkList: + type: array + items: + $ref: "#/components/schemas/DiffHunk" + DiffHunk: + description: A contiguous run of changed lines from a blob diff, together with any surrounding unchanged context lines. Hunks are returned in order from the start of the file to the end. Adjacent or overlapping hunks are merged into a single hunk in the response. + type: object + properties: + beforeStartLine: + $ref: "#/components/schemas/LineNumber" + description: The 1-based line number in the before blob where this hunk begins. When the hunk consists entirely of additions, beforeLineCount is 0. + beforeLineCount: + $ref: "#/components/schemas/Count" + description: The number of lines from the before blob covered by this hunk, including any context lines. + afterStartLine: + $ref: "#/components/schemas/LineNumber" + description: The 1-based line number in the after blob where this hunk begins. When the hunk consists entirely of deletions, afterLineCount is 0. + afterLineCount: + $ref: "#/components/schemas/Count" + description: The number of lines from the after blob covered by this hunk, including any context lines. + changes: + $ref: "#/components/schemas/DiffChangeList" + description: An ordered list of line-level changes that make up this hunk. Each entry indicates whether the line is unchanged context, an addition, or a deletion. + Count: + type: integer + DiffChangeList: + type: array + items: + $ref: "#/components/schemas/DiffChange" + DiffChange: + description: "A single line-level entry in a diff hunk. Each DiffChange describes one line and its change type: unchanged context, an addition in the after blob, or a deletion from the before blob." + type: object + properties: + type_: + $ref: "#/components/schemas/DiffChangeType" + description: "The type of change for this line. Possible values: CONTEXT – Unchanged line included for surrounding context. ADD – Line added in the after blob. DELETE – Line removed from the before blob." + beforeLineNumber: + $ref: "#/components/schemas/LineNumber" + description: The 1-based line number in the before blob. This field is omitted for ADD lines. + afterLineNumber: + $ref: "#/components/schemas/LineNumber" + description: The 1-based line number in the after blob. This field is omitted for DELETE lines. + content: + $ref: "#/components/schemas/LineContent" + description: The text content of the line, without the trailing newline. + DiffChangeType: + type: string + enum: + - CONTEXT + - ADD + - DELETE + LineContent: + type: string + ObjectSize: + type: integer + format: int64 GetBranchOutput: description: Represents the output of a get branch operation. type: object @@ -4712,8 +4848,6 @@ components: type: array items: $ref: "#/components/schemas/Arn" - Count: - type: integer GetCommentsForComparedCommitOutput: type: object properties: @@ -4827,8 +4961,6 @@ components: description: A commit data type object that contains information about the specified commit. required: - commit - Limit: - type: integer GetDifferencesOutput: type: object properties: @@ -4898,9 +5030,6 @@ components: - fileMode - fileSize - fileContent - ObjectSize: - type: integer - format: int64 GetFolderOutput: type: object properties: @@ -6528,6 +6657,38 @@ components: insert: [] update: [] delete: [] + blob_differences: + id: aws.codecommit.blob_differences + name: blob_differences + title: blob_differences + methods: + get_blob_differences: + operation: + $ref: "#/paths/~1GetBlobDifferences/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.hunks + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/blob_differences/methods/get_blob_differences" + insert: [] + update: [] + delete: [] comment_reactions: id: aws.codecommit.comment_reactions name: comment_reactions diff --git a/providers/src/aws/v00.00.00000/services/cognito_idp.yaml b/providers/src/aws/v00.00.00000/services/cognito_idp.yaml index aa73cea4..17f1f9c2 100644 --- a/providers/src/aws/v00.00.00000/services/cognito_idp.yaml +++ b/providers/src/aws/v00.00.00000/services/cognito_idp.yaml @@ -519,6 +519,42 @@ paths: application/json: schema: $ref: "#/components/schemas/AdminGetUserResponse" + /AdminGetUserAuthFactors: + post: + operationId: AdminGetUserAuthFactors + description: "Lists the authentication options for a user in a user pool. Returns the following: The user's multi-factor authentication (MFA) preferences. The user's options for choice-based authentication with the USER_AUTH flow. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.AdminGetUserAuthFactors + default: AWSCognitoIdentityProviderService.AdminGetUserAuthFactors + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UserPoolId: + $ref: "#/components/schemas/UserPoolIdType" + description: The ID of the user pool where you want to get information about the user's authentication factors. + Username: + $ref: "#/components/schemas/UsernameType" + description: The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP. + required: + - UserPoolId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AdminGetUserAuthFactorsResponse" /AdminInitiateAuth: post: operationId: AdminInitiateAuth @@ -1708,6 +1744,9 @@ paths: CloudWatchLogsRoleArn: $ref: "#/components/schemas/ArnType" description: You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role. + PasswordHashingAlgorithm: + $ref: "#/components/schemas/PasswordHashingAlgorithmType" + description: "The password hashing algorithm used to generate the hashes in the CSV file for this import job. Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256" required: - JobName - UserPoolId @@ -1778,7 +1817,7 @@ paths: description: The contents of the SMS message that your user pool sends to users in SMS OTP and MFA authentication. MfaConfiguration: $ref: "#/components/schemas/UserPoolMfaType" - description: Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL. When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor. + description: "Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL. When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor. The CreateUserPool operation supports only SMS MFA configuration. If you set MfaConfiguration to either of these values, include an SmsConfiguration in the same request: ON – Requires MFA for all users OPTIONAL – Makes MFA optional for each user If you omit SmsConfiguration, the operation returns an InvalidParameterException. To configure TOTP or email MFA, use the SetUserPoolMfaConfig operation. You can also use SetUserPoolMfaConfig to add MFA factors later." UserAttributeUpdateSettings: $ref: "#/components/schemas/UserAttributeUpdateSettingsType" description: The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers. @@ -1812,6 +1851,12 @@ paths: UserPoolTier: $ref: "#/components/schemas/UserPoolTierType" description: The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS. + KeyConfiguration: + $ref: "#/components/schemas/KeyConfigurationType" + description: The key configuration for the user pool. Specifies the key type and KMS key ARN for encryption. + IssuerConfiguration: + $ref: "#/components/schemas/IssuerConfigurationType" + description: The issuer configuration for the user pool. Specifies the issuer type for token generation. required: - PoolName responses: @@ -1953,10 +1998,13 @@ paths: description: The ID of the user pool where you want to add a domain. ManagedLoginVersion: $ref: "#/components/schemas/WrappedIntegerType" - description: The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login. Managed login requires that your user pool be configured for any feature plan other than Lite. + description: The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login. Managed login requires that your user pool be configured for any feature plan other than Lite. A ManagedLoginVersion value of 2 does not activate managed login pages for your app client. When you create an app client programmatically, your app client has no branding style. To use managed login, create a branding style using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns a default branding style automatically. When you use the API or an SDK, you must create a branding style yourself. CustomDomainConfig: $ref: "#/components/schemas/CustomDomainConfigType" description: The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region. Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. + Routing: + $ref: "#/components/schemas/RoutingType" + description: The configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains. required: - Domain - UserPoolId @@ -1967,6 +2015,46 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateUserPoolDomainResponse" + /CreateUserPoolReplica: + post: + operationId: CreateUserPoolReplica + description: Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and disaster recovery. To create a replica, you must have permissions to create user pools in the target Region. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.CreateUserPoolReplica + default: AWSCognitoIdentityProviderService.CreateUserPoolReplica + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UserPoolId: + $ref: "#/components/schemas/UserPoolIdType" + description: The ID of the user pool to replicate. + RegionName: + $ref: "#/components/schemas/RegionNameType" + description: The Amazon Web Services Region where you want to create the replica user pool. + UserPoolTags: + $ref: "#/components/schemas/UserPoolTagsType" + description: A map of tags to assign to the replica user pool. Each tag consists of a key and an optional value, both of which you define. You can maintain tags independently on replica user pools. + required: + - UserPoolId + - RegionName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateUserPoolReplicaResponse" /DeleteGroup: post: operationId: DeleteGroup @@ -2337,6 +2425,43 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteUserPoolDomainResponse" + /DeleteUserPoolReplica: + post: + operationId: DeleteUserPoolReplica + description: Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.DeleteUserPoolReplica + default: AWSCognitoIdentityProviderService.DeleteUserPoolReplica + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UserPoolId: + $ref: "#/components/schemas/UserPoolIdType" + description: The ID of the user pool that contains the replica to delete. + RegionName: + $ref: "#/components/schemas/RegionNameType" + description: The Amazon Web Services Region of the replica to delete. + required: + - UserPoolId + - RegionName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteUserPoolReplicaResponse" /DeleteWebAuthnCredential: post: operationId: DeleteWebAuthnCredential @@ -2997,6 +3122,39 @@ paths: application/json: schema: $ref: "#/components/schemas/GetLogDeliveryConfigurationResponse" + /GetProvisionedLimit: + post: + operationId: GetProvisionedLimit + description: Returns the current provisioned limit for a specific API category. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.GetProvisionedLimit + default: AWSCognitoIdentityProviderService.GetProvisionedLimit + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + LimitDefinition: + $ref: "#/components/schemas/LimitDefinitionType" + description: The limit to retrieve. Specify the limit class and the attributes that identify the limit. + required: + - LimitDefinition + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetProvisionedLimitResponse" /GetSigningCertificate: post: operationId: GetSigningCertificate @@ -3683,6 +3841,42 @@ paths: application/json: schema: $ref: "#/components/schemas/ListUserPoolClientsResponse" + /ListUserPoolReplicas: + post: + operationId: ListUserPoolReplicas + description: Lists all replicas for a user pool, including both primary and secondary replicas. We recommend using pagination to ensure that the operation returns quickly and successfully. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.ListUserPoolReplicas + default: AWSCognitoIdentityProviderService.ListUserPoolReplicas + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UserPoolId: + $ref: "#/components/schemas/UserPoolIdType" + description: The ID of the user pool for which to list replicas. + NextToken: + $ref: "#/components/schemas/PaginationKeyType" + description: A pagination token for retrieving the next page of results. If this parameter is omitted, the operation returns the first page of results. + required: + - UserPoolId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListUserPoolReplicasResponse" /ListUserPools: post: operationId: ListUserPools @@ -4027,7 +4221,7 @@ paths: /SetRiskConfiguration: post: operationId: SetRiskConfiguration - description: Configures threat protection for a user pool or app client. Sets configuration for the following. Responses to risks with adaptive authentication Responses to vulnerable passwords with compromised-credentials detection Notifications to users who have had risky activity detected IP-address denylist and allowlist To set the risk configuration for the user pool to defaults, send this request with only the UserPoolId parameter. To reset the threat protection settings of an app client to be inherited from the user pool, send UserPoolId and ClientId parameters only. To change threat protection to audit-only or off, update the value of UserPoolAddOns in an UpdateUserPool request. To activate this setting, your user pool must be on the Plus tier. + description: Configures threat protection for a user pool or app client. Sets configuration for the following. Responses to risks with adaptive authentication Responses to vulnerable passwords with compromised-credentials detection Notifications to users who have had risky activity detected IP-address denylist and allowlist To set the risk configuration for the user pool to defaults, send this request with only the UserPoolId parameter. To reset the threat protection settings of an app client to be inherited from the user pool, send UserPoolId and ClientId parameters only. To change threat protection to audit-only or off, update the value of UserPoolAddOns in an UpdateUserPool request. To activate this setting, your user pool must be on the Plus tier. In secondary regions for user pools with multi-region replication, only the SourceARN and From attributes of NotifyConfiguration can be modified to configure region-specific SES integration. All other risk configuration settings must match the existing values to maintain consistency across replicas. parameters: - name: X-Amz-Target in: header @@ -4702,6 +4896,43 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateManagedLoginBrandingResponse" + /UpdateProvisionedLimit: + post: + operationId: UpdateProvisionedLimit + description: Sets the provisioned limit for a specific API category. The value must be between the default limit and your account-level maximum limit in Service Quotas. Managed login user pools don't support adjustments to the UserAuthentication or UserFederation categories. To increase these limits, submit a Service Quotas increase request. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.UpdateProvisionedLimit + default: AWSCognitoIdentityProviderService.UpdateProvisionedLimit + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + LimitDefinition: + $ref: "#/components/schemas/LimitDefinitionType" + description: The limit to update. Specify the limit class and the attributes that identify the limit. + RequestedLimitValue: + $ref: "#/components/schemas/IntegerType" + description: The provisioned rate to set, in requests per second (RPS). + required: + - LimitDefinition + - RequestedLimitValue + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateProvisionedLimitResponse" /UpdateResourceServer: post: operationId: UpdateResourceServer @@ -4836,7 +5067,7 @@ paths: /UpdateUserPool: post: operationId: UpdateUserPool - description: Updates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your user pool, modified to include the changes that you want to make. With the exception of UserPoolTier, if you don't provide a value for an attribute, Amazon Cognito sets it to its default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + description: Updates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your user pool, modified to include the changes that you want to make. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. In secondary regions for user pools with multi-region replication, regional configurations for email, SMS, Lambda functions, and tags can be updated. Both global and regional settings must be provided as inputs, with global settings required to match existing values to maintain consistency across replicas. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints parameters: - name: X-Amz-Target in: header @@ -4917,6 +5148,12 @@ paths: UserPoolTier: $ref: "#/components/schemas/UserPoolTierType" description: The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS. + KeyConfiguration: + $ref: "#/components/schemas/KeyConfigurationType" + description: The key configuration for the user pool. In secondary regions, this parameter must match the existing configuration and cannot be modified. + IssuerConfiguration: + $ref: "#/components/schemas/IssuerConfigurationType" + description: The issuer configuration for the user pool. In secondary regions, this parameter must match the existing configuration and cannot be modified. required: - UserPoolId responses: @@ -5059,6 +5296,9 @@ paths: CustomDomainConfig: $ref: "#/components/schemas/CustomDomainConfigType" description: The configuration for a custom domain that hosts managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. + Routing: + $ref: "#/components/schemas/RoutingType" + description: The routing configuration for the user pool domain. Specifies failover settings for multi-region deployments. required: - Domain - UserPoolId @@ -5069,6 +5309,47 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateUserPoolDomainResponse" + /UpdateUserPoolReplica: + post: + operationId: UpdateUserPoolReplica + description: Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSCognitoIdentityProviderService.UpdateUserPoolReplica + default: AWSCognitoIdentityProviderService.UpdateUserPoolReplica + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UserPoolId: + $ref: "#/components/schemas/UserPoolIdType" + description: The ID of the user pool that contains the replica to update. + RegionName: + $ref: "#/components/schemas/RegionNameType" + description: The Amazon Web Services Region of the replica to update. + Status: + $ref: "#/components/schemas/UpdateReplicaStatusType" + description: The status to set for the replica. Valid values are ACTIVE and INACTIVE. + required: + - UserPoolId + - RegionName + - Status + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateUserPoolReplicaResponse" /VerifySoftwareToken: post: operationId: VerifySoftwareToken @@ -5529,6 +5810,35 @@ components: type: array items: $ref: "#/components/schemas/StringType" + AdminGetUserAuthFactorsResponse: + type: object + properties: + Username: + $ref: "#/components/schemas/UsernameType" + description: The name of the user who is eligible for the authentication factors in the response. + PreferredMfaSetting: + $ref: "#/components/schemas/StringType" + description: The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA. + UserMFASettingList: + $ref: "#/components/schemas/UserMFASettingListType" + description: The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. + ConfiguredUserAuthFactors: + $ref: "#/components/schemas/ConfiguredUserAuthFactorsListType" + description: The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"]. PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level. + required: + - Username + ConfiguredUserAuthFactorsListType: + type: array + items: + $ref: "#/components/schemas/AuthFactorType" + AuthFactorType: + type: string + enum: + - PASSWORD + - EMAIL_OTP + - SMS_OTP + - WEB_AUTHN + - SOFTWARE_TOKEN AuthFlowType: type: string enum: @@ -6360,6 +6670,13 @@ components: minLength: 1 maxLength: 128 pattern: "[\\w\\s+=,.@-]+" + PasswordHashingAlgorithmType: + type: string + enum: + - BCRYPT + - SCRYPT + - ARGON2ID + - PBKDF2_SHA256 CreateUserImportJobResponse: description: Represents the response from the server to the request to create the user import job. type: object @@ -6410,6 +6727,9 @@ components: CompletionMessage: $ref: "#/components/schemas/CompletionMessageType" description: The message returned when the user import job is completed. + PasswordHashingAlgorithm: + $ref: "#/components/schemas/PasswordHashingAlgorithmType" + description: "The password hashing algorithm used to generate the hashes in the CSV file for this import job. Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256" UserImportJobIdType: type: string minLength: 1 @@ -6496,18 +6816,11 @@ components: properties: AllowedFirstAuthFactors: $ref: "#/components/schemas/AllowedFirstAuthFactorsListType" - description: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + description: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. SOFTWARE_TOKEN is not currently supported as a first auth factor. Do not include this value in AllowedFirstAuthFactors. AllowedFirstAuthFactorsListType: type: array items: $ref: "#/components/schemas/AuthFactorType" - AuthFactorType: - type: string - enum: - - PASSWORD - - EMAIL_OTP - - SMS_OTP - - WEB_AUTHN DeletionProtectionType: type: string enum: @@ -6776,7 +7089,7 @@ components: type: object properties: SnsCallerArn: - $ref: "#/components/schemas/ArnType" + $ref: "#/components/schemas/OptionalArnType" description: The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit. ExternalId: $ref: "#/components/schemas/StringType" @@ -6784,12 +7097,45 @@ components: SnsRegion: $ref: "#/components/schemas/RegionCodeType" description: The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region. Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools. - required: - - SnsCallerArn + EumsSms: + $ref: "#/components/schemas/EumsSmsConfigurationType" + description: The configuration for sending SMS messages through Amazon Web Services End User Messaging SMS, as an alternative to Amazon SNS. In a user pool, provide either the Amazon SNS configuration (SnsCallerArn) or this configuration, but not both. In Amazon Web Services Regions where Amazon SNS is not available, this configuration is required. + OptionalArnType: + type: string + minLength: 0 + maxLength: 2048 + pattern: (arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?)? RegionCodeType: type: string minLength: 5 maxLength: 32 + EumsSmsConfigurationType: + description: The configuration that Amazon Cognito uses to send SMS messages through Amazon Web Services End User Messaging SMS. Provide this structure in the EumsSms member of SmsConfigurationType to use Amazon Web Services End User Messaging SMS instead of Amazon SNS. + type: object + properties: + CallerArn: + $ref: "#/components/schemas/ArnType" + description: The ARN of the IAM role that Amazon Cognito assumes to send SMS messages through Amazon Web Services End User Messaging SMS. The role must grant permission to call the sms-voice:SendTextMessage operation. + ExternalId: + $ref: "#/components/schemas/StringType" + description: The external ID that Amazon Cognito includes when it assumes the CallerArn role. Use this value as a condition in the role trust policy to prevent the confused deputy problem. + OriginationIdentity: + $ref: "#/components/schemas/StringType" + description: "The origination identity that Amazon Web Services End User Messaging SMS uses to send messages to your users. This value can be one of the following: A phone number – A long code, toll-free number, or short code that is assigned to your account. A sender ID – An alphabetic name that identifies the message sender in supported countries. A phone pool – A group of phone numbers that Amazon Web Services End User Messaging SMS selects from when it sends messages. You can provide an E.164 phone number or the ARN of the phone number, sender ID, or phone pool. Amazon Web Services End User Messaging SMS evaluates IAM authorization with the value that you provide. If the permissions policy of your CallerArn role scopes the sms-voice:SendTextMessage resource to a specific ARN, provide that same ARN. If the formats do not match, requests fail with an InvalidSmsRoleAccessPolicyException. Depending on the destination country, you must provide an origination identity. For country-specific requirements, see Supported countries and regions for SMS messaging in the Amazon Web Services End User Messaging SMS User Guide." + ConfigurationSetName: + $ref: "#/components/schemas/StringType" + description: The name of the Amazon Web Services End User Messaging SMS configuration set that Amazon Cognito applies to messages, for logging and event destinations. If you omit this member, Amazon Cognito sends messages without applying a configuration set. + InEntityId: + $ref: "#/components/schemas/StringType" + description: The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages. + InTemplateId: + $ref: "#/components/schemas/StringType" + description: The registered template ID for the message template required by India's DLT regulations for SMS messages. + Region: + $ref: "#/components/schemas/RegionCodeType" + description: The Amazon Web Services Region of the Amazon Web Services End User Messaging SMS resources that Amazon Cognito uses to send messages. Amazon Web Services End User Messaging SMS must be available in your user pool's Region. If you omit this parameter, Amazon Cognito uses the same Region as your user pool. You can also set this parameter to your user pool's Region explicitly. Amazon Cognito rejects any other value with an InvalidParameterException. + required: + - CallerArn UserPoolTagsType: type: object properties: {} @@ -6916,6 +7262,38 @@ components: - LITE - ESSENTIALS - PLUS + KeyConfigurationType: + description: Specifies the key configuration for a user pool. Contains settings for encryption keys used to secure user pool data. + type: object + properties: + KeyType: + $ref: "#/components/schemas/EncryptionKeyType" + description: The type of encryption key used for the user pool. AWS_OWNED_KEY A key owned by Amazon Web Services in Key Management Service. CUSTOMER_MANAGED_KEY A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool. + KmsKeyArn: + $ref: "#/components/schemas/EncryptionKeyArnType" + description: The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used. + EncryptionKeyType: + type: string + enum: + - AWS_OWNED_KEY + - CUSTOMER_MANAGED_KEY + EncryptionKeyArnType: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)? + IssuerConfigurationType: + description: Specifies the issuer configuration for a user pool. Contains settings that determine how tokens are issued and validated. + type: object + properties: + Type: + $ref: "#/components/schemas/IssuerType" + description: The type of issuer configuration. Determines the token issuing behavior for the user pool. ORIGINAL The original issuer configuration for user pools. The issuer URL is hosted in the user pool’s region and provides OIDC endpoints specific to that region. Original issuers have the format of https://cognito-idp.[region].amazonaws.com/[userPoolId] UPDATED Recommended for all user pools, including for multi-Region replication. Updated issuers host the same JWKS content in multiple regions, resulting in improved resilience and efficiency. Updated issuers have the format of https://issuer-cognito-idp.[region].amazonaws.com/[userPoolId], where region is the primary Amazon Web Services Region of your user pool. + IssuerType: + type: string + enum: + - ORIGINAL + - UPDATED CreateUserPoolResponse: description: Represents the response from the server for the request to create a user pool. type: object @@ -7030,6 +7408,12 @@ components: UserPoolTier: $ref: "#/components/schemas/UserPoolTierType" description: The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS. + KeyConfiguration: + $ref: "#/components/schemas/KeyConfigurationType" + description: The key configuration for the user pool, including encryption settings. + IssuerConfiguration: + $ref: "#/components/schemas/IssuerConfigurationType" + description: The issuer configuration for the user pool, including token issuing settings. StatusType: type: string enum: @@ -7283,14 +7667,50 @@ components: WrappedIntegerType: type: integer CustomDomainConfigType: - description: The configuration for a hosted UI custom domain. + description: The configuration for a custom domain, including the SSL certificate and TLS security policy. type: object properties: CertificateArn: $ref: "#/components/schemas/ArnType" description: The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain. + SecurityPolicy: + $ref: "#/components/schemas/SecurityPolicyType" + description: "The security policy for the custom domain. Defines the minimum TLS version and cipher suites that Amazon CloudFront supports when communicating with clients. For specific guidance, see Supported protocols and ciphers between viewers and CloudFront. Valid values are as follows: TLS_V1_3_2025 (strictest): A post-quantum-ready policy requiring TLS 1.3. It provides the strongest security posture and is ideal for workloads where all clients and browsers are updated to the latest versions. Supported protocols and ciphers for TLSv1.3_2025. TLS_V1_2_2021 (recommended): A post-quantum-ready policy which prefers TLS 1.3 but allows fallback to TLS 1.2 to accommodate older clients. It is the recommended minimum for typical commercial-grade consumer applications. Supported protocols and ciphers for TLSv1.2_2021. TLS_V1 (strongly discouraged): Permits fallback to TLS 1.0. It offers the broadest compatibility, including support for legacy clients that are more than a decade old. This compatibility comes at the expense of allowing TLS versions and cryptographic algorithms that are no longer considered safe for commercial use. Supported protocols and ciphers for TLSv1." required: - CertificateArn + SecurityPolicyType: + type: string + enum: + - TLS_V1 + - TLS_V1_2_2021 + - TLS_V1_3_2025 + RoutingType: + description: Specifies routing configuration for user pool domains. Contains failover settings for multi-region deployments. + type: object + properties: + Failover: + $ref: "#/components/schemas/FailoverType" + description: The failover configuration that specifies the secondary region and health check settings. + FailoverType: + description: Specifies failover configuration for multi-region user pool domains. Contains settings for the secondary region and health check configuration. + type: object + properties: + SecondaryRegion: + $ref: "#/components/schemas/RegionNameType" + description: The secondary Amazon Web Services Region to use for failover when the primary region becomes unavailable. + PrimaryRoute53HealthCheckId: + $ref: "#/components/schemas/HealthCheckIdType" + description: The ID of the Amazon Web Services Route53 healthcheck that controls routing. If the healthcheck is healthy, traffic will be routed to the primary replica, and if the healthcheck is unhealthy, traffic will be routed to the secondary region. + required: + - SecondaryRegion + - PrimaryRoute53HealthCheckId + RegionNameType: + type: string + minLength: 5 + maxLength: 32 + HealthCheckIdType: + type: string + maxLength: 64 CreateUserPoolDomainResponse: type: object properties: @@ -7300,6 +7720,43 @@ components: CloudFrontDomain: $ref: "#/components/schemas/DomainType" description: The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your managed login or classic hosted UI pages. Your domain-name authority must have an alias record that points requests for your custom domain to this FQDN. Amazon Cognito returns this value if you set a custom domain with CustomDomainConfig. If you set an Amazon Cognito prefix domain, this parameter returns null. + Routing: + $ref: "#/components/schemas/RoutingType" + description: The routing configuration that was applied to the user pool domain. + CreateUserPoolReplicaResponse: + type: object + properties: + UserPoolReplica: + $ref: "#/components/schemas/UserPoolReplicaType" + description: Information about the created user pool replica, including its status and role. + UserPoolReplicaType: + description: Contains information about a replica user pool, including Region, status, role, and ARN. + type: object + properties: + RegionName: + $ref: "#/components/schemas/RegionNameType" + description: The Amazon Web Services Region where the replica is located. + Status: + $ref: "#/components/schemas/ReplicaStatusType" + description: The current status of the replica. CREATING The replica is being created. INACTIVE The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported. ACTIVE The replica is available for both end-user and administrator operations. DELETING The replica is being deleted. + Role: + $ref: "#/components/schemas/ReplicaRoleType" + description: The role of the user pool replica that determines which API operations are enabled. PRIMARY The primary replica supports all end user and administrator operations. SECONDARY The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported. + UserPoolArn: + $ref: "#/components/schemas/ArnType" + description: The Amazon Resource Name (ARN) of the replica user pool. + ReplicaStatusType: + type: string + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + ReplicaRoleType: + type: string + enum: + - PRIMARY + - SECONDARY DeleteUserAttributesResponse: description: Represents the response from the server to delete user attributes. type: object @@ -7308,6 +7765,12 @@ components: type: object DeleteUserPoolDomainResponse: type: object + DeleteUserPoolReplicaResponse: + type: object + properties: + UserPoolReplica: + $ref: "#/components/schemas/UserPoolReplicaType" + description: Information about the deleted user pool replica. DeleteWebAuthnCredentialResponse: type: object DescribeIdentityProviderResponse: @@ -7582,6 +8045,9 @@ components: ManagedLoginVersion: $ref: "#/components/schemas/WrappedIntegerType" description: The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) branding and a version of 2 indicates managed login branding. Managed login requires that your user pool be configured for any feature plan other than Lite. + Routing: + $ref: "#/components/schemas/RoutingType" + description: The routing configuration for the domain, including failover settings for multi-region deployments. Currently only Failover configurations are allowed. AWSAccountIdType: type: string maxLength: 12 @@ -7741,6 +8207,49 @@ components: StreamArn: $ref: "#/components/schemas/ArnType" description: The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export. + LimitDefinitionType: + description: The class and attributes that identify a specific limit at the account level. + type: object + properties: + LimitClass: + $ref: "#/components/schemas/LimitClass" + description: The class of the limit. For API rate limits, this is API_CATEGORY. + Attributes: + type: object + properties: {} + description: The attributes that identify the specific limit. For API rate limits, specify the Category key with a value like UserAuthentication or UserCreation. + required: + - LimitClass + - Attributes + LimitClass: + type: string + enum: + - API_CATEGORY + GetProvisionedLimitResponse: + type: object + properties: + Limit: + $ref: "#/components/schemas/LimitType" + description: The provisioned and default limit values for the requested limit. + required: + - Limit + LimitType: + description: The limit definition and current limit values for a provisioned limit. + type: object + properties: + LimitDefinition: + $ref: "#/components/schemas/LimitDefinitionType" + description: The definition that identifies this limit, including the class and attributes. + ProvisionedLimitValue: + $ref: "#/components/schemas/IntegerType" + description: The provisioned limit value, in requests per second (RPS). This is the rate that Amazon Cognito currently enforces for your account. + FreeLimitValue: + $ref: "#/components/schemas/IntegerType" + description: The default (free) limit value, in requests per second (RPS). This is the rate included at no additional cost. + required: + - LimitDefinition + - ProvisionedLimitValue + - FreeLimitValue GetSigningCertificateResponse: description: Response from Amazon Cognito for a signing certificate request. type: object @@ -7837,13 +8346,9 @@ components: description: The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA. ConfiguredUserAuthFactors: $ref: "#/components/schemas/ConfiguredUserAuthFactorsListType" - description: The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"]. + description: The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"]. PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level. required: - Username - ConfiguredUserAuthFactorsListType: - type: array - items: - $ref: "#/components/schemas/AuthFactorType" GetUserPoolMfaConfigResponse: type: object properties: @@ -8140,6 +8645,19 @@ components: ClientName: $ref: "#/components/schemas/ClientNameType" description: The app client name. + ListUserPoolReplicasResponse: + type: object + properties: + UserPoolReplicas: + $ref: "#/components/schemas/UserPoolReplicaListType" + description: A list of user pool replicas, including information about their status, role, and Region. + NextToken: + $ref: "#/components/schemas/PaginationKeyType" + description: A pagination token for retrieving the next page of results. If this value is null, there are no more results to retrieve. + UserPoolReplicaListType: + type: array + items: + $ref: "#/components/schemas/UserPoolReplicaType" ListUserPoolsResponse: description: Represents the response to list user pools. type: object @@ -8176,6 +8694,13 @@ components: CreationDate: $ref: "#/components/schemas/DateType" description: The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object. + ReplicaRegions: + $ref: "#/components/schemas/ReplicaRegionsType" + description: A list of Amazon Web Services Regions where replicas of this user pool exist. + ReplicaRegionsType: + type: array + items: + $ref: "#/components/schemas/StringType" SearchedAttributeNamesListType: type: array items: @@ -8415,6 +8940,14 @@ components: ManagedLoginBranding: $ref: "#/components/schemas/ManagedLoginBrandingType" description: The details of the branding style that you updated. + UpdateProvisionedLimitResponse: + type: object + properties: + Limit: + $ref: "#/components/schemas/LimitType" + description: The updated provisioned and default limit values. + required: + - Limit UpdateResourceServerResponse: type: object properties: @@ -8460,6 +8993,20 @@ components: CloudFrontDomain: $ref: "#/components/schemas/DomainType" description: The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your managed login or classic hosted UI pages. You domain-name authority must have an alias record that points requests for your custom domain to this FQDN. Amazon Cognito returns this value if you set a custom domain with CustomDomainConfig. If you set an Amazon Cognito prefix domain, this operation returns a blank response. + Routing: + $ref: "#/components/schemas/RoutingType" + description: The updated routing configuration for the user pool domain. + UpdateReplicaStatusType: + type: string + enum: + - ACTIVE + - INACTIVE + UpdateUserPoolReplicaResponse: + type: object + properties: + UserPoolReplica: + $ref: "#/components/schemas/UserPoolReplicaType" + description: Information about the updated user pool replica. SoftwareTokenMFAUserCodeType: type: string minLength: 6 @@ -8986,6 +9533,43 @@ components: - $ref: "#/components/x-stackQL-resources/user_pool_client_secrets/methods/add_user_pool_client_secret" delete: - $ref: "#/components/x-stackQL-resources/user_pool_client_secrets/methods/delete_user_pool_client_secret" + user_auth_factors: + id: aws.cognito_idp.user_auth_factors + name: user_auth_factors + title: user_auth_factors + methods: + admin_get_user_auth_factors: + operation: + $ref: "#/paths/~1AdminGetUserAuthFactors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_user_auth_factors: + operation: + $ref: "#/paths/~1GetUserAuthFactors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/user_auth_factors/methods/get_user_auth_factors" + insert: [] + update: [] + delete: [] devices: id: aws.cognito_idp.devices name: devices @@ -9693,6 +10277,72 @@ components: - $ref: "#/components/x-stackQL-resources/user_pool_domains/methods/update_user_pool_domain" delete: - $ref: "#/components/x-stackQL-resources/user_pool_domains/methods/delete_user_pool_domain" + user_pool_replicas: + id: aws.cognito_idp.user_pool_replicas + name: user_pool_replicas + title: user_pool_replicas + methods: + create_user_pool_replica: + operation: + $ref: "#/paths/~1CreateUserPoolReplica/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_user_pool_replica: + operation: + $ref: "#/paths/~1DeleteUserPoolReplica/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_user_pool_replicas: + operation: + $ref: "#/paths/~1ListUserPoolReplicas/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_user_pool_replica: + operation: + $ref: "#/paths/~1UpdateUserPoolReplica/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/user_pool_replicas/methods/list_user_pool_replicas" + insert: + - $ref: "#/components/x-stackQL-resources/user_pool_replicas/methods/create_user_pool_replica" + update: + - $ref: "#/components/x-stackQL-resources/user_pool_replicas/methods/update_user_pool_replica" + delete: + - $ref: "#/components/x-stackQL-resources/user_pool_replicas/methods/delete_user_pool_replica" users: id: aws.cognito_idp.users name: users @@ -10037,6 +10687,45 @@ components: update: - $ref: "#/components/x-stackQL-resources/log_delivery_configurations/methods/set_log_delivery_configuration" delete: [] + provisioned_limits: + id: aws.cognito_idp.provisioned_limits + name: provisioned_limits + title: provisioned_limits + methods: + get_provisioned_limit: + operation: + $ref: "#/paths/~1GetProvisionedLimit/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Limit + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_provisioned_limit: + operation: + $ref: "#/paths/~1UpdateProvisionedLimit/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/provisioned_limits/methods/get_provisioned_limit" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/provisioned_limits/methods/update_provisioned_limit" + delete: [] signing_certificates: id: aws.cognito_idp.signing_certificates name: signing_certificates @@ -10150,30 +10839,6 @@ components: insert: [] update: [] delete: [] - user_auth_factors: - id: aws.cognito_idp.user_auth_factors - name: user_auth_factors - title: user_auth_factors - methods: - get_user_auth_factors: - operation: - $ref: "#/paths/~1GetUserAuthFactors/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/user_auth_factors/methods/get_user_auth_factors" - insert: [] - update: [] - delete: [] user_pool_mfa_configs: id: aws.cognito_idp.user_pool_mfa_configs name: user_pool_mfa_configs diff --git a/providers/src/aws/v00.00.00000/services/compute_optimizer.yaml b/providers/src/aws/v00.00.00000/services/compute_optimizer.yaml index 21c32356..333bdc82 100644 --- a/providers/src/aws/v00.00.00000/services/compute_optimizer.yaml +++ b/providers/src/aws/v00.00.00000/services/compute_optimizer.yaml @@ -1205,13 +1205,13 @@ paths: description: The provider of the external metrics recommendation preference to create or update. Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action. This preference can only be set for the Ec2Instance resource type. For more information, see External metrics ingestion in the Compute Optimizer User Guide. lookBackPeriod: $ref: "#/components/schemas/LookBackPeriodPreference" - description: The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14. You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types. Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels. Auto Scaling group lookback preferences can only be set at the resource level. + description: The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14. You can only set this preference for the Amazon EC2 instance, Auto Scaling group, Amazon EBS volume, Amazon ECS service on Fargate, Amazon RDS DB instance, and Aurora DB cluster storage resource types. Lookback period preferences for Amazon EC2 instances, Amazon EBS volumes, Amazon ECS services, Amazon RDS DB instances, and Aurora DB cluster storage resource types can be set at the organization, account, and resource levels. Auto Scaling group lookback preferences can only be set at the resource level. Amazon EBS volume lookback preferences can be set at the organization, account, and resource levels. Amazon ECS service on Fargate lookback preferences can be set at the organization, account, and resource levels. Amazon RDS DB instance lookback preferences can be set at the organization, account, and resource levels. Aurora DB cluster storage lookback preferences can be set at the organization, account, and resource levels. Changing the lookback period for Amazon EBS volumes to 14 days does not affect the 32-day lookback period used to determine whether an Amazon EBS volume is unattached. utilizationPreferences: $ref: "#/components/schemas/UtilizationPreferences" description: "The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values. CPU utilization: P99_5 for threshold PERCENT_20 for headroom Memory utilization: PERCENT_20 for headroom You can only set CPU and memory utilization preferences for the Amazon EC2 instance resource type. The threshold setting isn’t available for memory utilization." preferredResources: $ref: "#/components/schemas/PreferredResources" - description: The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types. + description: The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. You can only set this preference for the Amazon EC2 instance, Auto Scaling group, Amazon EBS volume, Amazon ECS service, Amazon RDS DB instance, and Aurora DB cluster storage resource types. savingsEstimationMode: $ref: "#/components/schemas/SavingsEstimationMode" description: The status of the savings estimation mode preference to create or update. Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference. Only the account manager or delegated administrator of your organization can activate this preference. For more information, see Savings estimation mode in the Compute Optimizer User Guide. @@ -1649,6 +1649,8 @@ components: - UtilizationMetricsVolumeWriteOpsPerSecondMaximum - UtilizationMetricsVolumeReadBytesPerSecondMaximum - UtilizationMetricsVolumeWriteBytesPerSecondMaximum + - UtilizationMetricsVolumeIOPSExceededMaximum + - UtilizationMetricsVolumeThroughputExceededMaximum - LookbackPeriodInDays - CurrentConfigurationVolumeType - CurrentConfigurationVolumeBaselineIOPS @@ -1677,6 +1679,7 @@ components: - RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage - RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts - RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts + - EffectiveRecommendationPreferencesLookBackPeriod ExportEBSVolumeRecommendationsResponse: type: object properties: @@ -1826,6 +1829,7 @@ components: - RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage - RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts - RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts + - EffectiveRecommendationPreferencesLookBackPeriod ExportECSServiceRecommendationsResponse: type: object properties: @@ -1880,6 +1884,22 @@ components: - UtilizationMetricsActiveConnectionCountMaximum - UtilizationMetricsPacketsInFromSourceMaximum - UtilizationMetricsPacketsInFromDestinationMaximum + - UtilizationMetricsConsumedReadCapacityUnitsSum + - UtilizationMetricsConsumedWriteCapacityUnitsSum + - UtilizationMetricsNewConnectionsSum + - UtilizationMetricsEngineCPUUtilizationMaximum + - UtilizationMetricsCacheHitsSum + - UtilizationMetricsCacheMissesSum + - UtilizationMetricsKeyspaceHitsSum + - UtilizationMetricsKeyspaceMissesSum + - UtilizationMetricsIsIdleMinimum + - UtilizationMetricsUserConnectedSum + - UtilizationMetricsInvocationsSum + - UtilizationMetricsGetTypeCmdsSum + - UtilizationMetricsSetTypeCmdsSum + - UtilizationMetricsElastiCacheProcessingUnitsSum + - UtilizationMetricsCurrConnectionsSum + - UtilizationMetricsDatabaseConnectionsSum - Finding - FindingDescription - Tags @@ -2738,7 +2758,7 @@ components: properties: name: $ref: "#/components/schemas/EBSMetricName" - description: "The name of the utilization metric. The following utilization metrics are available: VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time. Unit: Count VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: Count VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: Bytes VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytes" + description: "The name of the utilization metric. The following utilization metrics are available: VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time. Unit: Count VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: Count VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: Bytes VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytes VolumeIOPSExceeded - Indicates whether the volume's provisioned IOPS performance was exceeded in a specified period of time. A value of 1 means the provisioned IOPS were exceeded; a value of 0 means they were not. Unit: None VolumeThroughputExceeded - Indicates whether the volume's provisioned throughput performance was exceeded in a specified period of time. A value of 1 means the provisioned throughput was exceeded; a value of 0 means it was not. Unit: None" statistic: $ref: "#/components/schemas/MetricStatistic" description: The statistic of the utilization metric. The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period. The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. @@ -2752,6 +2772,8 @@ components: - VolumeWriteOpsPerSecond - VolumeReadBytesPerSecond - VolumeWriteBytesPerSecond + - VolumeIOPSExceeded + - VolumeThroughputExceeded VolumeRecommendationOptions: type: array items: @@ -2802,6 +2824,9 @@ components: savingsEstimationMode: $ref: "#/components/schemas/EBSSavingsEstimationMode" description: Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes. + lookBackPeriod: + $ref: "#/components/schemas/LookBackPeriodPreference" + description: The number of days for which utilization metrics were analyzed for the volume. EBSSavingsEstimationMode: description: Describes the savings estimation mode used for calculating savings opportunity for Amazon EBS volumes. type: object @@ -3046,6 +3071,12 @@ components: - RdsDBInstanceStorage - AuroraDBClusterStorage - NatGateway + - DynamoDBTable + - ElastiCacheCluster + - MemoryDBCluster + - DocumentDBCluster + - WorkSpaces + - SageMakerEndpoint InstanceState: type: string enum: @@ -3457,6 +3488,9 @@ components: savingsEstimationMode: $ref: "#/components/schemas/ECSSavingsEstimationMode" description: Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services. + lookBackPeriod: + $ref: "#/components/schemas/LookBackPeriodPreference" + description: The number of days the Amazon ECS service utilization metrics were analyzed. ECSSavingsEstimationMode: description: Describes the savings estimation mode used for calculating savings opportunity for Amazon ECS services. type: object @@ -3483,7 +3517,7 @@ components: description: The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level. If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response. To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions. For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide. lookBackPeriod: $ref: "#/components/schemas/LookBackPeriodPreference" - description: The number of days the utilization metrics of the Amazon Web Services resource are analyzed. To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions. + description: The number of days the utilization metrics of the Amazon Web Services resource are analyzed. To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEBSVolumeRecommendations, GetECSServiceRecommendations, or GetRDSDatabaseRecommendations actions. utilizationPreferences: $ref: "#/components/schemas/UtilizationPreferences" description: The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level. To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions. @@ -3663,6 +3697,12 @@ components: - ECSService - RDSDBInstance - NatGateway + - DynamoDBTable + - ElastiCacheCluster + - MemoryDBCluster + - DocumentDBCluster + - WorkSpaces + - SageMakerEndpoint IdleFinding: type: string enum: @@ -3718,6 +3758,9 @@ components: value: $ref: "#/components/schemas/MetricValue" description: The value of the utilization metric. + dimensions: + $ref: "#/components/schemas/IdleDimensions" + description: The dimensions of the utilization metric. IdleMetricName: type: string enum: @@ -3733,6 +3776,44 @@ components: - ActiveConnectionCount - PacketsInFromSource - PacketsInFromDestination + - ConsumedReadCapacityUnits + - ConsumedWriteCapacityUnits + - ConsumedChangeDataCaptureUnits + - NewConnections + - EngineCPUUtilization + - CacheHits + - CacheMisses + - KeyspaceHits + - KeyspaceMisses + - IsIdle + - UserConnected + - Invocations + - GetTypeCmds + - SetTypeCmds + - ElastiCacheProcessingUnits + - CurrConnections + IdleDimensions: + type: array + items: + $ref: "#/components/schemas/IdleDimension" + IdleDimension: + description: Describes the dimension of an idle resource utilization metric. + type: object + properties: + key: + $ref: "#/components/schemas/IdleDimensionKey" + description: The name of the dimension key. + values: + $ref: "#/components/schemas/IdleDimensionValues" + description: The value of the dimension. + IdleDimensionKey: + type: string + IdleDimensionValues: + type: array + items: + $ref: "#/components/schemas/IdleDimensionValue" + IdleDimensionValue: + type: string IdleRecommendationErrors: type: array items: diff --git a/providers/src/aws/v00.00.00000/services/compute_optimizer_automation.yaml b/providers/src/aws/v00.00.00000/services/compute_optimizer_automation.yaml index 3130c77c..78a2ae4b 100644 --- a/providers/src/aws/v00.00.00000/services/compute_optimizer_automation.yaml +++ b/providers/src/aws/v00.00.00000/services/compute_optimizer_automation.yaml @@ -1104,7 +1104,7 @@ components: properties: comparison: $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains. + description: The comparison operator used to evaluate the attribute against the specified values. values: $ref: "#/components/schemas/StringCriteriaValues" description: List of string values to compare against when applying the criteria condition. @@ -1123,6 +1123,18 @@ components: - NumericLessThanEquals - NumericGreaterThan - NumericGreaterThanEquals + - StringEqualsIfExists + - StringNotEqualsIfExists + - StringEqualsIgnoreCaseIfExists + - StringNotEqualsIgnoreCaseIfExists + - StringLikeIfExists + - StringNotLikeIfExists + - NumericEqualsIfExists + - NumericNotEqualsIfExists + - NumericLessThanIfExists + - NumericLessThanEqualsIfExists + - NumericGreaterThanIfExists + - NumericGreaterThanEqualsIfExists StringCriteriaValues: type: array items: @@ -1142,7 +1154,7 @@ components: properties: comparison: $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator to use, such as equals, greater than, less than, etc. + description: The comparison operator used to evaluate the attribute against the specified values. values: $ref: "#/components/schemas/IntegerList" description: The list of integer values to compare against using the specified comparison operator. @@ -1162,7 +1174,7 @@ components: properties: comparison: $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator to use, such as equals, greater than, less than, etc. + description: The comparison operator used to evaluate the attribute against the specified values. values: $ref: "#/components/schemas/DoubleList" description: The list of double values to compare against using the specified comparison operator. @@ -1183,7 +1195,7 @@ components: properties: comparison: $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator used to evaluate the tag criteria, such as equals, not equals, or contains. + description: The comparison operator used to evaluate the attribute against the specified values. key: $ref: "#/components/schemas/StringCriteriaValue" description: The tag key to use for comparison when filtering resources. diff --git a/providers/src/aws/v00.00.00000/services/config.yaml b/providers/src/aws/v00.00.00000/services/config.yaml index a0661c5b..14557bc0 100644 --- a/providers/src/aws/v00.00.00000/services/config.yaml +++ b/providers/src/aws/v00.00.00000/services/config.yaml @@ -274,6 +274,33 @@ paths: responses: "200": description: Success + /DeleteConnector: + post: + operationId: DeleteConnector + description: Deletes the specified connector. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - StarlingDoveService.DeleteConnector + default: StarlingDoveService.DeleteConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector that you want to delete. + responses: + "200": + description: Success /DeleteDeliveryChannel: post: operationId: DeleteDeliveryChannel @@ -585,9 +612,10 @@ paths: properties: ServicePrincipal: $ref: "#/components/schemas/ServicePrincipal" - description: The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to delete. - required: - - ServicePrincipal + description: The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to delete. This field is only supported for Amazon Web Services service principals. For third-party service-linked configuration recorders, use Arn instead. + Arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the service-linked configuration recorder that you want to delete. For third-party service-linked configuration recorders, you must use Arn. You must specify exactly one of Arn or ServicePrincipal. responses: "200": description: Success @@ -918,12 +946,12 @@ paths: ConfigRuleNames: $ref: "#/components/schemas/ConfigRuleNames" description: The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules. - NextToken: - $ref: "#/components/schemas/String" - description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. Filters: $ref: "#/components/schemas/DescribeConfigRulesFilters" description: Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide. + NextToken: + $ref: "#/components/schemas/String" + description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. responses: "200": description: Success @@ -1036,7 +1064,7 @@ paths: description: The name of the configuration recorder. If the name is not specified, the operation returns the status for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder. ServicePrincipal: $ref: "#/components/schemas/ServicePrincipal" - description: For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. + description: For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. This field is only supported for Amazon Web Services service principals. For third-party service-linked configuration recorders, use Arn instead. Arn: $ref: "#/components/schemas/AmazonResourceName" description: The Amazon Resource Name (ARN) of the configuration recorder that you want to specify. @@ -1073,7 +1101,7 @@ paths: description: A list of names of the configuration recorders that you want to specify. When making a request to this operation, you can only specify one configuration recorder. ServicePrincipal: $ref: "#/components/schemas/ServicePrincipal" - description: For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. + description: For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. This field is only supported for Amazon Web Services service principals. For third-party service-linked configuration recorders, use Arn instead. Arn: $ref: "#/components/schemas/AmazonResourceName" description: The Amazon Resource Name (ARN) of the configuration recorder that you want to specify. @@ -2076,6 +2104,37 @@ paths: application/json: schema: $ref: "#/components/schemas/GetConformancePackComplianceSummaryResponse" + /GetConnector: + post: + operationId: GetConnector + description: Returns the details of the specified connector. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - StarlingDoveService.GetConnector + default: StarlingDoveService.GetConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetConnectorResponse" /GetCustomRulePolicy: post: operationId: GetCustomRulePolicy @@ -2505,6 +2564,43 @@ paths: application/json: schema: $ref: "#/components/schemas/ListConformancePackComplianceScoresResponse" + /ListConnectors: + post: + operationId: ListConnectors + description: Returns a list of connectors depending on the filters you specify. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - StarlingDoveService.ListConnectors + default: StarlingDoveService.ListConnectors + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/ListConnectorsMaxResults" + description: The maximum number of results to include in the response. + NextToken: + $ref: "#/components/schemas/String" + description: The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + Filters: + $ref: "#/components/schemas/ConnectorFilterList" + description: Filters the results based on a list of ConnectorFilter objects that you specify. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListConnectorsResponse" /ListDiscoveredResources: post: operationId: ListDiscoveredResources @@ -2647,7 +2743,7 @@ paths: properties: ResourceArn: $ref: "#/components/schemas/AmazonResourceName" - description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery" + description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery Connector" Limit: $ref: "#/components/schemas/Limit" description: The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default. @@ -2866,6 +2962,42 @@ paths: application/json: schema: $ref: "#/components/schemas/PutConformancePackResponse" + /PutConnector: + post: + operationId: PutConnector + description: Creates a connector that specifies the connection between a third-party cloud service provider and Config. A connector is required to create a service-linked configuration recorder for a third-party cloud service provider using the PutThirdPartyServiceLinkedConfigurationRecorder operation. This API creates a service-linked role AWSServiceRoleForConfigThirdParty in your account. The service-linked role is created only when the role does not exist in your account. Connectors cannot be updated To update the connector configuration, you must delete all associated configuration recorders, delete the connector, and recreate it with the updated configuration. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - StarlingDoveService.PutConnector + default: StarlingDoveService.PutConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ConnectorConfiguration: + $ref: "#/components/schemas/ConnectorConfiguration" + description: The provider-specific configuration for connecting to the third-party cloud service provider. + Tags: + $ref: "#/components/schemas/TagsList" + description: The tags for the connector. Each tag consists of a key and an optional value, both of which you define. + required: + - ConnectorConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutConnectorResponse" /PutDeliveryChannel: post: operationId: PutDeliveryChannel @@ -3007,6 +3139,9 @@ paths: OrganizationCustomPolicyRuleMetadata: $ref: "#/components/schemas/OrganizationCustomPolicyRuleMetadata" description: An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule. + Tags: + $ref: "#/components/schemas/TagsList" + description: The tags for the organization Config rule. Each tag consists of a key and an optional value, both of which you define. required: - OrganizationConfigRuleName responses: @@ -3058,6 +3193,9 @@ paths: ExcludedAccounts: $ref: "#/components/schemas/ExcludedAccounts" description: A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack. + Tags: + $ref: "#/components/schemas/TagsList" + description: The tags for the organization conformance pack. Each tag consists of a key and an optional value, both of which you define. required: - OrganizationConformancePackName responses: @@ -3295,6 +3433,50 @@ paths: application/json: schema: $ref: "#/components/schemas/PutStoredQueryResponse" + /PutThirdPartyServiceLinkedConfigurationRecorder: + post: + operationId: PutThirdPartyServiceLinkedConfigurationRecorder + description: Creates or updates a service-linked configuration recorder that is linked to a third-party cloud service provider based on the ConnectorArn you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. If a service-linked configuration recorder already exists for the specified service principal and connector, calling this operation again updates the ScopeConfiguration. This operation can only be called by the Amazon Web Services service linked to the configuration recorder Customers cannot call this operation directly. Only the linked Amazon Web Services service can create or update the service-linked configuration recorder. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - StarlingDoveService.PutThirdPartyServiceLinkedConfigurationRecorder + default: StarlingDoveService.PutThirdPartyServiceLinkedConfigurationRecorder + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ServicePrincipal: + $ref: "#/components/schemas/ServicePrincipal" + description: The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to create. + ConnectorArn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector that specifies the connection between the third-party cloud service provider and Config. The specified connector must exist. + ScopeConfiguration: + $ref: "#/components/schemas/ScopeConfiguration" + description: Specifies the scope of resources to record from the third-party cloud service provider. + Tags: + $ref: "#/components/schemas/TagsList" + description: The tags for a service-linked configuration recorder. Each tag consists of a key and an optional value, both of which you define. + required: + - ServicePrincipal + - ConnectorArn + - ScopeConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutThirdPartyServiceLinkedConfigurationRecorderResponse" /SelectAggregateResourceConfig: post: operationId: SelectAggregateResourceConfig @@ -3575,7 +3757,7 @@ paths: properties: ResourceArn: $ref: "#/components/schemas/AmazonResourceName" - description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery" + description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery Connector" Tags: $ref: "#/components/schemas/TagList" description: An array of tag object. @@ -3608,7 +3790,7 @@ paths: properties: ResourceArn: $ref: "#/components/schemas/AmazonResourceName" - description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery" + description: "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported: ConfigurationRecorder ConfigRule OrganizationConfigRule ConformancePack OrganizationConformancePack ConfigurationAggregator AggregationAuthorization StoredQuery Connector" TagKeys: $ref: "#/components/schemas/TagKeyList" description: The keys of the tags to be removed. @@ -4239,6 +4421,12 @@ components: servicePrincipal: $ref: "#/components/schemas/ServicePrincipal" description: For service-linked configuration recorders, specifies the linked Amazon Web Services service for the configuration recorder. + connectorArn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector that specifies the connection between a third-party cloud service provider and Config. + scopeConfiguration: + $ref: "#/components/schemas/ScopeConfiguration" + description: Specifies the scope of resources to record from the third-party cloud service provider connected through the connector. RecorderName: type: string minLength: 1 @@ -4343,6 +4531,47 @@ components: minLength: 1 maxLength: 128 pattern: "[\\w+=,.@-]+" + ScopeConfiguration: + description: Specifies the scope of resources to record from a third-party cloud service provider. + type: object + properties: + scopeType: + $ref: "#/components/schemas/ScopeType" + description: The type of scope for the third-party cloud resources. Valid values include tenant and subscription. + scopeValues: + $ref: "#/components/schemas/ScopeValues" + description: The list of specific scope values for the third-party cloud resources. For example, a list of Azure subscriptions or management groups. + allRegions: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to record resources from all supported regions for the third-party cloud service provider. + includedRegions: + $ref: "#/components/schemas/IncludedRegions" + description: The list of regions from the third-party cloud service provider to include when recording resources. Used when allRegions is set to false. + required: + - scopeType + - allRegions + ScopeType: + type: string + minLength: 1 + maxLength: 256 + ScopeValues: + type: array + items: + $ref: "#/components/schemas/ScopeValue" + ScopeValue: + type: string + minLength: 1 + maxLength: 256 + Boolean: + type: boolean + IncludedRegions: + type: array + items: + $ref: "#/components/schemas/ThirdPartyCloudRegion" + ThirdPartyCloudRegion: + type: string + minLength: 1 + maxLength: 128 ConfigurationAggregatorName: type: string minLength: 1 @@ -4702,8 +4931,6 @@ components: description: Indicates whether the maximum count is reached. Integer: type: integer - Boolean: - type: boolean AggregateConformancePackComplianceFilters: description: Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack. type: object @@ -4941,11 +5168,19 @@ components: EvaluationMode: $ref: "#/components/schemas/EvaluationMode" description: The mode of an evaluation. The valid values are Detective or Proactive. + RuleEvaluationVisibility: + $ref: "#/components/schemas/RuleEvaluationVisibility" + description: Filters the results by RuleEvaluationVisibility. EvaluationMode: type: string enum: - DETECTIVE - PROACTIVE + RuleEvaluationVisibility: + type: string + enum: + - EXTERNAL + - INTERNAL DescribeConfigRulesResponse: type: object properties: @@ -4996,6 +5231,9 @@ components: EvaluationModes: $ref: "#/components/schemas/EvaluationModes" description: The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only. + RuleEvaluationVisibility: + $ref: "#/components/schemas/RuleEvaluationVisibility" + description: Indicates whether you can get Evaluations for the Config rule. You can get Evaluations for the Amazon Web Services Config rule if this value is EXTERNAL. You cannot get Evaluations for the Amazon Web Services Config rule if this value is INTERNAL. required: - Source EmptiableStringWithCharLimit256: @@ -5018,6 +5256,9 @@ components: ComplianceResourceId: $ref: "#/components/schemas/BaseResourceId" description: The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes. + ServicePrincipals: + $ref: "#/components/schemas/ServicePrincipals" + description: The service principals of the Amazon Web Services services for the rule. The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule. ComplianceResourceTypes: type: array items: @@ -5026,6 +5267,10 @@ components: type: string minLength: 1 maxLength: 128 + ServicePrincipals: + type: array + items: + $ref: "#/components/schemas/StringWithCharLimit128" Source: description: Provides the CustomPolicyDetails, the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources. type: object @@ -6836,6 +7081,67 @@ components: required: - ConformancePackName - ConformancePackComplianceStatus + GetConnectorResponse: + type: object + properties: + Connector: + $ref: "#/components/schemas/Connector" + description: The details of the specified connector. + required: + - Connector + Connector: + description: The details of the connector, including the connector configuration and connector ARN. + type: object + properties: + name: + $ref: "#/components/schemas/ConnectorName" + description: The name of the connector. + arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector. + connectorConfiguration: + $ref: "#/components/schemas/ConnectorConfiguration" + description: The provider-specific configuration for connecting to the third-party cloud service provider. + createdTime: + $ref: "#/components/schemas/Date" + description: The date and time that the connector was created. + required: + - name + - arn + - connectorConfiguration + - createdTime + ConnectorName: + type: string + minLength: 1 + maxLength: 256 + ConnectorConfiguration: + description: The provider-specific configuration for connecting to the third-party cloud service provider. You must specify exactly one provider configuration. + type: object + properties: + azure: + $ref: "#/components/schemas/AzureConnectorConfiguration" + description: The configuration for an Azure connector. + AzureConnectorConfiguration: + description: The configuration details for connecting to Microsoft Azure. + type: object + properties: + tenantIdentifier: + $ref: "#/components/schemas/AzureTenantIdentifier" + description: The Azure tenant identifier. + clientIdentifier: + $ref: "#/components/schemas/AzureClientIdentifier" + description: The Azure client identifier. + required: + - tenantIdentifier + - clientIdentifier + AzureTenantIdentifier: + type: string + minLength: 1 + maxLength: 128 + AzureClientIdentifier: + type: string + minLength: 1 + maxLength: 128 GetCustomRulePolicyResponse: type: object properties: @@ -7223,7 +7529,7 @@ components: items: $ref: "#/components/schemas/ConfigurationRecorderSummary" ConfigurationRecorderSummary: - description: A summary of a configuration recorder, including the arn, name, servicePrincipal, and recordingScope. + description: A summary of a configuration recorder, including the arn, name, servicePrincipal, recordingScope, and provider. type: object properties: arn: @@ -7238,10 +7544,17 @@ components: recordingScope: $ref: "#/components/schemas/RecordingScope" description: Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free (INTERNAL) or if you are charged a service fee for recording (PAID). + provider: + $ref: "#/components/schemas/Provider" + description: For service-linked configuration recorders that record resources from a third-party cloud service provider, indicates the cloud service provider. Currently, AZURE is supported. required: - arn - name - recordingScope + Provider: + type: string + enum: + - AZURE ConformancePackComplianceScoresFilters: description: A list of filters to apply to the conformance pack compliance score result set. type: object @@ -7297,6 +7610,72 @@ components: LastUpdatedTime: type: string format: date-time + ListConnectorsMaxResults: + type: integer + minimum: 0 + maximum: 100 + ConnectorFilterList: + type: array + items: + $ref: "#/components/schemas/ConnectorFilter" + ConnectorFilter: + description: Filters connectors based on the connector provider. + type: object + properties: + filterName: + $ref: "#/components/schemas/ConnectorFilterName" + description: The name of the filter. Currently, only provider is supported. + filterValues: + $ref: "#/components/schemas/FilterValueList" + description: "The value of the filter. For provider, valid values include: AZURE." + ConnectorFilterName: + type: string + enum: + - provider + FilterValueList: + type: array + items: + $ref: "#/components/schemas/String" + ListConnectorsResponse: + type: object + properties: + ConnectorSummaries: + $ref: "#/components/schemas/ConnectorSummaries" + description: A list of ConnectorSummary objects. + NextToken: + $ref: "#/components/schemas/String" + description: The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + required: + - ConnectorSummaries + ConnectorSummaries: + type: array + items: + $ref: "#/components/schemas/ConnectorSummary" + ConnectorSummary: + description: A summary of a connector. + type: object + properties: + arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector. + name: + $ref: "#/components/schemas/ConnectorName" + description: The name of the connector. + provider: + $ref: "#/components/schemas/Provider" + description: The third-party cloud service provider. Currently, AZURE is supported. + tenantIdentifier: + $ref: "#/components/schemas/AzureTenantIdentifier" + description: The Azure tenant identifier for the connector. + createdTime: + $ref: "#/components/schemas/Date" + description: The date and time that the connector was created. + required: + - arn + - name + - provider + - tenantIdentifier + - createdTime ResourceIdList: type: array items: @@ -7481,6 +7860,14 @@ components: ConformancePackArn: $ref: "#/components/schemas/ConformancePackArn" description: ARN of the conformance pack. + PutConnectorResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the connector. + required: + - Arn Evaluations: type: array items: @@ -7665,6 +8052,18 @@ components: QueryArn: $ref: "#/components/schemas/QueryArn" description: Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id. + PutThirdPartyServiceLinkedConfigurationRecorderResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AmazonResourceName" + description: The Amazon Resource Name (ARN) of the specified configuration recorder. + Name: + $ref: "#/components/schemas/RecorderName" + description: The name of the specified configuration recorder. + required: + - Arn + - Name Expression: type: string minLength: 1 @@ -7866,6 +8265,19 @@ components: config: requestBodyTranslate: algorithm: naive + put_third_party_service_linked_configuration_recorder: + operation: + $ref: "#/paths/~1PutThirdPartyServiceLinkedConfigurationRecorder/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive start_configuration_recorder: operation: $ref: "#/paths/~1StartConfigurationRecorder/post" @@ -7897,6 +8309,7 @@ components: update: - $ref: "#/components/x-stackQL-resources/configuration_recorders/methods/associate_resource_types" replace: + - $ref: "#/components/x-stackQL-resources/configuration_recorders/methods/put_third_party_service_linked_configuration_recorder" - $ref: "#/components/x-stackQL-resources/configuration_recorders/methods/put_configuration_recorder" - $ref: "#/components/x-stackQL-resources/configuration_recorders/methods/put_service_linked_configuration_recorder" delete: @@ -8304,6 +8717,80 @@ components: - $ref: "#/components/x-stackQL-resources/conformance_packs/methods/put_conformance_pack" delete: - $ref: "#/components/x-stackQL-resources/conformance_packs/methods/delete_conformance_pack" + connectors: + id: aws.config.connectors + name: connectors + title: connectors + methods: + delete_connector: + operation: + $ref: "#/paths/~1DeleteConnector/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_connector: + operation: + $ref: "#/paths/~1GetConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Connector + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_connectors: + operation: + $ref: "#/paths/~1ListConnectors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ConnectorSummaries + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + put_connector: + operation: + $ref: "#/paths/~1PutConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/connectors/methods/list_connectors" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/connectors/methods/put_connector" + delete: + - $ref: "#/components/x-stackQL-resources/connectors/methods/delete_connector" delivery_channels: id: aws.config.delivery_channels name: delivery_channels diff --git a/providers/src/aws/v00.00.00000/services/connect.yaml b/providers/src/aws/v00.00.00000/services/connect.yaml index b5b304bf..8a90bb46 100644 --- a/providers/src/aws/v00.00.00000/services/connect.yaml +++ b/providers/src/aws/v00.00.00000/services/connect.yaml @@ -20,14 +20,14 @@ paths: /evaluation-forms/{instance_id}/{evaluation_form_id}/activate: post: operationId: ActivateEvaluationForm - description: Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. + description: Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -55,14 +55,14 @@ paths: /analytics-data/instance/{instance_id}/association: put: operationId: AssociateAnalyticsDataSet - description: Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call. + description: Associates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -85,14 +85,14 @@ paths: $ref: "#/components/schemas/AssociateAnalyticsDataSetResponse" post: operationId: DisassociateAnalyticsDataSet - description: Removes the dataset ID associated with a given Amazon Connect instance. + description: Removes the dataset ID associated with a given Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -111,14 +111,14 @@ paths: description: Success get: operationId: ListAnalyticsDataAssociations - description: Lists the association status of requested dataset ID for a given Amazon Connect instance. + description: Lists the association status of requested dataset ID for a given Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: DataSetId in: query required: false @@ -147,14 +147,14 @@ paths: /instance/{instance_id}/approved-origin: put: operationId: AssociateApprovedOrigin - description: This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance. + description: This API is in preview release for Connect Customer and is subject to change. Associates an approved origin to an Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -171,14 +171,14 @@ paths: description: Success delete: operationId: DisassociateApprovedOrigin - description: This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect. + description: This API is in preview release for Connect Customer and is subject to change. Revokes access to integrated applications from Connect Customer. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: origin in: query required: true @@ -197,14 +197,14 @@ paths: /instance/{instance_id}/bot: put: operationId: AssociateBot - description: This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot. + description: This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex or Amazon Lex V2 bot. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -223,14 +223,14 @@ paths: description: Success post: operationId: DisassociateBot - description: This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. + description: This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -250,20 +250,20 @@ paths: /contacts/{instance_id}/{contact_id}/associate-user: post: operationId: AssociateContactWithUser - description: "Associates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, and task contacts. It does not support voice contacts. Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations. It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations. It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases. The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Amazon Connect quotas in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas." + description: "Associates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, task, and voice contacts. For voice callbacks, this API does not support customer-first mode. This API can be used to offer a contact to an agent even if the agent is currently at maximum concurrency for the channel. Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations. It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations. It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases. The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Connect Customer quotas in the Connect Customer Administrator Guide. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. requestBody: required: true content: @@ -285,14 +285,14 @@ paths: /default-vocabulary/{instance_id}/{language_code}: put: operationId: AssociateDefaultVocabulary - description: Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language. + description: Associates an existing vocabulary as the default. Contact Lens for Connect Customer uses the vocabulary in post-call and real-time analysis sessions for the given language. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: language_code in: path required: true @@ -318,7 +318,7 @@ paths: /email-addresses/{instance_id}/{email_address_id}/associate-alias: post: operationId: AssociateEmailAddressAlias - description: "Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Amazon Connect endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships)." + description: "Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Connect Customer instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Connect Customer endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships)." parameters: - name: email_address_id in: path @@ -331,7 +331,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -362,7 +362,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -390,7 +390,7 @@ paths: /hours-of-operations/{instance_id}/{hours_of_operation_id}/associate-hours: post: operationId: AssociateHoursOfOperations - description: Associates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s). + description: Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide. parameters: - name: instance_id in: path @@ -421,14 +421,14 @@ paths: /instance/{instance_id}/storage-config: put: operationId: AssociateInstanceStorageConfig - description: This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association. + description: This API is in preview release for Connect Customer and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -455,14 +455,14 @@ paths: /instance/{instance_id}/lambda-function: put: operationId: AssociateLambdaFunction - description: This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function. + description: This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Lambda function. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -481,14 +481,14 @@ paths: description: Success delete: operationId: DisassociateLambdaFunction - description: This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks. + description: This API is in preview release for Connect Customer and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.. - name: functionArn in: query required: false @@ -507,14 +507,14 @@ paths: /instance/{instance_id}/lex-bot: put: operationId: AssociateLexBot - description: This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots. + description: This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -533,14 +533,14 @@ paths: description: Success delete: operationId: DisassociateLexBot - description: This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot. + description: This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: botName in: query required: true @@ -565,7 +565,7 @@ paths: /phone-number/{phone_number_id}/contact-flow: put: operationId: AssociatePhoneNumberContactFlow - description: Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. + description: Associates a flow with a phone number claimed to your Connect Customer instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. parameters: - name: phone_number_id in: path @@ -592,7 +592,7 @@ paths: description: Success delete: operationId: DisassociatePhoneNumberContactFlow - description: Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. + description: Removes the flow association from a phone number claimed to your Connect Customer instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. parameters: - name: phone_number_id in: path @@ -605,21 +605,21 @@ paths: required: false schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success /queues/{instance_id}/{queue_id}/associate-email-addresses: post: operationId: AssociateQueueEmailAddresses - description: Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue. Important things to know You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50. The email addresses must already exist in the Amazon Connect instance before they can be associated with a queue. Agents will be able to select from these associated email addresses when handling email contacts in the queue. For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted. For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile. + description: Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue. Important things to know You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50. The email addresses must already exist in the Connect Customer instance before they can be associated with a queue. Agents will be able to select from these associated email addresses when handling email contacts in the queue. For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted. For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -652,7 +652,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -683,7 +683,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -707,14 +707,14 @@ paths: /instance/{instance_id}/security-key: put: operationId: AssociateSecurityKey - description: This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance. + description: This API is in preview release for Connect Customer and is subject to change. Associates a security key to the instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -817,7 +817,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -864,7 +864,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance). + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance). - name: user_id in: path required: true @@ -923,14 +923,14 @@ paths: /analytics-data/instance/{instance_id}/associations: put: operationId: BatchAssociateAnalyticsDataSet - description: Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call. + description: Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -953,14 +953,14 @@ paths: $ref: "#/components/schemas/BatchAssociateAnalyticsDataSetResponse" post: operationId: BatchDisassociateAnalyticsDataSet - description: Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call. + description: Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1102,7 +1102,7 @@ paths: required: true schema: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. requestBody: required: true content: @@ -1123,20 +1123,20 @@ paths: $ref: "#/components/schemas/BatchGetAttachedFileMetadataResponse" put: operationId: StartAttachedFileUpload - description: Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email. + description: Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to a Connect Customer Case, Connect Customer Email, or Connect Customer Task. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The unique identifier of the Amazon Connect instance. + description: The unique identifier of the Connect Customer instance. - name: associatedResourceArn in: query required: true schema: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. requestBody: required: true content: @@ -1179,7 +1179,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1203,14 +1203,14 @@ paths: /contact/batch/{instance_id}: put: operationId: BatchPutContact - description: Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. + description: Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Connect Customer. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1269,7 +1269,7 @@ paths: /phone-number/claim: post: operationId: ClaimPhoneNumber - description: Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. + description: Claims an available phone number to your Connect Customer instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Connect Customer Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. parameters: [] requestBody: required: true @@ -1309,7 +1309,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The unique identifier of the Amazon Connect instance. + description: The unique identifier of the Connect Customer instance. - name: file_id in: path required: true @@ -1321,7 +1321,7 @@ paths: required: true schema: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. responses: "200": description: Success @@ -1350,7 +1350,7 @@ paths: required: true schema: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. responses: "200": description: Success @@ -1367,7 +1367,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The unique identifier of the Amazon Connect instance. + description: The unique identifier of the Connect Customer instance. - name: file_id in: path required: true @@ -1385,7 +1385,7 @@ paths: required: true schema: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. responses: "200": description: Success @@ -1396,14 +1396,14 @@ paths: /agent-status/{instance_id}: put: operationId: CreateAgentStatus - description: Creates an agent status for the specified Amazon Connect instance. + description: Creates an agent status for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1440,7 +1440,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -1466,6 +1466,82 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAgentStatusResponse" + /attached-files/{instance_id}/files: + put: + operationId: CreateAttachedFile + description: Creates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage. Use this API to attach voice recordings to contacts for downstream processing such as conversational analytics. The AssociatedResourceArn must be the ARN of a completed voice contact, FileUseCaseType must be set to VOICE_RECORDING, and FileSourceUri must be a valid S3 URI. For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: associatedResourceArn + in: query + required: true + schema: + $ref: "#/components/schemas/ARN" + description: The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported. This value must be a valid ARN. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ClientToken: + $ref: "#/components/schemas/ClientToken" + FileUseCaseType: + $ref: "#/components/schemas/FileUseCaseType" + FileSourceUri: + $ref: "#/components/schemas/FileSourceUri" + Tags: + $ref: "#/components/schemas/TagMap" + required: + - FileUseCaseType + - FileSourceUri + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAttachedFileResponse" + /auth/code/{instance_id}: + post: + operationId: CreateAuthCode + description: Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Scope: + $ref: "#/components/schemas/AuthScope" + MaxSessionDurationMinutes: + $ref: "#/components/schemas/MaxSessionDurationMinutes" + SessionInactivityDurationMinutes: + $ref: "#/components/schemas/SessionInactivityDurationMinutes" + required: + - Scope + - SessionInactivityDurationMinutes + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAuthCodeResponse" /contact/create-contact: put: operationId: CreateContact @@ -1519,14 +1595,14 @@ paths: /contact-flows/{instance_id}: put: operationId: CreateContactFlow - description: Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. + description: Creates a flow for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow language. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. requestBody: required: true content: @@ -1556,14 +1632,14 @@ paths: /contact-flow-modules/{instance_id}: put: operationId: CreateContactFlowModule - description: Creates a flow module for the specified Amazon Connect instance. + description: Creates a flow module for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1602,7 +1678,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -1642,7 +1718,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -1677,7 +1753,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: contact_flow_id in: path required: true @@ -1867,14 +1943,14 @@ paths: /email-addresses/{instance_id}: put: operationId: CreateEmailAddress - description: Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide. + description: Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1904,14 +1980,14 @@ paths: /evaluation-forms/{instance_id}: put: operationId: CreateEvaluationForm - description: Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form. + description: Creates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -1952,14 +2028,14 @@ paths: $ref: "#/components/schemas/CreateEvaluationFormResponse" get: operationId: ListEvaluationForms - description: Lists evaluation forms in the specified Amazon Connect instance. + description: Lists evaluation forms in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: maxResults in: query required: false @@ -1979,6 +2055,72 @@ paths: application/json: schema: $ref: "#/components/schemas/ListEvaluationFormsResponse" + /extraction-definitions/{instance_id}: + post: + operationId: CreateExtractionDefinition + description: Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ClientToken: + $ref: "#/components/schemas/ClientToken" + Name: + $ref: "#/components/schemas/ExtractionDefinitionName" + ExtractionConfiguration: + $ref: "#/components/schemas/ExtractionConfiguration" + Display: + $ref: "#/components/schemas/ExtractionDefinitionDisplay" + Tags: + $ref: "#/components/schemas/TagMap" + required: + - ExtractionConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateExtractionDefinitionResponse" + get: + operationId: ListExtractionDefinitions + description: Lists extraction definitions in the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResult100" + description: The maximum number of results to return per page. The default MaxResult size is 100. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListExtractionDefinitionsResponse" /hours-of-operations/{instance_id}: put: operationId: CreateHoursOfOperation @@ -1989,7 +2131,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2021,14 +2163,14 @@ paths: /hours-of-operations/{instance_id}/{hours_of_operation_id}/overrides: put: operationId: CreateHoursOfOperationOverride - description: Creates an hours of operation override in an Amazon Connect hours of operation resource. + description: Creates an hours of operation override in an Connect Customer hours of operation resource. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -2075,7 +2217,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -2104,7 +2246,7 @@ paths: /instance: put: operationId: CreateInstance - description: This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. + description: This API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer. For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. parameters: [] requestBody: required: true @@ -2140,7 +2282,7 @@ paths: $ref: "#/components/schemas/CreateInstanceResponse" get: operationId: ListInstances - description: This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked. + description: This API is in preview release for Connect Customer and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked. parameters: - name: nextToken in: query @@ -2164,14 +2306,14 @@ paths: /instance/{instance_id}/integration-associations: put: operationId: CreateIntegrationAssociation - description: Creates an Amazon Web Services resource association with an Amazon Connect instance. + description: Creates an Amazon Web Services resource association with an Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2203,14 +2345,14 @@ paths: $ref: "#/components/schemas/CreateIntegrationAssociationResponse" get: operationId: ListIntegrationAssociations - description: Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance. + description: Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: integrationType in: query required: false @@ -2242,6 +2384,84 @@ paths: application/json: schema: $ref: "#/components/schemas/ListIntegrationAssociationsResponse" + /metrics/definitions/{instance_id}: + put: + operationId: CreateMetric + description: Creates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing Amazon Web Services-managed metrics, optionally with filters applied. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/MetricName" + MetricCalculation: + $ref: "#/components/schemas/MetricCalculation" + Unit: + $ref: "#/components/schemas/MetricUnit" + Status: + $ref: "#/components/schemas/MetricStatus" + ClientToken: + $ref: "#/components/schemas/ClientToken" + Description: + $ref: "#/components/schemas/MetricDescription" + PositiveTrendIndicator: + $ref: "#/components/schemas/TrendIndicator" + Tags: + $ref: "#/components/schemas/TagMap" + required: + - MetricCalculation + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateMetricResponse" + get: + operationId: ListMetrics + description: Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: type + in: query + required: false + schema: + $ref: "#/components/schemas/MetricType" + description: "The type of metrics to list. Valid values: AWS_MANAGED | CUSTOMER_MANAGED." + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResult100" + description: The maximum number of results to return per page. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMetricsResponse" /notifications/{instance_id}: put: operationId: CreateNotification @@ -2347,14 +2567,14 @@ paths: /contact/persistent-contact-association/{instance_id}/{initial_contact_id}: post: operationId: CreatePersistentContactAssociation - description: Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide. + description: Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: initial_contact_id in: path required: true @@ -2387,14 +2607,14 @@ paths: /predefined-attributes/{instance_id}: put: operationId: CreatePredefinedAttribute - description: "Creates a new predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Amazon Connect quotas. Use cases Following are common uses cases for this API: Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes. Endpoints: See Amazon Connect endpoints and quotas." + description: "Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use cases Following are common uses cases for this API: Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2415,14 +2635,14 @@ paths: description: Success get: operationId: ListPredefinedAttributes - description: "Lists predefined attributes for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Amazon Connect quotas. Endpoints: See Amazon Connect endpoints and quotas." + description: "Lists predefined attributes for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Connect Customer quotas. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -2445,14 +2665,14 @@ paths: /prompts/{instance_id}: put: operationId: CreatePrompt - description: Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide. + description: Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2480,7 +2700,7 @@ paths: /push-notification/{instance_id}/registrations: put: operationId: CreatePushNotificationRegistration - description: Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide. + description: Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Connect Customer for mobile chat in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path @@ -2520,14 +2740,14 @@ paths: /queues/{instance_id}: put: operationId: CreateQueue - description: Creates a new queue for the specified Amazon Connect instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. + description: Creates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2565,14 +2785,14 @@ paths: /quick-connects/{instance_id}: put: operationId: CreateQuickConnect - description: Creates a quick connect for the specified Amazon Connect instance. + description: Creates a quick connect for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2599,14 +2819,14 @@ paths: $ref: "#/components/schemas/CreateQuickConnectResponse" get: operationId: ListQuickConnects - description: Provides information about the quick connects for the specified Amazon Connect instance. + description: Provides information about the quick connects for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats. - name: nextToken in: query required: false @@ -2624,7 +2844,7 @@ paths: required: false schema: $ref: "#/components/schemas/QuickConnectTypes" - description: "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." + description: "The type of quick connect. In the Connect Customer admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." responses: "200": description: Success @@ -2642,7 +2862,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2679,14 +2899,14 @@ paths: /rules/{instance_id}: post: operationId: CreateRule - description: Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. + description: Creates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2720,14 +2940,14 @@ paths: $ref: "#/components/schemas/CreateRuleResponse" get: operationId: ListRules - description: List all rules for the specified Amazon Connect instance. + description: List all rules for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: publishStatus in: query required: false @@ -2762,14 +2982,14 @@ paths: /security-profiles/{instance_id}: put: operationId: CreateSecurityProfile - description: Creates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Creates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2811,14 +3031,14 @@ paths: /instance/{instance_id}/task/template: put: operationId: CreateTaskTemplate - description: Creates a new task template in the specified Amazon Connect instance. + description: Creates a new task template in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -2853,14 +3073,14 @@ paths: $ref: "#/components/schemas/CreateTaskTemplateResponse" get: operationId: ListTaskTemplates - description: Lists task templates for the specified Amazon Connect instance. + description: Lists task templates for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -2952,7 +3172,7 @@ paths: /traffic-distribution-group: put: operationId: CreateTrafficDistributionGroup - description: Creates a traffic distribution group given an Amazon Connect instance that has been replicated. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide. + description: Creates a traffic distribution group given an Connect Customer instance that has been replicated. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Connect Customer Administrator Guide. parameters: [] requestBody: required: true @@ -2990,7 +3210,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: integration_association_id in: path required: true @@ -3026,7 +3246,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: integration_association_id in: path required: true @@ -3055,14 +3275,14 @@ paths: /users/{instance_id}: put: operationId: CreateUser - description: "Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide." + description: "Creates a user account for the specified Connect Customer instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Connect Customer or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Connect Customer admin website, see Add Users in the Connect Customer Administrator Guide." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -3118,7 +3338,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -3149,7 +3369,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. requestBody: required: true content: @@ -3185,7 +3405,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: type in: query required: false @@ -3221,7 +3441,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -3248,14 +3468,14 @@ paths: $ref: "#/components/schemas/CreateViewVersionResponse" get: operationId: ListViewVersions - description: Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest. + description: Returns all the available versions for the specified Connect Customer instance and view identifier. Results will be sorted from highest to lowest. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -3284,14 +3504,14 @@ paths: /vocabulary/{instance_id}: post: operationId: CreateVocabulary - description: Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language. + description: Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -3463,14 +3683,14 @@ paths: /evaluation-forms/{instance_id}/{evaluation_form_id}/deactivate: post: operationId: DeactivateEvaluationForm - description: Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. + description: Deactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -3495,17 +3715,52 @@ paths: application/json: schema: $ref: "#/components/schemas/DeactivateEvaluationFormResponse" + /contact/delete/{instance_id}/{contact_id}: + post: + operationId: DeleteContactData + description: Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state. This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. We remove only the fields that Connect Customer identifies and stores as PII. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: contact_id + in: path + required: true + schema: + $ref: "#/components/schemas/ContactId" + description: The identifier of the contact. You can delete PII only from a contact that has been disconnected (is in a terminated state). + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ContactFields: + $ref: "#/components/schemas/ContactFields" + required: + - ContactFields + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteContactDataResponse" /contact-evaluations/{instance_id}/{evaluation_id}: delete: operationId: DeleteContactEvaluation - description: Deletes a contact evaluation in the specified Amazon Connect instance. + description: Deletes a contact evaluation in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_id in: path required: true @@ -3517,14 +3772,14 @@ paths: description: Success get: operationId: DescribeContactEvaluation - description: Describes a contact evaluation in the specified Amazon Connect instance. + description: Describes a contact evaluation in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_id in: path required: true @@ -3540,14 +3795,14 @@ paths: $ref: "#/components/schemas/DescribeContactEvaluationResponse" post: operationId: UpdateContactEvaluation - description: Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier. + description: Updates details about a contact evaluation in the specified Connect Customer instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_id in: path required: true @@ -3577,14 +3832,14 @@ paths: /contact-flows/{instance_id}/{contact_flow_id}: delete: operationId: DeleteContactFlow - description: Deletes a flow for the specified Amazon Connect instance. + description: Deletes a flow for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_id in: path required: true @@ -3600,14 +3855,14 @@ paths: $ref: "#/components/schemas/DeleteContactFlowResponse" get: operationId: DescribeContactFlow - description: Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED + description: Describes the specified flow. You can also create and update flows using the Connect Customer Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: contact_flow_id in: path required: true @@ -3631,7 +3886,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3654,7 +3909,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3678,7 +3933,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3707,7 +3962,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3736,7 +3991,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3779,7 +4034,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -3809,7 +4064,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_id in: path required: true @@ -4027,14 +4282,14 @@ paths: /email-addresses/{instance_id}/{email_address_id}: delete: operationId: DeleteEmailAddress - description: Deletes email address from the specified Amazon Connect instance. + description: Deletes email address from the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: email_address_id in: path required: true @@ -4050,14 +4305,14 @@ paths: $ref: "#/components/schemas/DeleteEmailAddressResponse" get: operationId: DescribeEmailAddress - description: Describe email address form the specified Amazon Connect instance. + description: Describe email address form the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: email_address_id in: path required: true @@ -4073,14 +4328,14 @@ paths: $ref: "#/components/schemas/DescribeEmailAddressResponse" post: operationId: UpdateEmailAddressMetadata - description: Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide. + description: Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: email_address_id in: path required: true @@ -4110,14 +4365,14 @@ paths: /evaluation-forms/{instance_id}/{evaluation_form_id}: delete: operationId: DeleteEvaluationForm - description: Deletes an evaluation form in the specified Amazon Connect instance. If the version property is provided, only the specified version of the evaluation form is deleted. If no version is provided, then the full form (all versions) is deleted. + description: Deletes an evaluation form in the specified Connect Customer instance. If the version property is provided, only the specified version of the evaluation form is deleted. If no version is provided, then the full form (all versions) is deleted. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -4135,14 +4390,14 @@ paths: description: Success get: operationId: DescribeEvaluationForm - description: Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described. + description: Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -4164,14 +4419,14 @@ paths: $ref: "#/components/schemas/DescribeEvaluationFormResponse" put: operationId: UpdateEvaluationForm - description: Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content. + description: Updates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -4219,6 +4474,93 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateEvaluationFormResponse" + /extraction-definitions/{instance_id}/{extraction_definition_id}: + delete: + operationId: DeleteExtractionDefinition + description: Deletes an extraction definition from the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: extraction_definition_id + in: path + required: true + schema: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteExtractionDefinitionResponse" + get: + operationId: DescribeExtractionDefinition + description: Describes an extraction definition in the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: extraction_definition_id + in: path + required: true + schema: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeExtractionDefinitionResponse" + put: + operationId: UpdateExtractionDefinition + description: Updates an extraction definition in the specified Connect Customer instance. + parameters: + - name: extraction_definition_id + in: path + required: true + schema: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition to update. + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ClientToken: + $ref: "#/components/schemas/ClientToken" + Name: + $ref: "#/components/schemas/ExtractionDefinitionName" + ExtractionConfiguration: + $ref: "#/components/schemas/ExtractionConfiguration" + Display: + $ref: "#/components/schemas/ExtractionDefinitionDisplay" + required: + - ExtractionConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateExtractionDefinitionResponse" /hours-of-operations/{instance_id}/{hours_of_operation_id}: delete: operationId: DeleteHoursOfOperation @@ -4229,7 +4571,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: hours_of_operation_id in: path required: true @@ -4248,7 +4590,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: hours_of_operation_id in: path required: true @@ -4271,7 +4613,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: hours_of_operation_id in: path required: true @@ -4299,14 +4641,14 @@ paths: /hours-of-operations/{instance_id}/{hours_of_operation_id}/overrides/{hours_of_operation_override_id}: delete: operationId: DeleteHoursOfOperationOverride - description: Deletes an hours of operation override in an Amazon Connect hours of operation resource. + description: Deletes an hours of operation override in an Connect Customer hours of operation resource. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -4331,7 +4673,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -4360,7 +4702,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -4400,14 +4742,14 @@ paths: /instance/{instance_id}: delete: operationId: DeleteInstance - description: This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. + description: This API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: clientToken in: query required: false @@ -4419,14 +4761,14 @@ paths: description: Success get: operationId: DescribeInstance - description: This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked. + description: This API is in preview release for Connect Customer and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -4437,14 +4779,14 @@ paths: /instance/{instance_id}/integration-associations/{integration_association_id}: delete: operationId: DeleteIntegrationAssociation - description: Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it. + description: Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: integration_association_id in: path required: true @@ -4454,6 +4796,53 @@ paths: responses: "200": description: Success + /metrics/definitions/{instance_id}/{metric_id}: + delete: + operationId: DeleteMetric + description: Deletes an existing metric from the specified Connect Customer instance. This operation fails with ResourceConflictException if the metric is currently in use in a dashboard. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: metric_id + in: path + required: true + schema: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteMetricResponse" + get: + operationId: DescribeMetric + description: Retrieves the full definition of an existing metric from the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: metric_id + in: path + required: true + schema: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric to describe. Adding the $SAVED qualifier will describe the saved version of the metric. Adding $LATEST or omitting a qualifier will describe the published version. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeMetricResponse" /notifications/{instance_id}/{notification_id}: delete: operationId: DeleteNotification @@ -4538,14 +4927,14 @@ paths: /predefined-attributes/{instance_id}/{name}: delete: operationId: DeletePredefinedAttribute - description: Deletes a predefined attribute from the specified Amazon Connect instance. + description: Deletes a predefined attribute from the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: name in: path required: true @@ -4557,14 +4946,14 @@ paths: description: Success get: operationId: DescribePredefinedAttribute - description: "Describes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Amazon Connect quotas. Endpoints: See Amazon Connect endpoints and quotas." + description: "Describes a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Connect Customer quotas. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: name in: path required: true @@ -4580,14 +4969,14 @@ paths: $ref: "#/components/schemas/DescribePredefinedAttributeResponse" post: operationId: UpdatePredefinedAttribute - description: "Updates a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Amazon Connect quotas. Use cases Following are common uses cases for this API: Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes. Endpoints: See Amazon Connect endpoints and quotas." + description: "Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use cases Following are common uses cases for this API: Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: name in: path required: true @@ -4620,7 +5009,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: prompt_id in: path required: true @@ -4639,7 +5028,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: prompt_id in: path required: true @@ -4662,7 +5051,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: prompt_id in: path required: true @@ -4711,7 +5100,7 @@ paths: required: false schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact within the Amazon Connect instance. + description: The identifier of the contact within the Connect Customer instance. responses: "200": description: Success @@ -4729,7 +5118,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -4748,7 +5137,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -4765,14 +5154,14 @@ paths: /quick-connects/{instance_id}/{quick_connect_id}: delete: operationId: DeleteQuickConnect - description: "Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency." + description: "Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: quick_connect_id in: path required: true @@ -4791,7 +5180,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: quick_connect_id in: path required: true @@ -4815,7 +5204,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -4834,7 +5223,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -4851,14 +5240,14 @@ paths: /rules/{instance_id}/{rule_id}: delete: operationId: DeleteRule - description: Deletes a rule for the specified Amazon Connect instance. + description: Deletes a rule for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: rule_id in: path required: true @@ -4870,14 +5259,14 @@ paths: description: Success get: operationId: DescribeRule - description: Describes a rule for the specified Amazon Connect instance. + description: Describes a rule for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: rule_id in: path required: true @@ -4893,7 +5282,7 @@ paths: $ref: "#/components/schemas/DescribeRuleResponse" put: operationId: UpdateRule - description: Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. + description: Updates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule. parameters: - name: rule_id in: path @@ -4906,7 +5295,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -4939,7 +5328,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: security_profile_id in: path required: true @@ -4951,7 +5340,7 @@ paths: description: Success get: operationId: DescribeSecurityProfile - description: Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: - name: security_profile_id in: path @@ -4964,7 +5353,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -4974,7 +5363,7 @@ paths: $ref: "#/components/schemas/DescribeSecurityProfileResponse" post: operationId: UpdateSecurityProfile - description: Updates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Updates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: - name: security_profile_id in: path @@ -4987,7 +5376,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -5016,6 +5405,30 @@ paths: responses: "200": description: Success + /auth/sessions/{instance_id}/{session_id}: + delete: + operationId: DeleteSession + description: Deletes a session for the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: session_id + in: path + required: true + schema: + $ref: "#/components/schemas/SessionId" + description: The identifier of the session to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSessionResponse" /instance/{instance_id}/task/template/{task_template_id}: delete: operationId: DeleteTaskTemplate @@ -5026,7 +5439,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: task_template_id in: path required: true @@ -5042,14 +5455,14 @@ paths: $ref: "#/components/schemas/DeleteTaskTemplateResponse" get: operationId: GetTaskTemplate - description: Gets details about a specific task template in the specified Amazon Connect instance. + description: Gets details about a specific task template in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: task_template_id in: path required: true @@ -5071,7 +5484,7 @@ paths: $ref: "#/components/schemas/GetTaskTemplateResponse" post: operationId: UpdateTaskTemplate - description: Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content. + description: Updates details about a specific task template in the specified Connect Customer instance. This operation does not support partial updates. Instead it does a full update of template content. parameters: - name: task_template_id in: path @@ -5084,7 +5497,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -5225,7 +5638,7 @@ paths: /traffic-distribution-group/{traffic_distribution_group_id}: delete: operationId: DeleteTrafficDistributionGroup - description: Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide. + description: Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Connect Customer Administrator Guide. parameters: - name: traffic_distribution_group_id in: path @@ -5267,7 +5680,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: integration_association_id in: path required: true @@ -5286,14 +5699,14 @@ paths: /users/{instance_id}/{user_id}: delete: operationId: DeleteUser - description: "Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide. After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency." + description: "Deletes a user account from the specified Connect Customer instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Connect Customer Instance in the Connect Customer Administrator Guide. After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: user_id in: path required: true @@ -5305,7 +5718,7 @@ paths: description: Success get: operationId: DescribeUser - description: Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output. + description: Describes the specified user. You can find the instance ID in the Connect Customer console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output. parameters: - name: user_id in: path @@ -5318,7 +5731,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -5342,7 +5755,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -5361,7 +5774,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -5379,7 +5792,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -5395,14 +5808,14 @@ paths: $ref: "#/components/schemas/DeleteViewResponse" get: operationId: DescribeView - description: Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, ``:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views. + description: Retrieves the view for the specified Connect Customer instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, ``:$SAVED, which is either an actual version number or an Connect Customer managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -5418,14 +5831,14 @@ paths: $ref: "#/components/schemas/DescribeViewResponse" post: operationId: UpdateViewContent - description: Updates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED. + description: Updates the view content of the given view identifier in the specified Connect Customer instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -5460,7 +5873,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -5490,7 +5903,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: vocabulary_id in: path required: true @@ -5725,7 +6138,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: agent_status_id in: path required: true @@ -5748,7 +6161,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: agent_status_id in: path required: true @@ -5778,14 +6191,14 @@ paths: /attached-files-configurations/{instance_id}/{attachment_scope}: get: operationId: DescribeAttachedFilesConfiguration - description: Describes the attached files configuration for the specified Amazon Connect instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned. + description: Describes the attached files configuration for the specified Connect Customer instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: attachment_scope in: path required: true @@ -5801,14 +6214,14 @@ paths: $ref: "#/components/schemas/DescribeAttachedFilesConfigurationResponse" post: operationId: UpdateAttachedFilesConfiguration - description: Updates the attached files configuration for the specified Amazon Connect instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values. + description: Updates the attached files configuration for the specified Connect Customer instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: attachment_scope in: path required: true @@ -5836,7 +6249,7 @@ paths: /authentication-profiles/{instance_id}/{authentication_profile_id}: get: operationId: DescribeAuthenticationProfile - description: This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile. + description: This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile. parameters: - name: authentication_profile_id in: path @@ -5849,7 +6262,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -5859,7 +6272,7 @@ paths: $ref: "#/components/schemas/DescribeAuthenticationProfileResponse" post: operationId: UpdateAuthenticationProfile - description: This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile. + description: This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile. parameters: - name: authentication_profile_id in: path @@ -5872,7 +6285,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -5900,14 +6313,14 @@ paths: /contacts/{instance_id}/{contact_id}: get: operationId: DescribeContact - description: "This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API. Endpoints: See Amazon Connect endpoints and quotas." + description: "This API is in preview release for Connect Customer and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK Contact information remains available in Connect Customer for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Connect Customer is returned by this API. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true @@ -5923,14 +6336,14 @@ paths: $ref: "#/components/schemas/DescribeContactResponse" post: operationId: UpdateContact - description: This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts. + description: This API is in preview release for Connect Customer and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true @@ -5970,14 +6383,14 @@ paths: /instance/{instance_id}/attribute/{attribute_type}: get: operationId: DescribeInstanceAttribute - description: This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute. + description: This API is in preview release for Connect Customer and is subject to change. Describes the specified instance attribute. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: attribute_type in: path required: true @@ -5993,14 +6406,14 @@ paths: $ref: "#/components/schemas/DescribeInstanceAttributeResponse" post: operationId: UpdateInstanceAttribute - description: This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type. + description: This API is in preview release for Connect Customer and is subject to change. Updates the value for the specified attribute type. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: attribute_type in: path required: true @@ -6024,14 +6437,14 @@ paths: /instance/{instance_id}/storage-config/{association_id}: get: operationId: DescribeInstanceStorageConfig - description: This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. + description: This API is in preview release for Connect Customer and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: association_id in: path required: true @@ -6053,14 +6466,14 @@ paths: $ref: "#/components/schemas/DescribeInstanceStorageConfigResponse" delete: operationId: DisassociateInstanceStorageConfig - description: This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID. + description: This API is in preview release for Connect Customer and is subject to change. Removes the storage type configurations for the specified resource type and association ID. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: association_id in: path required: true @@ -6084,14 +6497,14 @@ paths: description: Success post: operationId: UpdateInstanceStorageConfig - description: This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent. + description: This API is in preview release for Connect Customer and is subject to change. Updates an existing configuration for a resource type. This API is idempotent. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: association_id in: path required: true @@ -6123,7 +6536,7 @@ paths: /phone-number/{phone_number_id}: get: operationId: DescribePhoneNumber - description: Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException. + description: Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException. parameters: - name: phone_number_id in: path @@ -6140,7 +6553,7 @@ paths: $ref: "#/components/schemas/DescribePhoneNumberResponse" delete: operationId: ReleasePhoneNumber - description: Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. + description: Releases a phone number previously claimed to an Connect Customer instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Connect Customer admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. parameters: - name: phone_number_id in: path @@ -6159,7 +6572,7 @@ paths: description: Success put: operationId: UpdatePhoneNumber - description: Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation. + description: Updates your claimed phone number from its current Connect Customer instance or traffic distribution group to another Connect Customer instance or traffic distribution group in the same Amazon Web Services Region. After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation. parameters: - name: phone_number_id in: path @@ -6190,14 +6603,14 @@ paths: /user-hierarchy-structure/{instance_id}: get: operationId: DescribeUserHierarchyStructure - description: Describes the hierarchy structure of the specified Amazon Connect instance. + description: Describes the hierarchy structure of the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -6214,7 +6627,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -6239,7 +6652,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: vocabulary_id in: path required: true @@ -6256,7 +6669,7 @@ paths: /email-addresses/{instance_id}/{email_address_id}/disassociate-alias: post: operationId: DisassociateEmailAddressAlias - description: "Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Amazon Connect endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships)." + description: "Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Connect Customer endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships)." parameters: - name: email_address_id in: path @@ -6269,7 +6682,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -6300,7 +6713,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: resource_id in: path required: true @@ -6329,7 +6742,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: resource_id in: path required: true @@ -6352,7 +6765,7 @@ paths: /hours-of-operations/{instance_id}/{hours_of_operation_id}/disassociate-hours: post: operationId: DisassociateHoursOfOperations - description: Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s). + description: Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide. parameters: - name: instance_id in: path @@ -6390,7 +6803,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -6423,7 +6836,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -6454,7 +6867,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -6478,14 +6891,14 @@ paths: /instance/{instance_id}/security-key/{association_id}: delete: operationId: DisassociateSecurityKey - description: This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key. + description: This API is in preview release for Connect Customer and is subject to change. Deletes the specified security key. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: association_id in: path required: true @@ -6542,7 +6955,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: user_id in: path required: true @@ -6614,7 +7027,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. requestBody: required: true content: @@ -6690,7 +7103,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: initial_contact_id in: path required: true @@ -6707,7 +7120,7 @@ paths: /metrics/contact: post: operationId: GetContactMetrics - description: "Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas." + description: "Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Connect Customer Administrator Guide. Endpoints: See Connect Customer endpoints and quotas." parameters: [] requestBody: required: true @@ -6736,14 +7149,14 @@ paths: /metrics/current/{instance_id}: post: operationId: GetCurrentMetricData - description: "Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Add filters to reduce the amount of data returned" + description: "Gets the real-time metric data from the specified Connect Customer instance. For a description of each metric, see Metrics definitions in the Connect Customer Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Add filters to reduce the amount of data returned" parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -6776,14 +7189,14 @@ paths: /metrics/userdata/{instance_id}: post: operationId: GetCurrentUserData - description: Gets the real-time active user data from the specified Amazon Connect instance. + description: Gets the real-time active user data from the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -6816,7 +7229,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: hours_of_operation_id in: path required: true @@ -6842,17 +7255,47 @@ paths: application/json: schema: $ref: "#/components/schemas/GetEffectiveHoursOfOperationsResponse" + /evaluation-forms/{instance_id}/{evaluation_form_id}/validation-results: + get: + operationId: GetEvaluationFormValidation + description: Retrieves the status and results of a validation process started by StartEvaluationFormValidation. Returns the current execution status (IN_PROGRESS, COMPLETED, or FAILED), the validated form version, and when completed, a list of findings that identify structural issues and quality improvements for the evaluation form, and may include suggested fixes. If the validation failed, a reason is provided indicating the cause of the failure. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: evaluation_form_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for the evaluation form. + - name: version + in: query + required: false + schema: + $ref: "#/components/schemas/VersionNumber" + description: The version of the evaluation form to retrieve validation results for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEvaluationFormValidationResponse" /user/federate/{instance_id}: get: operationId: GetFederationToken - description: "Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect" + description: "Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Connect Customer" parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -6863,14 +7306,14 @@ paths: /metrics/historical/{instance_id}: post: operationId: GetMetricData - description: Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week. + description: Gets historical metric data from the specified Connect Customer instance. For a description of each historical metric, see Metrics definitions in the Connect Customer Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -6907,7 +7350,7 @@ paths: /metrics/data: post: operationId: GetMetricDataV2 - description: "Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Narrow the time range of your request Add filters to reduce the amount of data returned" + description: "Gets metric data from the specified Connect Customer instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Connect Customer Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Narrow the time range of your request Add filters to reduce the amount of data returned" parameters: [] requestBody: required: true @@ -6957,7 +7400,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: prompt_id in: path required: true @@ -7021,7 +7464,7 @@ paths: $ref: "#/components/schemas/GetTrafficDistributionResponse" put: operationId: UpdateTrafficDistribution - description: Updates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic. + description: Updates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Connect Customer Administrator Guide. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic. parameters: - name: id in: path @@ -7052,7 +7495,7 @@ paths: /phone-number/import: post: operationId: ImportPhoneNumber - description: Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket. + description: Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket. parameters: [] requestBody: required: true @@ -7084,14 +7527,14 @@ paths: /analytics-data/instance/{instance_id}/datasets: get: operationId: ListAnalyticsDataLakeDataSets - description: Lists the data lake datasets available to associate with for a given Amazon Connect instance. + description: Lists the data lake datasets available to associate with for a given Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7114,14 +7557,14 @@ paths: /instance/{instance_id}/approved-origins: get: operationId: ListApprovedOrigins - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all approved origins associated with the instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7151,13 +7594,13 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contactId in: query required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. - name: maxResults in: query required: false @@ -7180,14 +7623,14 @@ paths: /attached-files-configurations/{instance_id}: get: operationId: ListAttachedFilesConfigurations - description: Provides summary information about the attached files configurations for the specified Amazon Connect instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned. + description: Provides summary information about the attached files configurations for the specified Connect Customer instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: maxResults in: query required: false @@ -7210,14 +7653,14 @@ paths: /authentication-profiles-summary/{instance_id}: get: operationId: ListAuthenticationProfiles - description: This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance. + description: This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: maxResults in: query required: false @@ -7240,14 +7683,14 @@ paths: /instance/{instance_id}/bots: get: operationId: ListBots - description: This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots. + description: This API is in preview release for Connect Customer and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7312,20 +7755,20 @@ paths: /contact-evaluations/{instance_id}: get: operationId: ListContactEvaluations - description: Lists contact evaluations in the specified Amazon Connect instance. + description: Lists contact evaluations in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contactId in: query required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. - name: nextToken in: query required: false @@ -7341,14 +7784,14 @@ paths: $ref: "#/components/schemas/ListContactEvaluationsResponse" put: operationId: StartContactEvaluation - description: Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Evaluations created through the public API do not contain answer values suggested from automation. + description: Starts an empty evaluation in the specified Connect Customer instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Evaluations created through the public API do not contain answer values suggested from automation. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -7386,7 +7829,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -7422,7 +7865,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -7451,14 +7894,14 @@ paths: /contact-flow-modules-summary/{instance_id}: get: operationId: ListContactFlowModules - description: Provides information about the flow modules for the specified Amazon Connect instance. + description: Provides information about the flow modules for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7487,14 +7930,14 @@ paths: /contact-flows/{instance_id}/{contact_flow_id}/versions: get: operationId: ListContactFlowVersions - description: Returns all the available versions for the specified Amazon Connect instance and flow identifier. + description: Returns all the available versions for the specified Connect Customer instance and flow identifier. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: contact_flow_id in: path required: true @@ -7523,14 +7966,14 @@ paths: /contact-flows-summary/{instance_id}: get: operationId: ListContactFlows - description: Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide. + description: Provides information about the flows for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow language. For more information about flows, see Flows in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contactFlowTypes in: query required: false @@ -7559,14 +8002,14 @@ paths: /contact/references/{instance_id}/{contact_id}: get: operationId: ListContactReferences - description: This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs. + description: This API is in preview release for Connect Customer and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true @@ -7689,14 +8132,14 @@ paths: /default-vocabulary-summary/{instance_id}: post: operationId: ListDefaultVocabularies - description: Lists the default vocabularies for the specified Amazon Connect instance. + description: Lists the default vocabularies for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -7756,14 +8199,14 @@ paths: /evaluation-forms/{instance_id}/{evaluation_form_id}/versions: get: operationId: ListEvaluationFormVersions - description: Lists versions of an evaluation form in the specified Amazon Connect instance. + description: Lists versions of an evaluation form in the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_form_id in: path required: true @@ -7799,7 +8242,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: ResourceType in: query required: false @@ -7828,14 +8271,14 @@ paths: /hours-of-operations-summary/{instance_id}: get: operationId: ListHoursOfOperations - description: Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide. + description: Provides information about the hours of operation for the specified Connect Customer instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7858,14 +8301,14 @@ paths: /instance/{instance_id}/attributes: get: operationId: ListInstanceAttributes - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all attribute types for the given instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7888,14 +8331,14 @@ paths: /instance/{instance_id}/storage-configs: get: operationId: ListInstanceStorageConfigs - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: resourceType in: query required: false @@ -7924,14 +8367,14 @@ paths: /instance/{instance_id}/lambda-functions: get: operationId: ListLambdaFunctions - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7954,14 +8397,14 @@ paths: /instance/{instance_id}/lex-bots: get: operationId: ListLexBots - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -7984,14 +8427,14 @@ paths: /phone-numbers-summary/{instance_id}: get: operationId: ListPhoneNumbers - description: Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID. The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources. + description: Provides information about the phone numbers for the specified Connect Customer instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer Administrator Guide. We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID. The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: phoneNumberTypes in: query required: false @@ -8026,7 +8469,7 @@ paths: /phone-number/list: post: operationId: ListPhoneNumbersV2 - description: Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance. When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group. + description: Lists phone numbers claimed to your Connect Customer instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer Administrator Guide. When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance. When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group. parameters: [] requestBody: required: false @@ -8059,14 +8502,14 @@ paths: /prompts-summary/{instance_id}: get: operationId: ListPrompts - description: Provides information about the prompts for the specified Amazon Connect instance. + description: Provides information about the prompts for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: nextToken in: query required: false @@ -8096,7 +8539,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -8132,7 +8575,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -8161,14 +8604,14 @@ paths: /queues-summary/{instance_id}: get: operationId: ListQueues - description: "Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide." + description: "Provides information about the queues for the specified Connect Customer instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Connect Customer Administrator Guide." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queueTypes in: query required: false @@ -8204,13 +8647,13 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. requestBody: required: true content: @@ -8239,14 +8682,14 @@ paths: /routing-profiles/{instance_id}/{routing_profile_id}/manual-assignment-queues: get: operationId: ListRoutingProfileManualAssignmentQueues - description: "Lists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown). For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide. Important things to know This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile. Endpoints: See Amazon Connect endpoints and quotas." + description: "Lists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown). For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Connect Customer agent workspace in the Connect Customer Administrator Guide. Important things to know This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile. Endpoints: See Connect Customer endpoints and quotas." parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -8282,7 +8725,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -8317,7 +8760,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -8341,14 +8784,14 @@ paths: /routing-profiles-summary/{instance_id}: get: operationId: ListRoutingProfiles - description: Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide. + description: Provides summary information about the routing profiles for the specified Connect Customer instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8371,14 +8814,14 @@ paths: /instance/{instance_id}/security-keys: get: operationId: ListSecurityKeys - description: This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance. + description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all security keys associated with the instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8414,7 +8857,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8450,7 +8893,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8473,7 +8916,7 @@ paths: /security-profiles-permissions/{instance_id}/{security_profile_id}: get: operationId: ListSecurityProfilePermissions - description: Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: - name: security_profile_id in: path @@ -8486,7 +8929,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8509,14 +8952,14 @@ paths: /security-profiles-summary/{instance_id}: get: operationId: ListSecurityProfiles - description: Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Provides summary information about the security profiles for the specified Connect Customer instance. For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8539,14 +8982,14 @@ paths: /tags/{resource_arn}: get: operationId: ListTagsForResource - description: Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. + description: Lists the tags for the specified resource. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide. parameters: - name: resource_arn in: path required: true schema: $ref: "#/components/schemas/ARN" - description: The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN. + description: The Amazon Resource Name (ARN) of the resource. All Connect Customer resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Connect Customer instance ID/ARN. responses: "200": description: Success @@ -8556,7 +8999,7 @@ paths: $ref: "#/components/schemas/ListTagsForResourceResponse" post: operationId: TagResource - description: Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. + description: Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide. parameters: - name: resource_arn in: path @@ -8757,7 +9200,7 @@ paths: required: false schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. responses: "200": description: Success @@ -8768,14 +9211,14 @@ paths: /user-hierarchy-groups-summary/{instance_id}: get: operationId: ListUserHierarchyGroups - description: Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide. + description: Provides summary information about the hierarchy groups for the specified Connect Customer instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8841,7 +9284,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: user_id in: path required: true @@ -8876,7 +9319,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: user_id in: path required: true @@ -8900,14 +9343,14 @@ paths: /users-summary/{instance_id}: get: operationId: ListUsers - description: Provides summary information about the users for the specified Amazon Connect instance. + description: Provides summary information about the users for the specified Connect Customer instance. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: nextToken in: query required: false @@ -8991,7 +9434,7 @@ paths: /users/{instance_id}/{user_id}/status: put: operationId: PutUserStatus - description: Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide. + description: Changes the current status of a user or agent in Connect Customer. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Connect Customer Administrator Guide. parameters: - name: user_id in: path @@ -9004,7 +9447,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -9026,14 +9469,14 @@ paths: /instance/{instance_id}/replicate: post: operationId: ReplicateInstance - description: Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide. + description: Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions. For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceIdOrArn" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN. requestBody: required: true content: @@ -9119,7 +9562,7 @@ paths: /search-agent-statuses: post: operationId: SearchAgentStatuses - description: Searches AgentStatuses in an Amazon Connect instance, with optional filtering. + description: Searches AgentStatuses in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9150,7 +9593,7 @@ paths: /phone-number/search-available: post: operationId: SearchAvailablePhoneNumbers - description: Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group. + description: Searches for available phone numbers that you can claim to your Connect Customer instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group. parameters: [] requestBody: required: true @@ -9186,7 +9629,7 @@ paths: /search-contact-evaluations: post: operationId: SearchContactEvaluations - description: "Searches contact evaluations in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas." + description: "Searches contact evaluations in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Connect Customer endpoints and quotas." parameters: [] requestBody: required: true @@ -9217,7 +9660,7 @@ paths: /search-contact-flow-modules: post: operationId: SearchContactFlowModules - description: Searches the flow modules in an Amazon Connect instance, with optional filtering. + description: Searches the flow modules in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9248,7 +9691,7 @@ paths: /search-contact-flows: post: operationId: SearchContactFlows - description: Searches the flows in an Amazon Connect instance, with optional filtering. + description: Searches the flows in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9279,7 +9722,7 @@ paths: /search-contacts: post: operationId: SearchContacts - description: Searches contacts in an Amazon Connect instance. + description: Searches contacts in an Connect Customer instance. parameters: [] requestBody: required: true @@ -9375,7 +9818,7 @@ paths: /search-evaluation-forms: post: operationId: SearchEvaluationForms - description: "Searches evaluation forms in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Amazon Connect endpoints and quotas." + description: "Searches evaluation forms in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Connect Customer endpoints and quotas." parameters: [] requestBody: required: true @@ -9437,7 +9880,7 @@ paths: /search-hours-of-operations: post: operationId: SearchHoursOfOperations - description: Searches the hours of operation in an Amazon Connect instance, with optional filtering. + description: Searches the hours of operation in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9465,10 +9908,10 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchHoursOfOperationsResponse" - /search-notifications: + /search-metrics: post: - operationId: SearchNotifications - description: Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags. + operationId: SearchMetrics + description: Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully. parameters: [] requestBody: required: true @@ -9484,9 +9927,40 @@ paths: MaxResults: $ref: "#/components/schemas/MaxResult100" SearchFilter: - $ref: "#/components/schemas/NotificationSearchFilter" + $ref: "#/components/schemas/MetricSearchFilter" SearchCriteria: - $ref: "#/components/schemas/NotificationSearchCriteria" + $ref: "#/components/schemas/MetricSearchCriteria" + required: + - InstanceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchMetricsResponse" + /search-notifications: + post: + operationId: SearchNotifications + description: Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstanceId: + $ref: "#/components/schemas/InstanceId" + NextToken: + $ref: "#/components/schemas/NextToken" + MaxResults: + $ref: "#/components/schemas/MaxResult100" + SearchFilter: + $ref: "#/components/schemas/NotificationSearchFilter" + SearchCriteria: + $ref: "#/components/schemas/NotificationSearchCriteria" required: - InstanceId responses: @@ -9499,7 +9973,7 @@ paths: /search-predefined-attributes: post: operationId: SearchPredefinedAttributes - description: "Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Amazon Connect quotas. Endpoints: See Amazon Connect endpoints and quotas." + description: "Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Connect Customer quotas. Endpoints: See Connect Customer endpoints and quotas." parameters: [] requestBody: required: true @@ -9528,7 +10002,7 @@ paths: /search-prompts: post: operationId: SearchPrompts - description: Searches prompts in an Amazon Connect instance, with optional filtering. + description: Searches prompts in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9559,7 +10033,7 @@ paths: /search-queues: post: operationId: SearchQueues - description: Searches queues in an Amazon Connect instance, with optional filtering. + description: Searches queues in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9590,7 +10064,7 @@ paths: /search-quick-connects: post: operationId: SearchQuickConnects - description: Searches quick connects in an Amazon Connect instance, with optional filtering. + description: Searches quick connects in an Connect Customer instance, with optional filtering. parameters: [] requestBody: required: true @@ -9621,7 +10095,7 @@ paths: /search-resource-tags: post: operationId: SearchResourceTags - description: Searches tags used in an Amazon Connect instance using optional search criteria. + description: Searches tags used in an Connect Customer instance using optional search criteria. parameters: [] requestBody: required: true @@ -9652,7 +10126,7 @@ paths: /search-routing-profiles: post: operationId: SearchRoutingProfiles - description: Searches routing profiles in an Amazon Connect instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does. + description: Searches routing profiles in an Connect Customer instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does. parameters: [] requestBody: required: true @@ -9680,10 +10154,41 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchRoutingProfilesResponse" + /search-rules: + post: + operationId: SearchRules + description: Searches rules in an Connect Customer instance, with optional filtering. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstanceId: + $ref: "#/components/schemas/InstanceId" + MaxResults: + $ref: "#/components/schemas/MaxResult200" + NextToken: + $ref: "#/components/schemas/NextToken2500" + SearchCriteria: + $ref: "#/components/schemas/RulesSearchCriteria" + SearchFilter: + $ref: "#/components/schemas/RulesSearchFilter" + required: + - InstanceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchRulesResponse" /search-security-profiles: post: operationId: SearchSecurityProfiles - description: Searches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. + description: Searches security profiles in an Connect Customer instance, with optional filtering. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. parameters: [] requestBody: required: true @@ -9745,7 +10250,7 @@ paths: /search-user-hierarchy-groups: post: operationId: SearchUserHierarchyGroups - description: 'Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.' + description: 'Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.' parameters: [] requestBody: required: true @@ -9776,7 +10281,7 @@ paths: /search-users: post: operationId: SearchUsers - description: Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds. + description: Searches users in an Connect Customer instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds. parameters: [] requestBody: required: true @@ -9838,14 +10343,14 @@ paths: /vocabulary-summary/{instance_id}: post: operationId: SearchVocabularies - description: Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode. + description: Searches for vocabularies within a specific Connect Customer instance using State, NameStartsWith, and LanguageCode. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -9935,7 +10440,7 @@ paths: /chat-integration-event: post: operationId: SendChatIntegrationEvent - description: "Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes: SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration." + description: "Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. A chat integration event includes: SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration." parameters: [] requestBody: required: true @@ -9968,14 +10473,14 @@ paths: /instance/{instance_id}/outbound-email: put: operationId: SendOutboundEmail - description: Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns. Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. + description: Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -10009,10 +10514,95 @@ paths: application/json: schema: $ref: "#/components/schemas/SendOutboundEmailResponse" + /instance/{instance_id}/outbound-web-notification: + post: + operationId: SendOutboundWebNotification + description: Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ClientToken: + $ref: "#/components/schemas/ClientToken" + BrowserId: + $ref: "#/components/schemas/WebBrowserId" + SessionId: + $ref: "#/components/schemas/WebSessionId" + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + Source: + $ref: "#/components/schemas/WebNotificationSource" + Destination: + $ref: "#/components/schemas/WidgetDestination" + Content: + $ref: "#/components/schemas/WebNotificationContent" + required: + - BrowserId + - SessionId + - ExpiresAt + - Source + - Destination + - Content + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SendOutboundWebNotificationResponse" + /contact/assistant: + put: + operationId: StartAssistantContact + description: "Starts a chat contact with an AI agent. Use the returned ParticipantToken with the CreateParticipantConnection operation. For more information about chat, see the following topics in the Connect Customer Administrator Guide: Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices" + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstanceId: + $ref: "#/components/schemas/InstanceId" + AiAgent: + $ref: "#/components/schemas/AiAgentInput" + ParticipantDetails: + $ref: "#/components/schemas/ParticipantDetails" + InitialMessage: + $ref: "#/components/schemas/ChatMessage" + Attributes: + $ref: "#/components/schemas/Attributes" + ClientToken: + $ref: "#/components/schemas/ClientToken" + PersistentChat: + $ref: "#/components/schemas/PersistentChat" + RelatedContactId: + $ref: "#/components/schemas/ContactId" + required: + - InstanceId + - AiAgent + - ParticipantDetails + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartAssistantContactResponse" /contact/chat: put: operationId: StartChatContact - description: "Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices" + description: "Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Connect Customer Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see the following topics in the Connect Customer Administrator Guide: Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices" parameters: [] requestBody: required: true @@ -10060,6 +10650,46 @@ paths: application/json: schema: $ref: "#/components/schemas/StartChatContactResponse" + /contact/start-conversational-analytics-job/{instance_id}/{contact_id}: + post: + operationId: StartContactConversationalAnalyticsJob + description: Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration. A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI. For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: contact_id + in: path + required: true + schema: + $ref: "#/components/schemas/ContactId" + description: The identifier of the contact in this instance of Connect Customer. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + AnalyticsModes: + $ref: "#/components/schemas/AnalyticsModes" + AnalyticsConfiguration: + $ref: "#/components/schemas/AnalyticsConfiguration" + ClientToken: + $ref: "#/components/schemas/ClientToken" + required: + - AnalyticsModes + - AnalyticsConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartContactConversationalAnalyticsJobResponse" /contact/start-contact-media-processing: post: operationId: StartContactMediaProcessing @@ -10122,7 +10752,7 @@ paths: /contact/start-streaming: post: operationId: StartContactStreaming - description: "Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices" + description: "Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Connect Customer Administrator Guide. For more information about chat, see the following topics in the Connect Customer Administrator Guide: Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices" parameters: [] requestBody: required: true @@ -10203,10 +10833,45 @@ paths: application/json: schema: $ref: "#/components/schemas/StartEmailContactResponse" + /evaluation-forms/{instance_id}/{evaluation_form_id}/validate: + post: + operationId: StartEvaluationFormValidation + description: Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: evaluation_form_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for the evaluation form. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + EvaluationFormVersion: + $ref: "#/components/schemas/VersionNumber" + required: + - EvaluationFormVersion + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartEvaluationFormValidationResponse" /contact/outbound-chat: put: operationId: StartOutboundChatContact - description: "Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created. SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action. For more information about using SMS or WhatsApp in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide: Set up SMS messaging Request an SMS-enabled phone number through Amazon Web Services End User Messaging SMS Set up WhatsApp Business messaging" + description: "Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created. SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action. For more information about using SMS or WhatsApp in Connect Customer, see the following topics in the Connect Customer Administrator Guide: Set up SMS messaging Request an SMS-enabled phone number through Amazon Web Services End User Messaging SMS Set up WhatsApp Business messaging" parameters: [] requestBody: required: true @@ -10295,7 +10960,7 @@ paths: /contact/outbound-voice: put: operationId: StartOutboundVoiceContact - description: Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide. Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns. For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy. + description: Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Connect Customer Service Quotas in the Connect Customer Administrator Guide. Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Connect Customer campaigns. For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy. parameters: [] requestBody: required: true @@ -10350,7 +11015,7 @@ paths: /contact/screen-sharing: put: operationId: StartScreenSharing - description: Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide. + description: Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide. parameters: [] requestBody: required: true @@ -10378,7 +11043,7 @@ paths: /contact/task: put: operationId: StartTaskContact - description: "Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following: PreviousContactId Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId. RelatedContactId Copies contact attributes from the related task contact to the new contact. Any update on attributes in a new task contact does not update attributes on previous contact. There’s no limit on the number of task contacts that can be created that use the same RelatedContactId. In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide." + description: "Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following: PreviousContactId Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId. RelatedContactId Copies contact attributes from the related task contact to the new contact. Any update on attributes in a new task contact does not update attributes on previous contact. There’s no limit on the number of task contacts that can be created that use the same RelatedContactId. In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Connect Customer cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Connect Customer service quotas in the Connect Customer Administrator Guide." parameters: [] requestBody: required: true @@ -10461,7 +11126,7 @@ paths: /contact/webrtc: put: operationId: StartWebRTCContact - description: Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId). + description: Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Connect Customer instance (specified as InstanceId). parameters: [] requestBody: required: true @@ -10488,6 +11153,8 @@ paths: $ref: "#/components/schemas/ContactReferences" Description: $ref: "#/components/schemas/Description" + SegmentAttributes: + $ref: "#/components/schemas/SegmentAttributes" required: - ContactFlowId - InstanceId @@ -10652,14 +11319,14 @@ paths: /contact-evaluations/{instance_id}/{evaluation_id}/submit: post: operationId: SubmitContactEvaluation - description: Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission. + description: Submits a contact evaluation in the specified Connect Customer instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: evaluation_id in: path required: true @@ -10720,7 +11387,7 @@ paths: /contact/tags: post: operationId: TagContact - description: Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. + description: Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage. parameters: [] requestBody: required: true @@ -10783,20 +11450,20 @@ paths: /contact/tags/{instance_id}/{contact_id}: delete: operationId: UntagContact - description: Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. + description: Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage. parameters: - name: contact_id in: path required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: TagKeys in: query required: true @@ -10813,7 +11480,7 @@ paths: /contact/attributes: post: operationId: UpdateContactAttributes - description: Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide. + description: Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Connect Customer. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Connect Customer for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Connect Customer Administrator Guide. parameters: [] requestBody: required: true @@ -10841,14 +11508,14 @@ paths: /contact-flows/{instance_id}/{contact_flow_id}/content: post: operationId: UpdateContactFlowContent - description: Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. + description: Updates the specified flow. You can also create and update flows using the Connect Customer Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: contact_flow_id in: path required: true @@ -10881,7 +11548,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_id in: path required: true @@ -10911,14 +11578,14 @@ paths: /contact-flow-modules/{instance_id}/{contact_flow_module_id}/content: post: operationId: UpdateContactFlowModuleContent - description: Updates specified flow module for the specified Amazon Connect instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. + description: Updates specified flow module for the specified Connect Customer instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -10953,7 +11620,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_flow_module_id in: path required: true @@ -10983,14 +11650,14 @@ paths: /contact-flows/{instance_id}/{contact_flow_id}/name: post: operationId: UpdateContactFlowName - description: The name of the flow. You can also create and update flows using the Amazon Connect Flow language. + description: The name of the flow. You can also create and update flows using the Connect Customer Flow language. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. - name: contact_flow_id in: path required: true @@ -11025,13 +11692,13 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. requestBody: required: false content: @@ -11081,6 +11748,35 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateContactScheduleResponse" + /contact/task-template: + post: + operationId: UpdateContactTaskTemplate + description: "Updates the task template association on an existing task contact. You can update the task template on a contact before assignment to support tasks that are created without a template (for example Rules or disconnect flows) or change the agent interaction form to represent the latest task data (for example an initial request that was submitted as a refund gets updated to an account cancellation and requires a new template). This operation can only be used with task contacts that are in progress and not connected to an agent. A task template can be updated a maximum of 5 times per contact. The task's references must be compatible with the fields of the target task template. If the target template has a required field, the task must have a corresponding reference with a matching name and compatible type. The following task template field types map to reference types: TEXT, TEXT_AREA, BOOLEAN, and SINGLE_SELECT map to references of type STRING. NUMBER maps to references of type NUMBER. DATE_TIME maps to references of type DATE. URL maps to references of type URL. EMAIL maps to references of type EMAIL. References corresponding to TEXT fields must be fewer than 512 characters. TEXT_AREA fields must be fewer than 4,096 characters. BOOLEAN fields must have a value of true or false. An InvalidRequestException occurs when UpdateContactTaskTemplate is called on a connected or terminated task, when it is called on non-task contacts, and when the task contact already uses the provided task template. A PropertyValidationException occurs when the task's references conflict with the task template's fields, for example if the task is missing a reference that matches a required field, or if the task has a reference that matches a required field's name but not its datatype." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + InstanceId: + $ref: "#/components/schemas/InstanceId" + TaskTemplateId: + $ref: "#/components/schemas/TaskTemplateId" + ContactId: + $ref: "#/components/schemas/ContactId" + required: + - InstanceId + - TaskTemplateId + - ContactId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateContactTaskTemplateResponse" /data-tables/{instance_id}/{data_table_id}/values/update-primary: post: operationId: UpdateDataTablePrimaryValues @@ -11122,10 +11818,82 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateDataTablePrimaryValuesResponse" + /metrics/definitions/{instance_id}/{metric_id}/content: + post: + operationId: UpdateMetricContent + description: Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: metric_id + in: path + required: true + schema: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + MetricCalculation: + $ref: "#/components/schemas/MetricCalculation" + Unit: + $ref: "#/components/schemas/MetricUnit" + PositiveTrendIndicator: + $ref: "#/components/schemas/TrendIndicator" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateMetricContentResponse" + /metrics/definitions/{instance_id}/{metric_id}/metadata: + post: + operationId: UpdateMetricMetadata + description: Updates the name and/or description of an existing metric in the specified Connect Customer instance. + parameters: + - name: instance_id + in: path + required: true + schema: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + - name: metric_id + in: path + required: true + schema: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/MetricName" + Description: + $ref: "#/components/schemas/MetricDescription" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateMetricMetadataResponse" /contact/update-participant-authentication: post: operationId: UpdateParticipantAuthentication - description: "Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents: If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. If an error is provided: The error branch of the Authenticate Customer block is executed. The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned." + description: "Instructs Connect Customer to resume the authentication process. The subsequent actions depend on the request body contents: If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. If an error is provided: The error branch of the Authenticate Customer block is executed. The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned." parameters: [] requestBody: required: true @@ -11164,13 +11932,13 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: contact_id in: path required: true schema: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. requestBody: required: true content: @@ -11224,7 +11992,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11255,7 +12023,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11284,7 +12052,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11308,14 +12076,14 @@ paths: /queues/{instance_id}/{queue_id}/outbound-caller-config: post: operationId: UpdateQueueOutboundCallerConfig - description: Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. + description: Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. parameters: - name: instance_id in: path required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11346,7 +12114,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11377,7 +12145,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: queue_id in: path required: true @@ -11406,7 +12174,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: quick_connect_id in: path required: true @@ -11437,7 +12205,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: quick_connect_id in: path required: true @@ -11468,7 +12236,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -11499,7 +12267,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -11530,7 +12298,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -11561,7 +12329,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. - name: routing_profile_id in: path required: true @@ -11598,7 +12366,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -11635,7 +12403,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: false content: @@ -11664,7 +12432,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -11680,7 +12448,7 @@ paths: /users/{instance_id}/{user_id}/identity-info: post: operationId: UpdateUserIdentityInfo - description: Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide. + description: Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Connect Customer Administrator Guide. parameters: - name: user_id in: path @@ -11693,7 +12461,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -11777,7 +12545,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -11808,7 +12576,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -11839,7 +12607,7 @@ paths: required: true schema: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. requestBody: required: true content: @@ -11864,7 +12632,7 @@ paths: required: true schema: $ref: "#/components/schemas/ViewsInstanceId" - description: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. + description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance. - name: view_id in: path required: true @@ -12298,7 +13066,7 @@ components: description: The type of encryption. KeyId: $ref: "#/components/schemas/KeyId" - description: The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT . + description: The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID. Connect Customer supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT . required: - EncryptionType - KeyId @@ -12376,7 +13144,7 @@ components: properties: EmailAddressId: $ref: "#/components/schemas/EmailAddressId" - description: The identifier of the email address that should be associated with the queue. This email address must already exist in the Amazon Connect instance and will be used to route incoming email contacts to the specified queue. + description: The identifier of the email address that should be associated with the queue. This email address must already exist in the Connect Customer instance and will be used to route incoming email contacts to the specified queue. required: - EmailAddressId QuickConnectsList: @@ -12403,7 +13171,7 @@ components: description: "The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay." Delay: $ref: "#/components/schemas/Delay" - description: "The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide." + description: "The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Connect Customer Administrator Guide." required: - QueueReference - Priority @@ -12496,10 +13264,10 @@ components: properties: AttributeName: $ref: "#/components/schemas/PredefinedAttributeName" - description: The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance. + description: The name of user's proficiency. You must use name of predefined attribute present in the Connect Customer instance. AttributeValue: $ref: "#/components/schemas/PredefinedAttributeStringValue" - description: The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance. + description: The value of user's proficiency. You must use value of predefined attribute present in the Connect Customer instance. Level: $ref: "#/components/schemas/ProficiencyLevel" description: The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. @@ -12590,7 +13358,7 @@ components: items: $ref: "#/components/schemas/AnalyticsDataAssociationResult" AnalyticsDataAssociationResult: - description: "This API is in preview release for Amazon Connect and is subject to change. Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn." + description: "This API is in preview release for Connect Customer and is subject to change. Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn." type: object properties: DataSetId: @@ -12613,7 +13381,7 @@ components: items: $ref: "#/components/schemas/ErrorResult" ErrorResult: - description: This API is in preview release for Amazon Connect and is subject to change. List of errors for dataset association failures. + description: This API is in preview release for Connect Customer and is subject to change. List of errors for dataset association failures. type: object properties: ErrorCode: @@ -12995,7 +13763,7 @@ components: description: The use case for the file. AssociatedResourceArn: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN. Tags: type: object properties: {} @@ -13044,6 +13812,7 @@ components: - EMAIL_MESSAGE_REDACTED - EMAIL_MESSAGE_PLAIN_TEXT_REDACTED - ATTACHMENT + - VOICE_RECORDING AttachedFileErrorsList: type: array items: @@ -13110,7 +13879,7 @@ components: properties: SystemEndpoint: $ref: "#/components/schemas/Endpoint" - description: Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign. + description: Endpoint associated with the Connect Customer instance from which outbound contact will be initiated for the campaign. CustomerEndpoint: $ref: "#/components/schemas/Endpoint" description: Endpoint of the customer for which contact will be initiated. @@ -13119,7 +13888,7 @@ components: description: Identifier to uniquely identify individual requests in the batch. QueueId: $ref: "#/components/schemas/QueueId" - description: The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued. + description: The identifier of the queue associated with the Connect Customer instance in which contacts that are created will be queued. Attributes: type: object properties: {} @@ -13389,6 +14158,91 @@ components: description: The identifier of the agent status. AgentStatusId: type: string + FileSourceUri: + type: string + minLength: 1 + maxLength: 2000 + CreateAttachedFileResponse: + description: Response from CreateAttachedFile API. + type: object + properties: + FileArn: + $ref: "#/components/schemas/ARN" + description: The unique identifier of the attached file resource (ARN). + FileId: + $ref: "#/components/schemas/FileId" + description: The unique identifier of the attached file resource. + CreationTime: + $ref: "#/components/schemas/ISO8601Datetime" + description: "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z." + FileStatus: + $ref: "#/components/schemas/FileStatusType" + description: "The current status of the attached file. Valid values: PROCESSING | APPROVED | REJECTED | FAILED." + AuthScope: + description: Contains the scope configuration for an authorization code. Defines the permissions and access boundaries for the session. + type: object + properties: + SecurityProfileIds: + $ref: "#/components/schemas/SecurityProfileIds" + description: The list of security profile identifiers to scope the session to. Maximum of 10 security profiles. + EntityType: + $ref: "#/components/schemas/AuthCodeEntityType" + description: The type of entity to scope the session to. + EntityId: + $ref: "#/components/schemas/EntityId" + description: The identifier of the entity to scope the session to. + DomainName: + $ref: "#/components/schemas/CustomerProfilesDomainName" + description: The name of the Customer Profiles domain to scope the session to. + required: + - EntityType + SecurityProfileIds: + type: array + items: + $ref: "#/components/schemas/SecurityProfileId" + AuthCodeEntityType: + description: The type of entity associated with an authorization code in Connect Customer. + type: string + enum: + - CUSTOMER_PROFILE + EntityId: + type: string + minLength: 1 + maxLength: 256 + pattern: .* + CustomerProfilesDomainName: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9_-]+$ + MaxSessionDurationMinutes: + type: integer + minimum: 1440 + maximum: 43200 + SessionInactivityDurationMinutes: + type: integer + minimum: 0 + maximum: 20160 + CreateAuthCodeResponse: + type: object + properties: + AuthCode: + $ref: "#/components/schemas/AuthCode" + description: The authorization code to use for establishing a session. + SessionId: + $ref: "#/components/schemas/SessionId" + description: The identifier of the session created with the authorization code. + EntityType: + $ref: "#/components/schemas/AuthCodeEntityType" + description: The type of entity associated with the authorization code. + EntityId: + $ref: "#/components/schemas/EntityId" + description: The identifier of the entity associated with the authorization code. + AuthCode: + type: string + SessionId: + type: string + maxLength: 36 Attributes: type: object properties: {} @@ -13440,7 +14294,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. ContactArn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the created contact. @@ -13753,6 +14607,12 @@ components: Weight: $ref: "#/components/schemas/EvaluationFormItemWeight" description: The scoring weight of the section. + IsExcludedFromScoring: + $ref: "#/components/schemas/Boolean" + description: The flag to exclude the section from scoring. + ScoreThresholds: + $ref: "#/components/schemas/EvaluationFormScoreThresholdList" + description: The score thresholds for performance categories. required: - Title - RefId @@ -13766,6 +14626,33 @@ components: EvaluationFormItemWeight: type: number format: double + EvaluationFormScoreThresholdList: + type: array + items: + $ref: "#/components/schemas/EvaluationFormScoreThreshold" + EvaluationFormScoreThreshold: + description: Information about a score threshold for a performance category. + type: object + properties: + PerformanceCategory: + $ref: "#/components/schemas/PerformanceCategoryName" + description: The performance category name. + MinScorePercentage: + $ref: "#/components/schemas/EvaluationScorePercentage" + description: The minimum score percentage for the performance category. + MaxScorePercentage: + $ref: "#/components/schemas/EvaluationScorePercentage" + description: The maximum score percentage for the performance category. + required: + - PerformanceCategory + PerformanceCategoryName: + type: string + enum: + - NEEDS_IMPROVEMENT + - EXCEEDS_EXPECTATIONS + EvaluationScorePercentage: + type: number + format: double EvaluationFormQuestion: description: Information about a question from an evaluation form. type: object @@ -13794,6 +14681,9 @@ components: Weight: $ref: "#/components/schemas/EvaluationFormItemWeight" description: The scoring weight of the section. + ScoringConfiguration: + $ref: "#/components/schemas/EvaluationFormQuestionScoringConfiguration" + description: The scoring configuration of the question. required: - Title - RefId @@ -13868,6 +14758,9 @@ components: AutomaticFailConfiguration: $ref: "#/components/schemas/AutomaticFailConfiguration" description: A configuration for automatic fail. + PointsConfiguration: + $ref: "#/components/schemas/QuestionOptionPointsConfiguration" + description: The points configuration for point-based scoring. required: - MinValue - MaxValue @@ -13880,6 +14773,22 @@ components: TargetSection: $ref: "#/components/schemas/ReferenceId" description: The referenceId of the target section for auto failure. + QuestionOptionPointsConfiguration: + description: Information about the points configuration for an answer option. + type: object + properties: + PointValue: + $ref: "#/components/schemas/PointValue" + description: The point value assigned to the answer option. + IsBonus: + $ref: "#/components/schemas/Boolean" + description: The flag to mark the option as a bonus option. + required: + - PointValue + PointValue: + type: integer + minimum: 0 + maximum: 100 EvaluationFormNumericQuestionAutomation: description: Information about the automation configuration in numeric questions. type: object @@ -13967,6 +14876,9 @@ components: AutomaticFailConfiguration: $ref: "#/components/schemas/AutomaticFailConfiguration" description: Whether automatic fail is configured on a single select question. + PointsConfiguration: + $ref: "#/components/schemas/QuestionOptionPointsConfiguration" + description: The points configuration for point-based scoring. required: - RefId - Text @@ -14068,6 +14980,17 @@ components: Text: $ref: "#/components/schemas/EvaluationFormMultiSelectQuestionOptionText" description: Display text for this option. + Score: + $ref: "#/components/schemas/EvaluationFormQuestionAnswerScore" + description: The score assigned to the answer option. + AutomaticFail: + $ref: "#/components/schemas/Boolean" + description: The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. + AutomaticFailConfiguration: + $ref: "#/components/schemas/AutomaticFailConfiguration" + PointsConfiguration: + $ref: "#/components/schemas/QuestionOptionPointsConfiguration" + description: The points configuration for point-based scoring. required: - RefId - Text @@ -14245,6 +15168,32 @@ components: enum: - DISABLE - ENABLE + EvaluationFormQuestionScoringConfiguration: + description: Scoring configuration for a question in an evaluation form. + type: object + properties: + PointsConfiguration: + $ref: "#/components/schemas/QuestionPointsConfiguration" + description: The points configuration for point-based scoring. + IsExcludedFromScoring: + $ref: "#/components/schemas/Boolean" + description: The flag to exclude the question from scoring. + ScoreThresholds: + $ref: "#/components/schemas/EvaluationFormScoreThresholdList" + description: The score thresholds for performance categories. + QuestionPointsConfiguration: + description: Information about the points configuration for a question. + type: object + properties: + MaxPointValue: + $ref: "#/components/schemas/PointValue" + description: The maximum point value. + MinPointValue: + $ref: "#/components/schemas/PointValue" + description: The minimum point value. + IsBonus: + $ref: "#/components/schemas/Boolean" + description: The flag to mark the question as a bonus question. EvaluationFormScoringStrategy: description: Information about scoring strategy for an evaluation form. type: object @@ -14255,6 +15204,9 @@ components: Status: $ref: "#/components/schemas/EvaluationFormScoringStatus" description: The scoring status of the evaluation form. + ScoreThresholds: + $ref: "#/components/schemas/EvaluationFormScoreThresholdList" + description: The score thresholds for performance categories. required: - Mode - Status @@ -14263,6 +15215,7 @@ components: enum: - QUESTION_ONLY - SECTION_ONLY + - POINTS_BASED EvaluationFormScoringStatus: type: string enum: @@ -14353,6 +15306,7 @@ components: - ja-JP - ko-KR - zh-CN + - ms-MY CreateEvaluationFormResponse: type: object properties: @@ -14365,6 +15319,72 @@ components: required: - EvaluationFormId - EvaluationFormArn + ExtractionDefinitionName: + type: string + minLength: 1 + maxLength: 200 + ExtractionConfiguration: + description: The extraction configuration that defines how data is extracted from customer interactions. + type: object + properties: + PromptHint: + $ref: "#/components/schemas/ExtractionDefinitionPromptHint" + description: The prompt hint that guides the extraction. This text tells the generative AI model what data to look for in the customer interaction. + NotFoundBehavior: + $ref: "#/components/schemas/ExtractionDefinitionNotFoundBehavior" + description: The behavior when the extraction cannot find the specified data in the interaction. + required: + - PromptHint + ExtractionDefinitionPromptHint: + type: string + minLength: 1 + maxLength: 1024 + ExtractionDefinitionNotFoundBehavior: + description: The behavior configuration when an extraction definition cannot find the target value. + type: object + properties: + Behavior: + $ref: "#/components/schemas/NotFoundBehaviorType" + description: The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from the output. + DefaultValue: + $ref: "#/components/schemas/NotFoundDefaultValue" + description: The default value to use when the behavior is USE_DEFAULT_VALUE. + required: + - Behavior + NotFoundBehaviorType: + type: string + enum: + - USE_DEFAULT_VALUE + - OMIT + NotFoundDefaultValue: + type: string + maxLength: 1024 + ExtractionDefinitionDisplay: + description: The display configuration for an extraction definition. + type: object + properties: + Label: + $ref: "#/components/schemas/ExtractionDefinitionDisplayLabel" + description: The label displayed in the agent workspace for this extraction definition. + ExtractionDefinitionDisplayLabel: + type: string + maxLength: 25 + CreateExtractionDefinitionResponse: + type: object + properties: + ExtractionDefinitionArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the extraction definition. + ExtractionDefinitionId: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition. + required: + - ExtractionDefinitionArn + - ExtractionDefinitionId + ExtractionDefinitionId: + type: string + minLength: 1 + maxLength: 256 CommonNameLength127: type: string minLength: 1 @@ -14639,6 +15659,189 @@ components: type: string minLength: 1 maxLength: 200 + MetricName: + type: string + minLength: 1 + maxLength: 128 + MetricCalculation: + description: Contains the formula and component metrics that define a custom metric calculation. + type: object + properties: + CalculationComponents: + $ref: "#/components/schemas/CalculationComponentList" + description: The list of component metrics referenced in the calculation formula. Each component has an alias used in the formula expression. + Calculation: + $ref: "#/components/schemas/CalculationExpression" + description: The formula expression that defines how the metric is calculated. Uses component aliases (for example, 100 * SUM(M1) / SUM(M2)). + required: + - CalculationComponents + - Calculation + CalculationComponentList: + type: array + items: + $ref: "#/components/schemas/CalculationComponent" + CalculationComponent: + description: Represents a component metric referenced in a custom metric calculation formula. + type: object + properties: + Alias: + $ref: "#/components/schemas/ComponentAlias" + description: The alias used to reference this component in the calculation expression. + MetricName: + $ref: "#/components/schemas/MetricName" + description: The name of an AWS-managed metric used in this calculation component (for example, CONTACTS_HANDLED). Mutually exclusive with MetricId. + MetricId: + $ref: "#/components/schemas/MetricId" + description: The ARN of an AWS-managed metric used in this calculation component. Mutually exclusive with MetricName. + MetricFilters: + $ref: "#/components/schemas/MetricFilterList" + description: The filters applied to the calculation component. + required: + - Alias + ComponentAlias: + type: string + minLength: 1 + maxLength: 128 + MetricId: + type: string + minLength: 1 + maxLength: 150 + MetricFilterList: + type: array + items: + $ref: "#/components/schemas/MetricFilter" + MetricFilter: + description: A filter condition applied to a metric component in a calculation. Filters restrict the data included in the metric computation. + type: object + properties: + MetricFilterKey: + $ref: "#/components/schemas/MetricFilterKey" + description: The key identifying the field to filter on. + Negate: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the filter condition is negated. When set to true, the filter excludes matching data instead of including it. + NumberCondition: + $ref: "#/components/schemas/MetricFilterNumberCondition" + description: A numeric comparison condition. + StringCondition: + $ref: "#/components/schemas/MetricFilterStringCondition" + description: A string comparison condition. + BooleanCondition: + $ref: "#/components/schemas/MetricFilterBooleanCondition" + description: A boolean comparison condition. + required: + - MetricFilterKey + MetricFilterKey: + type: string + minLength: 1 + maxLength: 100 + MetricFilterNumberCondition: + description: A numeric comparison condition for metric filters. + type: object + properties: + Comparison: + $ref: "#/components/schemas/MetricFilterNumberConditionComparison" + description: "The comparison operator. Valid values: LESSER (less than) | LESSER_OR_EQUAL (less than or equal to) | GREATER (greater than) | GREATER_OR_EQUAL (greater than or equal to)." + Values: + $ref: "#/components/schemas/NumberValueList" + description: The numeric values to compare against. + required: + - Comparison + - Values + MetricFilterNumberConditionComparison: + description: "The numeric comparison operator for metric filters. Valid values: LESSER | LESSER_OR_EQUAL | GREATER | GREATER_OR_EQUAL." + type: string + enum: + - LESSER + - LESSER_OR_EQUAL + - GREATER + - GREATER_OR_EQUAL + NumberValueList: + type: array + items: + $ref: "#/components/schemas/Double" + Double: + type: number + format: double + MetricFilterStringCondition: + description: A string comparison condition for metric filters. + type: object + properties: + Comparison: + $ref: "#/components/schemas/MetricFilterStringConditionComparison" + description: "The comparison operator. Valid values: MATCHES_ANY (matches any of the specified values) | MATCHES_NONE (matches none of the specified values)." + Values: + $ref: "#/components/schemas/StringValueList" + description: The string values to compare against. + required: + - Comparison + - Values + MetricFilterStringConditionComparison: + description: "The string comparison operator for metric filters. Valid values: MATCHES_ANY | MATCHES_NONE." + type: string + enum: + - MATCHES_ANY + - MATCHES_NONE + StringValueList: + type: array + items: + $ref: "#/components/schemas/String" + MetricFilterBooleanCondition: + description: A boolean comparison condition for metric filters. + type: object + properties: + Comparison: + $ref: "#/components/schemas/MetricFilterBooleanConditionComparison" + description: "The comparison operator. Valid values: IS_TRUE (matches when the field is true) | IS_FALSE (matches when the field is false)." + required: + - Comparison + MetricFilterBooleanConditionComparison: + description: "The boolean comparison operator for metric filters. Valid values: IS_TRUE | IS_FALSE." + type: string + enum: + - IS_TRUE + - IS_FALSE + CalculationExpression: + type: string + minLength: 1 + maxLength: 1024 + MetricUnit: + description: "The display unit for metric data. Valid values: INTEGER | DOUBLE | PERCENT | SECONDS." + type: string + enum: + - INTEGER + - DOUBLE + - PERCENT + - SECONDS + MetricStatus: + description: "The publish status of a metric. Valid values: PUBLISHED | SAVED." + type: string + enum: + - PUBLISHED + - SAVED + MetricDescription: + type: string + minLength: 0 + maxLength: 500 + TrendIndicator: + description: "Specifies how to interpret a positive trend in metric data. Valid values: POSITIVE | NEGATIVE | NEUTRAL." + type: string + enum: + - POSITIVE + - NEGATIVE + - NEUTRAL + CreateMetricResponse: + type: object + properties: + MetricArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the metric. + MetricId: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric. + required: + - MetricArn + - MetricId RecipientList: description: A list of recipient Amazon Resource Names (ARNs). Maximum of 200 recipients. type: array @@ -14696,7 +15899,7 @@ components: minLength: 1 maxLength: 256 ParticipantCapabilities: - description: The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide. + description: The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide. type: object properties: Video: @@ -14771,12 +15974,12 @@ components: minLength: 1 maxLength: 100 InputPredefinedAttributeConfiguration: - description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website. + description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website. type: object properties: EnableValueValidationOnAssociation: $ref: "#/components/schemas/EnableValueValidationOnAssociation" - description: When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined attribute key. + description: When this parameter is set to true, Connect Customer enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined attribute key. EnableValueValidationOnAssociation: type: boolean PromptDescription: @@ -14894,7 +16097,7 @@ components: properties: QuickConnectType: $ref: "#/components/schemas/QuickConnectType" - description: "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." + description: "The type of quick connect. In the Connect Customer admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." UserConfig: $ref: "#/components/schemas/UserQuickConnectConfig" description: The user configuration. This is required only if QuickConnectType is USER. @@ -15053,6 +16256,8 @@ components: - OnRealTimeCallAnalysisAvailable - OnRealTimeChatAnalysisAvailable - OnPostChatAnalysisAvailable + - OnAfterCallWorkAvailable + - OnAfterChatWorkAvailable - OnEmailAnalysisAvailable - OnZendeskTicketCreate - OnZendeskTicketStatusUpdate @@ -15106,6 +16311,9 @@ components: SubmitAutoEvaluationAction: $ref: "#/components/schemas/SubmitAutoEvaluationActionDefinition" description: Information about the submit automated evaluation action. + ExtractInformationAction: + $ref: "#/components/schemas/ExtractInformationActionDefinition" + description: Information about the extract information action. required: - ActionType ActionType: @@ -15120,16 +16328,17 @@ components: - ASSIGN_SLA - END_ASSOCIATED_TASKS - SUBMIT_AUTO_EVALUATION + - EXTRACT_INFORMATION TaskActionDefinition: description: Information about the task action. type: object properties: Name: $ref: "#/components/schemas/TaskNameExpression" - description: The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. + description: The name. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide. Description: $ref: "#/components/schemas/TaskDescriptionExpression" - description: The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. + description: The description. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide. ContactFlowId: $ref: "#/components/schemas/ContactFlowId" description: The identifier of the flow. @@ -15173,10 +16382,10 @@ components: description: Notification delivery method. Subject: $ref: "#/components/schemas/Subject" - description: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. + description: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide. Content: $ref: "#/components/schemas/Content" - description: Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. + description: Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide. ContentType: $ref: "#/components/schemas/NotificationContentType" description: Content type format. @@ -15214,7 +16423,7 @@ components: UserTags: type: object properties: {} - description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.' + description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.' UserIds: $ref: "#/components/schemas/UserIdList" description: A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source. @@ -15272,9 +16481,6 @@ components: StringValue: $ref: "#/components/schemas/FieldStringValue" description: String value type. - Double: - type: number - format: double EmptyFieldValue: description: An empty value. type: object @@ -15351,7 +16557,7 @@ components: type: integer format: int64 minimum: 1 - maximum: 129600 + maximum: 1051200 EndAssociatedTasksActionDefinition: description: End associated tasks related to a case. type: object @@ -15368,6 +16574,32 @@ components: type: string minLength: 1 maxLength: 256 + ExtractInformationActionDefinition: + description: Information about the extract information action, which references extraction definitions to use when extracting structured data from customer interactions. + type: object + properties: + RulesExtractionDefinitions: + $ref: "#/components/schemas/RulesExtractionDefinitionIdentifierList" + description: The list of extraction definition identifiers that specify what data to extract. + required: + - RulesExtractionDefinitions + RulesExtractionDefinitionIdentifierList: + type: array + items: + $ref: "#/components/schemas/RulesExtractionDefinitionIdentifier" + RulesExtractionDefinitionIdentifier: + description: An identifier that references an extraction definition resource. + type: object + properties: + Identifier: + $ref: "#/components/schemas/RulesExtractionDefinitionId" + description: The identifier of the extraction definition. + required: + - Identifier + RulesExtractionDefinitionId: + type: string + minLength: 1 + maxLength: 256 RulePublishStatus: type: string enum: @@ -15421,7 +16653,7 @@ components: items: $ref: "#/components/schemas/Application" Application: - description: This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata. + description: This API is in preview release for Connect Customer and is subject to change. A third-party application's metadata. type: object properties: Namespace: @@ -15827,15 +17059,15 @@ components: type: string pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/ UserIdentityInfo: - description: Contains information about the identity of a user. For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory. The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName. + description: Contains information about the identity of a user. For Connect Customer instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Connect Customer because they are managed by the directory. The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Connect Customer for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName. type: object properties: FirstName: $ref: "#/components/schemas/AgentFirstName" - description: The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. + description: The first name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. LastName: $ref: "#/components/schemas/AgentLastName" - description: The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. + description: The last name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. Email: $ref: "#/components/schemas/Email" description: The email address. If you are using SAML for identity management and include this parameter, an error is returned. @@ -15891,10 +17123,6 @@ components: type: boolean DirectoryUserId: type: string - SecurityProfileIds: - type: array - items: - $ref: "#/components/schemas/SecurityProfileId" AutoAcceptConfigs: description: A list of auto-accept configuration settings for each channel. type: array @@ -16412,6 +17640,18 @@ components: DeleteAttachedFileResponse: description: Response from DeleteAttachedFile API type: object + ContactFields: + type: array + items: + $ref: "#/components/schemas/ContactField" + ContactField: + type: string + enum: + - CUSTOMER_ENDPOINT + - ADDITIONAL_EMAIL_RECIPIENTS + - EMAIL_SUBJECT + DeleteContactDataResponse: + type: object DeleteContactFlowResponse: type: object DeleteContactFlowModuleResponse: @@ -16434,11 +17674,17 @@ components: - LockVersion DeleteEmailAddressResponse: type: object + DeleteExtractionDefinitionResponse: + type: object + DeleteMetricResponse: + type: object DeleteNotificationResponse: description: The response from deleting a notification. type: object DeletePushNotificationRegistrationResponse: type: object + DeleteSessionResponse: + type: object DeleteTaskTemplateResponse: type: object DeleteTestCaseResponse: @@ -16547,7 +17793,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. AttachmentScope: $ref: "#/components/schemas/AttachmentScope" description: The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK. @@ -16612,7 +17858,7 @@ components: $ref: "#/components/schemas/AuthenticationProfile" description: The authentication profile object being described. AuthenticationProfile: - description: This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts. + description: This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts. type: object properties: Id: @@ -16629,13 +17875,13 @@ components: description: The description for the authentication profile. AllowedIps: $ref: "#/components/schemas/IpCidrList" - description: A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide. + description: A list of IP address range strings that are allowed to access the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide. BlockedIps: $ref: "#/components/schemas/IpCidrList" - description: A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide. + description: A list of IP address range strings that are blocked from accessing the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide. IsDefault: $ref: "#/components/schemas/Boolean" - description: Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile. + description: Shows whether the authentication profile is the default authentication profile for the Connect Customer instance. The default authentication profile applies to all agents in an Connect Customer instance, unless overridden by another authentication profile. CreatedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the authentication profile was created. @@ -16647,10 +17893,10 @@ components: description: The Amazon Web Services Region where the authentication profile was last modified. PeriodicSessionDuration: $ref: "#/components/schemas/AccessTokenDuration" - description: The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide. + description: The short lived session duration configuration for users logged in to Connect Customer, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Connect Customer Administrator Guide. MaxSessionDuration: $ref: "#/components/schemas/RefreshTokenDuration" - description: The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide. + description: The long lived session duration for users logged in to Connect Customer, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Connect Customer Administrator Guide. SessionInactivityDuration: $ref: "#/components/schemas/InactivityDuration" description: The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive. @@ -16761,10 +18007,10 @@ components: description: The contactId that is related to this contact. WisdomInfo: $ref: "#/components/schemas/WisdomInfo" - description: Information about Amazon Connect Wisdom. + description: Information about Connect Customer Wisdom. CustomerId: $ref: "#/components/schemas/CustomerId" - description: The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller. + description: The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Connect Customer Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller. CustomerEndpoint: $ref: "#/components/schemas/EndpointInfo" description: The customer or external third party participant endpoint. @@ -16783,7 +18029,7 @@ components: description: Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags. ConnectedToSystemTimestamp: $ref: "#/components/schemas/timestamp" - description: The timestamp when customer endpoint connected to Amazon Connect. + description: The timestamp when customer endpoint connected to Connect Customer. RoutingCriteria: $ref: "#/components/schemas/RoutingCriteria" description: Latest routing criteria on the contact. @@ -16794,7 +18040,7 @@ components: $ref: "#/components/schemas/Campaign" AnsweringMachineDetectionStatus: $ref: "#/components/schemas/AnsweringMachineDetectionStatus" - description: Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect. + description: Indicates how an outbound campaign call is actually disposed if the contact is connected to Connect Customer. CustomerVoiceActivity: $ref: "#/components/schemas/CustomerVoiceActivity" description: Information about customer’s voice activity. @@ -16813,13 +18059,13 @@ components: SegmentAttributes: type: object properties: {} - description: A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS. + description: A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS. Recordings: $ref: "#/components/schemas/Recordings" description: If recording was enabled, this is information about the recordings. DisconnectReason: $ref: "#/components/schemas/String" - description: The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under ContactTraceRecord in the Amazon Connect Administrator Guide. + description: The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under ContactTraceRecord in the Connect Customer Administrator Guide. ContactEvaluations: type: object properties: {} @@ -16987,7 +18233,7 @@ components: type: integer minimum: 0 WisdomInfo: - description: Information about Amazon Connect Wisdom. + description: Information about Connect Customer Wisdom. type: object properties: SessionArn: @@ -17056,7 +18302,7 @@ components: properties: Steps: $ref: "#/components/schemas/Steps" - description: List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. + description: List of routing steps. When Connect Customer does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. ActivationTimestamp: $ref: "#/components/schemas/timestamp" description: The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue. @@ -17616,7 +18862,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. EvaluatorArn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the user who last updated the evaluation. @@ -17663,11 +18909,15 @@ components: AppliedWeight: $ref: "#/components/schemas/Double" description: Weight applied to this evaluation score. - EvaluationScorePercentage: - type: number - format: double - minimum: 0 - maximum: 100 + EarnedPoints: + $ref: "#/components/schemas/Integer" + description: The points earned for the item. + MaxBasePoint: + $ref: "#/components/schemas/Integer" + description: The maximum base points possible for the item. + PerformanceCategory: + $ref: "#/components/schemas/PerformanceCategoryName" + description: The performance category for the score. AutoEvaluationDetails: description: Details about automated evaluations. type: object @@ -17843,7 +19093,7 @@ components: description: The name of the flow. Type: $ref: "#/components/schemas/ContactFlowType" - description: The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide. + description: The type of the flow. For descriptions of the available types, see Choose a flow type in the Connect Customer Administrator Guide. State: $ref: "#/components/schemas/ContactFlowState" description: The type of flow. @@ -17855,7 +19105,7 @@ components: description: The description of the flow. Content: $ref: "#/components/schemas/ContactFlowContent" - description: "The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000." + description: "The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000." Tags: type: object properties: {} @@ -17901,7 +19151,7 @@ components: description: The name of the flow module. Content: $ref: "#/components/schemas/ContactFlowModuleContent" - description: The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. + description: The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language. Description: $ref: "#/components/schemas/ContactFlowModuleDescription" description: The description of the flow module. @@ -18192,6 +19442,12 @@ components: LanguageConfiguration: $ref: "#/components/schemas/EvaluationFormLanguageConfiguration" description: Configuration for language settings of this evaluation form. + LatestValidationStatus: + $ref: "#/components/schemas/EvaluationFormValidationStatus" + description: "The status of the most recent validation run for this evaluation form. Valid values: IN_PROGRESS, COMPLETED, FAILED." + LastValidationTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the most recent validation was started for this evaluation form. required: - EvaluationFormId - EvaluationFormVersion @@ -18211,7 +19467,61 @@ components: enum: - DRAFT - ACTIVE - DescribeHoursOfOperationResponse: + EvaluationFormValidationStatus: + type: string + enum: + - IN_PROGRESS + - COMPLETED + - FAILED + DescribeExtractionDefinitionResponse: + type: object + properties: + ExtractionDefinition: + $ref: "#/components/schemas/ExtractionDefinition" + description: The extraction definition. + required: + - ExtractionDefinition + ExtractionDefinition: + description: Information about an extraction definition. + type: object + properties: + Name: + $ref: "#/components/schemas/ExtractionDefinitionName" + description: The name of the extraction definition. + ExtractionDefinitionId: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition. + ExtractionDefinitionArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the extraction definition. + ExtractionConfiguration: + $ref: "#/components/schemas/ExtractionConfiguration" + description: The configuration that defines how data is extracted. + Display: + $ref: "#/components/schemas/ExtractionDefinitionDisplay" + description: The display settings for the extraction definition. + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the extraction definition was created. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the extraction definition was last updated. + LastUpdatedBy: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the user who last updated the extraction definition. + Tags: + type: object + properties: {} + description: The tags used to organize, track, or control access for this resource. + required: + - Name + - ExtractionDefinitionId + - ExtractionDefinitionArn + - ExtractionConfiguration + - CreatedTime + - LastUpdatedTime + - LastUpdatedBy + DescribeHoursOfOperationResponse: type: object properties: HoursOfOperation: @@ -18320,14 +19630,14 @@ components: description: The name of the instance. ReplicationConfiguration: $ref: "#/components/schemas/ReplicationConfiguration" - description: Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide. + description: Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Connect Customer instance across Amazon Web Services Regions. For information about replicating Connect Customer instances, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide. Instance: - description: The Amazon Connect instance. + description: The Connect Customer instance. type: object properties: Id: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Arn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the instance. @@ -18357,7 +19667,7 @@ components: description: Whether outbound calls are enabled. InstanceAccessUrl: $ref: "#/components/schemas/Url" - description: This URL allows contact center users to access the Amazon Connect admin website. + description: This URL allows contact center users to access the Connect Customer admin website. Tags: type: object properties: {} @@ -18378,24 +19688,24 @@ components: Url: type: string ReplicationConfiguration: - description: Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide. + description: Details about the status of the replication of a source Connect Customer instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Connect Customer instance topic in the Connect Customer Administrator Guide. type: object properties: ReplicationStatusSummaryList: $ref: "#/components/schemas/ReplicationStatusSummaryList" - description: A list of replication status summaries. The summaries contain details about the replication of configuration information for Amazon Connect resources, for each Amazon Web Services Region. + description: A list of replication status summaries. The summaries contain details about the replication of configuration information for Connect Customer resources, for each Amazon Web Services Region. SourceRegion: $ref: "#/components/schemas/AwsRegion" - description: The Amazon Web Services Region where the source Amazon Connect instance was created. This is the Region where the ReplicateInstance API was called to start the replication process. + description: The Amazon Web Services Region where the source Connect Customer instance was created. This is the Region where the ReplicateInstance API was called to start the replication process. GlobalSignInEndpoint: $ref: "#/components/schemas/GlobalSignInEndpoint" - description: The URL that is used to sign-in to your Amazon Connect instance according to your traffic distribution group configuration. For more information about sign-in and traffic distribution groups, see Important things to know in the Create traffic distribution groups topic in the Amazon Connect Administrator Guide. + description: The URL that is used to sign-in to your Connect Customer instance according to your traffic distribution group configuration. For more information about sign-in and traffic distribution groups, see Important things to know in the Create traffic distribution groups topic in the Connect Customer Administrator Guide. ReplicationStatusSummaryList: type: array items: $ref: "#/components/schemas/ReplicationStatusSummary" ReplicationStatusSummary: - description: Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliency in the Amazon Connect Administrator Guide. + description: Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Connect Customer instance in another Amazon Web Services Region. For more information, see Set up Connect Customer Global Resiliency in the Connect Customer Administrator Guide. type: object properties: Region: @@ -18406,7 +19716,7 @@ components: description: The state of the replication. ReplicationStatusReason: $ref: "#/components/schemas/ReplicationStatusReason" - description: A description of the replication status. Use this information to resolve any issues that are preventing the successful replication of your Amazon Connect instance to another Region. + description: A description of the replication status. Use this information to resolve any issues that are preventing the successful replication of your Connect Customer instance to another Region. AwsRegion: type: string minLength: 8 @@ -18471,6 +19781,178 @@ components: StorageConfig: $ref: "#/components/schemas/InstanceStorageConfig" description: A valid storage type. + DescribeMetricResponse: + type: object + properties: + Metric: + $ref: "#/components/schemas/MetricDefinition" + description: The metric definition. + required: + - Metric + MetricDefinition: + description: Contains the full definition of a metric, including its calculation, unit, status, and trend indicator. + type: object + properties: + Arn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the metric. May be qualified with $SAVED or $LATEST. + Id: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric. + Name: + $ref: "#/components/schemas/MetricName" + description: The name of the metric. + Description: + $ref: "#/components/schemas/MetricDescription" + description: The description of the metric. + MetricCalculation: + $ref: "#/components/schemas/MetricCalculation" + description: The calculation definition for the metric. + CreationMethod: + $ref: "#/components/schemas/MetricCreationMethod" + description: "The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder)." + Status: + $ref: "#/components/schemas/MetricStatus" + description: "The publish status of the metric. Valid values: PUBLISHED | SAVED." + Type: + $ref: "#/components/schemas/MetricType" + description: "The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED." + Unit: + $ref: "#/components/schemas/MetricUnit" + description: The display unit for the metric's data. + PositiveTrendIndicator: + $ref: "#/components/schemas/TrendIndicator" + description: "How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE." + Groupings: + $ref: "#/components/schemas/MetricGroupingList" + description: The groupings available for this metric. + Filters: + $ref: "#/components/schemas/AvailableFilterList" + description: The filters applied to the metric. + EffectiveTime: + $ref: "#/components/schemas/Timestamp" + description: The earliest time that can be queried for this metric. + RefreshRate: + $ref: "#/components/schemas/RefreshRate" + description: The minimum interval, in seconds, between data refreshes for this metric. + Category: + $ref: "#/components/schemas/MetricCategory" + description: The category of the metric. + SupportedStats: + $ref: "#/components/schemas/SupportedStatsList" + description: The stat aggregations available for this metric. + DefaultStat: + $ref: "#/components/schemas/DefaultStat" + description: The default stat aggregation for the metric. + SupportsPreaggregateCalculation: + $ref: "#/components/schemas/SupportsPreaggregateCalculation" + description: Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations. + SupportsCustomCalculation: + $ref: "#/components/schemas/SupportsCustomCalculation" + description: Specifies whether the metric can be used as a component of custom metrics. + PrimaryEventSource: + $ref: "#/components/schemas/PrimaryEventSource" + description: The primary event source for the metric data. + PrimaryEventSourceEffectiveTimestampType: + $ref: "#/components/schemas/PrimaryEventSourceEffectiveTimestampType" + description: The timestamp type that determines where the metric appears on a time series. + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of when the metric was created. + CreatedUser: + $ref: "#/components/schemas/CreatedByInfo" + description: The user that created the metric. The creator for metrics created through the CreateMetric API will be Amazon Connect API. + LastModifiedRegion: + $ref: "#/components/schemas/RegionName" + description: The region where the metric was last modified. + LastModifiedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of when the metric was last modified. + LastModifiedUser: + $ref: "#/components/schemas/CreatedByInfo" + description: The user that last modified the metric. For modifications made through the API, this will be Amazon Connect API. + Tags: + type: object + properties: {} + description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.' + required: + - Arn + - Id + - Name + - Type + - Unit + - Groupings + - Filters + - Category + - SupportsPreaggregateCalculation + - SupportsCustomCalculation + MetricCreationMethod: + description: "The method used to create a custom metric. Valid values: SERVICE_LEVEL_BUILDER | METRIC_BUILDER." + type: string + enum: + - SERVICE_LEVEL_BUILDER + - METRIC_BUILDER + MetricType: + description: "The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED." + type: string + enum: + - AWS_MANAGED + - CUSTOMER_MANAGED + MetricGroupingList: + type: array + items: + $ref: "#/components/schemas/String" + AvailableFilterList: + type: array + items: + $ref: "#/components/schemas/AvailableFilter" + AvailableFilter: + description: A filter that is available for use with the metric. Part of an AvailableFilterList that describes the filters that are available for use with the metric. + type: object + properties: + Id: + $ref: "#/components/schemas/FilterId" + description: The identifier of the filter. + Type: + $ref: "#/components/schemas/AvailableFilterType" + description: "The type of the filter. Valid values: METRIC_LEVEL | RESOURCE_LEVEL." + FilterId: + type: string + minLength: 1 + maxLength: 100 + AvailableFilterType: + description: "The type of an available metric filter. Valid values: METRIC_LEVEL | RESOURCE_LEVEL." + type: string + enum: + - METRIC_LEVEL + - RESOURCE_LEVEL + RefreshRate: + type: integer + format: int64 + MetricCategory: + type: string + minLength: 1 + maxLength: 100 + SupportedStatsList: + type: array + items: + $ref: "#/components/schemas/String" + DefaultStat: + type: string + minLength: 1 + maxLength: 50 + SupportsPreaggregateCalculation: + type: boolean + SupportsCustomCalculation: + type: boolean + PrimaryEventSource: + type: string + minLength: 1 + maxLength: 100 + PrimaryEventSourceEffectiveTimestampType: + type: string + minLength: 1 + maxLength: 100 DescribeNotificationResponse: type: object properties: @@ -18531,9 +20013,9 @@ components: properties: ClaimedPhoneNumberSummary: $ref: "#/components/schemas/ClaimedPhoneNumberSummary" - description: Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group. + description: Information about a phone number that's been claimed to your Connect Customer instance or traffic distribution group. ClaimedPhoneNumberSummary: - description: Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group. + description: Information about a phone number that has been claimed to your Connect Customer instance or traffic distribution group. type: object properties: PhoneNumberId: @@ -18556,10 +20038,10 @@ components: description: The description of the phone number. TargetArn: $ref: "#/components/schemas/ARN" - description: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. + description: The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Tags: type: object properties: {} @@ -18859,10 +20341,10 @@ components: description: The values of the predefined attribute. Purposes: $ref: "#/components/schemas/PredefinedAttributePurposeNameList" - description: Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website. + description: Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website. AttributeConfiguration: $ref: "#/components/schemas/PredefinedAttributeConfiguration" - description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website. + description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website. LastModifiedTime: $ref: "#/components/schemas/Timestamp" description: Last modified time. @@ -18870,15 +20352,15 @@ components: $ref: "#/components/schemas/RegionName" description: Last modified region. PredefinedAttributeConfiguration: - description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website. + description: Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website. type: object properties: EnableValueValidationOnAssociation: $ref: "#/components/schemas/EnableValueValidationOnAssociation" - description: When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined attribute key. + description: When this parameter is set to true, Connect Customer enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined attribute key. IsReadOnly: $ref: "#/components/schemas/IsReadOnly" - description: A boolean flag used to indicate whether a predefined attribute should be displayed in the Amazon Connect admin website. + description: A boolean flag used to indicate whether a predefined attribute should be displayed in the Connect Customer admin website. IsReadOnly: type: boolean DescribePromptResponse: @@ -19012,7 +20494,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Name: $ref: "#/components/schemas/RoutingProfileName" description: The name of the routing profile. @@ -19093,6 +20575,9 @@ components: TriggerEventSource: $ref: "#/components/schemas/RuleTriggerEventSource" description: The event source to trigger the rule. + RuleCapabilityTiers: + $ref: "#/components/schemas/RuleCapabilityTiers" + description: The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI). Function: $ref: "#/components/schemas/RuleFunction" description: The conditions of the rule. @@ -19126,6 +20611,14 @@ components: - CreatedTime - LastUpdatedTime - LastUpdatedBy + RuleCapabilityTiers: + type: array + items: + $ref: "#/components/schemas/RuleCapabilityTier" + RuleCapabilityTier: + type: string + enum: + - GenerativeAI DescribeSecurityProfileResponse: type: object properties: @@ -19158,10 +20651,10 @@ components: AllowedAccessControlTags: type: object properties: {} - description: The list of tags that a security profile uses to restrict access to resources in Amazon Connect. + description: The list of tags that a security profile uses to restrict access to resources in Connect Customer. TagRestrictedResources: $ref: "#/components/schemas/TagRestrictedResourceList" - description: The list of resources that a security profile applies tag restrictions to in Amazon Connect. + description: The list of resources that a security profile applies tag restrictions to in Connect Customer. LastModifiedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when this resource was last modified. @@ -19170,10 +20663,10 @@ components: description: The Amazon Web Services Region where this resource was last modified. HierarchyRestrictedResources: $ref: "#/components/schemas/HierarchyRestrictedResourceList" - description: "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User." + description: "The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following are acceptable ResourceNames: User." AllowedAccessControlHierarchyGroupId: $ref: "#/components/schemas/HierarchyGroupId" - description: The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. + description: The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer. GranularAccessControlConfiguration: $ref: "#/components/schemas/GranularAccessControlConfiguration" description: The granular access control configuration for the security profile, including data table permissions. @@ -19285,7 +20778,7 @@ components: $ref: "#/components/schemas/User" description: Information about the user account and configuration settings. User: - description: Contains information about a user account for an Amazon Connect instance. + description: Contains information about a user account for an Connect Customer instance. type: object properties: Id: @@ -19472,7 +20965,7 @@ components: properties: Vocabulary: $ref: "#/components/schemas/Vocabulary" - description: A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns. + description: A list of specific words that you want Contact Lens for Connect Customer to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns. required: - Vocabulary Vocabulary: @@ -19721,7 +21214,7 @@ components: description: The size of the attached file in bytes. AssociatedResourceArn: $ref: "#/components/schemas/ARN" - description: The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. + description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. FileUseCaseType: $ref: "#/components/schemas/FileUseCaseType" description: The use case for the file. @@ -19827,7 +21320,7 @@ components: description: A list of up to 100 routing profile IDs or ARNs. RoutingStepExpressions: $ref: "#/components/schemas/RoutingExpressions" - description: A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. + description: A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. Accepts filter values up to 3,000 characters in length. Filter values are case-sensitive. JSON object key order and whitespace may be arbitrary; array order and tree structure must be preserved. AgentStatuses: $ref: "#/components/schemas/AgentStatuses" description: A list of up to 50 agent status IDs or ARNs. @@ -19894,7 +21387,7 @@ components: items: $ref: "#/components/schemas/CurrentMetric" CurrentMetric: - description: Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. Only one of either the Name or MetricId is required. + description: Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Connect Customer Administrator Guide. Only one of either the Name or MetricId is required. type: object properties: Name: @@ -20216,7 +21709,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. Channel: $ref: "#/components/schemas/Channel" description: The channel of the contact. @@ -20311,36 +21804,118 @@ components: enum: - OPEN - CLOSED + GetEvaluationFormValidationResponse: + type: object + properties: + Status: + $ref: "#/components/schemas/EvaluationFormValidationStatus" + description: "The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED." + FailureReason: + $ref: "#/components/schemas/EvaluationFormValidationFailureReason" + description: The reason the validation failed. This field is populated only when the status is FAILED. + EvaluationFormId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for the evaluation form. + EvaluationFormVersion: + $ref: "#/components/schemas/VersionNumber" + description: A version of the evaluation form. + StartedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the validation process was started. + Findings: + $ref: "#/components/schemas/EvaluationFormValidationFindingList" + description: A list of findings from the validation process. Each finding identifies a structural issue or quality improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is COMPLETED. + required: + - Status + - EvaluationFormId + - EvaluationFormVersion + - StartedTime + EvaluationFormValidationFailureReason: + type: string + EvaluationFormValidationFindingList: + type: array + items: + $ref: "#/components/schemas/EvaluationFormValidationFinding" + EvaluationFormValidationFinding: + description: Information about a finding from the evaluation form validation process. Each finding identifies a structural issue or quality improvement opportunity for the evaluation form. + type: object + properties: + IssueCode: + $ref: "#/components/schemas/EvaluationFormValidationIssueCode" + description: A code that identifies the type of validation issue found. + Items: + $ref: "#/components/schemas/EvaluationFormValidationFindingItemList" + description: A list of evaluation form items affected by this finding. + Description: + $ref: "#/components/schemas/EvaluationFormValidationFindingDescription" + description: A description of the validation issue. + Suggestion: + $ref: "#/components/schemas/EvaluationFormValidationFindingSuggestion" + description: A suggested fix for the validation issue. + Severity: + $ref: "#/components/schemas/EvaluationFormValidationFindingSeverity" + description: "The severity of the finding. Valid values: WARNING, ERROR." + required: + - IssueCode + - Description + - Severity + EvaluationFormValidationIssueCode: + type: string + EvaluationFormValidationFindingItemList: + type: array + items: + $ref: "#/components/schemas/EvaluationFormValidationFindingItem" + EvaluationFormValidationFindingItem: + description: Information about an evaluation form item affected by a validation finding. + type: object + properties: + RefId: + $ref: "#/components/schemas/ReferenceId" + description: The identifier of the evaluation form item (question or section) affected by the finding. + Property: + $ref: "#/components/schemas/EvaluationFormValidationFindingItemProperty" + description: The specific property of the evaluation form item that the finding relates to. + EvaluationFormValidationFindingItemProperty: + type: string + EvaluationFormValidationFindingDescription: + type: string + EvaluationFormValidationFindingSuggestion: + type: string + EvaluationFormValidationFindingSeverity: + type: string + enum: + - WARNING + - ERROR GetFederationTokenResponse: type: object properties: + UserId: + $ref: "#/components/schemas/AgentResourceId" + description: The identifier for the user. This can be the ID or the ARN of the user. + UserArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the user. Credentials: $ref: "#/components/schemas/Credentials" description: The credentials to use for federation. SignInUrl: $ref: "#/components/schemas/Url" description: The URL to sign into the user's instance. - UserArn: - $ref: "#/components/schemas/ARN" - description: The Amazon Resource Name (ARN) of the user. - UserId: - $ref: "#/components/schemas/AgentResourceId" - description: The identifier for the user. This can be the ID or the ARN of the user. Credentials: description: Contains credentials to use for federation. type: object properties: AccessToken: $ref: "#/components/schemas/SecurityToken" - description: An access token generated for a federated user to access Amazon Connect. + description: An access token generated for a federated user to access Connect Customer. AccessTokenExpiration: - $ref: "#/components/schemas/timestamp" - description: A token generated with an expiration time for the session a user is logged in to Amazon Connect. + $ref: "#/components/schemas/Timestamp" + description: A token generated with an expiration time for the session a user is logged in to Connect Customer. RefreshToken: $ref: "#/components/schemas/SecurityToken" - description: Renews a token generated for a user to access the Amazon Connect instance. + description: Renews a token generated for a user to access the Connect Customer instance. RefreshTokenExpiration: - $ref: "#/components/schemas/timestamp" + $ref: "#/components/schemas/Timestamp" description: Renews the expiration timer for a generated token. SecurityToken: type: string @@ -20366,7 +21941,7 @@ components: properties: Name: $ref: "#/components/schemas/HistoricalMetricName" - description: 'The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: PERCENT Statistic: AVG Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X' + description: 'The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Connect Customer Administrator Guide. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: PERCENT Statistic: AVG Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X' Threshold: $ref: "#/components/schemas/Threshold" description: The threshold for the metric, used with service level metrics. @@ -20474,7 +22049,7 @@ components: description: The timezone applied to requested metrics. IntervalPeriod: $ref: "#/components/schemas/IntervalPeriod" - description: "IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL. For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period. The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested. FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days. THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days. HOUR: The difference between StartTime and EndTime must be less than 3 days. DAY: The difference between StartTime and EndTime must be less than 35 days. WEEK: The difference between StartTime and EndTime must be less than 35 days. TOTAL: The difference between StartTime and EndTime must be less than 35 days." + description: "IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL. For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Connect Customer returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Connect Customer aggregates results based on the TOTAL interval period. The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested. FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days. THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days. HOUR: The difference between StartTime and EndTime must be less than 3 days. DAY: The difference between StartTime and EndTime must be less than 35 days. WEEK: The difference between StartTime and EndTime must be less than 35 days. TOTAL: The difference between StartTime and EndTime must be less than 35 days." IntervalPeriod: type: string enum: @@ -20542,7 +22117,7 @@ components: description: Contains information about the threshold for service level metrics. MetricId: $ref: "#/components/schemas/MetricId" - description: Historical metrics or custom metrics can be referenced via this field. This field is a valid Amazon Connect Arn or a UUID + description: Historical metrics or custom metrics can be referenced via this field. This field is a valid Connect Customer Arn or a UUID MetricFilters: $ref: "#/components/schemas/MetricFiltersV2List" description: Contains the filters to be used when returning data. @@ -20562,10 +22137,6 @@ components: ThresholdValue: $ref: "#/components/schemas/ThresholdValue" description: The threshold value to compare. - MetricId: - type: string - minLength: 1 - maxLength: 150 MetricFiltersV2List: type: array items: @@ -20579,7 +22150,7 @@ components: description: "The key to use for filtering data. Valid metric filter keys: ANSWERING_MACHINE_DETECTION_STATUS CASE_STATUS DISCONNECT_REASON FLOWS_ACTION_IDENTIFIER FLOWS_NEXT_ACTION_IDENTIFIER FLOWS_OUTCOME_TYPE FLOWS_RESOURCE_TYPE INITIATION_METHOD" MetricFilterValues: $ref: "#/components/schemas/MetricFilterValueList" - description: The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case. For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide. For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide. For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide. For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide. + description: The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case. For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Connect Customer Administrator Guide. For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Connect Customer Administrator Guide. For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Connect Customer Administrator Guide. For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Connect Customer Administrator Guide. Negate: $ref: "#/components/schemas/Boolean" description: If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false. @@ -20668,7 +22239,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Id: $ref: "#/components/schemas/TaskTemplateId" description: A unique identifier for the task template. @@ -20689,7 +22260,7 @@ components: description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. Constraints: $ref: "#/components/schemas/TaskTemplateConstraints" - description: Constraints that are applicable to the fields listed. + description: Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields. Defaults: $ref: "#/components/schemas/TaskTemplateDefaults" description: The default values for fields when a task is created by referencing this template. @@ -20967,7 +22538,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. ContactArn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the contact @@ -21012,7 +22583,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. AttachmentScope: $ref: "#/components/schemas/AttachmentScope" description: The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK. @@ -21038,7 +22609,7 @@ components: items: $ref: "#/components/schemas/AuthenticationProfileSummary" AuthenticationProfileSummary: - description: This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. A summary of a given authentication profile. + description: This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. A summary of a given authentication profile. type: object properties: Id: @@ -21052,7 +22623,7 @@ components: description: The name of the authentication profile summary. IsDefault: $ref: "#/components/schemas/Boolean" - description: Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile. + description: Shows whether the authentication profile is the default authentication profile for the Connect Customer instance. The default authentication profile applies to all agents in an Connect Customer instance, unless overridden by another authentication profile. LastModifiedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the authentication profile summary was last modified. @@ -21325,7 +22896,7 @@ components: items: $ref: "#/components/schemas/ContactFlowSummary" ContactFlowSummary: - description: Contains summary information about a flow. You can also create and update flows using the Amazon Connect Flow language. + description: Contains summary information about a flow. You can also create and update flows using the Connect Customer Flow language. type: object properties: Id: @@ -21692,7 +23263,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. LanguageCode: $ref: "#/components/schemas/VocabularyLanguageCode" description: The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe? @@ -21837,6 +23408,50 @@ components: - LastModifiedTime - LastModifiedBy - LatestVersion + ListExtractionDefinitionsResponse: + type: object + properties: + ExtractionDefinitionSummaryList: + $ref: "#/components/schemas/ExtractionDefinitionSummaryList" + description: Information about the extraction definitions. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If there are additional results, this is the token for the next set of results. + required: + - ExtractionDefinitionSummaryList + ExtractionDefinitionSummaryList: + type: array + items: + $ref: "#/components/schemas/ExtractionDefinitionSummary" + ExtractionDefinitionSummary: + description: Summary information about an extraction definition. + type: object + properties: + Name: + $ref: "#/components/schemas/ExtractionDefinitionName" + description: The name of the extraction definition. + ExtractionDefinitionId: + $ref: "#/components/schemas/ExtractionDefinitionId" + description: The identifier of the extraction definition. + ExtractionDefinitionArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the extraction definition. + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the extraction definition was created. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the extraction definition was last updated. + LastUpdatedBy: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the user who last updated the extraction definition. + required: + - Name + - ExtractionDefinitionId + - ExtractionDefinitionArn + - CreatedTime + - LastUpdatedTime + - LastUpdatedBy ListFlowAssociationsResponse: type: object properties: @@ -21979,7 +23594,7 @@ components: description: Whether outbound calls are enabled. InstanceAccessUrl: $ref: "#/components/schemas/Url" - description: This URL allows contact center users to access the Amazon Connect admin website. + description: This URL allows contact center users to access the Connect Customer admin website. ListIntegrationAssociationsResponse: type: object properties: @@ -22005,7 +23620,7 @@ components: description: The Amazon Resource Name (ARN) for the AppIntegration association. InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. IntegrationType: $ref: "#/components/schemas/IntegrationType" description: The integration type. @@ -22047,6 +23662,52 @@ components: type: array items: $ref: "#/components/schemas/LexBot" + ListMetricsResponse: + type: object + properties: + MetricSummaryList: + $ref: "#/components/schemas/MetricSummaryList" + description: The list of metric summaries. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If there are additional results, this is the token for the next set of results. + required: + - MetricSummaryList + MetricSummaryList: + type: array + items: + $ref: "#/components/schemas/MetricSummary" + MetricSummary: + description: Contains summary information about a metric. + type: object + properties: + Arn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the metric. + Id: + $ref: "#/components/schemas/MetricId" + description: The identifier of the metric. + Name: + $ref: "#/components/schemas/MetricName" + description: The name of the metric. + Status: + $ref: "#/components/schemas/MetricStatus" + description: The publish status of the metric. + Type: + $ref: "#/components/schemas/MetricType" + description: The type of the metric. + LastModifiedRegion: + $ref: "#/components/schemas/RegionName" + description: The region where the metric was last modified. + LastModifiedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of when the metric was last modified. + required: + - Arn + - Id + - Name + - Status + - Type ListNotificationsResponse: type: object properties: @@ -22118,13 +23779,13 @@ components: description: If there are additional results, this is the token for the next set of results. ListPhoneNumbersSummaryList: $ref: "#/components/schemas/ListPhoneNumbersSummaryList" - description: Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups. + description: Information about phone numbers that have been claimed to your Connect Customer instances or traffic distribution groups. ListPhoneNumbersSummaryList: type: array items: $ref: "#/components/schemas/ListPhoneNumbersSummary" ListPhoneNumbersSummary: - description: Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group. + description: Information about phone numbers that have been claimed to your Connect Customer instance or traffic distribution group. type: object properties: PhoneNumberId: @@ -22144,10 +23805,10 @@ components: description: The type of phone number. TargetArn: $ref: "#/components/schemas/ARN" - description: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. + description: The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. PhoneNumberDescription: $ref: "#/components/schemas/PhoneNumberDescription" description: The description of the phone number. @@ -22282,7 +23943,7 @@ components: description: The name of the quick connect. QuickConnectType: $ref: "#/components/schemas/QuickConnectType" - description: "The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." + description: "The type of quick connect. In the Connect Customer admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." LastModifiedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when this resource was last modified. @@ -22633,7 +24294,7 @@ components: description: A case-sensitive name of the attachment being uploaded. Can be redacted. ContentType: $ref: "#/components/schemas/ContentType" - description: Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide. + description: Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Connect Customer Administrator Guide. AttachmentId: $ref: "#/components/schemas/ArtifactId" description: A unique identifier for the attachment. @@ -22770,7 +24431,7 @@ components: description: "The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay." Delay: $ref: "#/components/schemas/Delay" - description: "The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide." + description: "The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Connect Customer Administrator Guide." Channel: $ref: "#/components/schemas/Channel" description: The channels this queue supports. @@ -22851,6 +24512,9 @@ components: PublishStatus: $ref: "#/components/schemas/RulePublishStatus" description: The publish status of the rule. + RuleCapabilityTiers: + $ref: "#/components/schemas/RuleCapabilityTiers" + description: The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI). ActionSummaries: $ref: "#/components/schemas/ActionSummaries" description: A list of ActionTypes associated with a rule. @@ -23343,7 +25007,7 @@ components: description: The Amazon Resource Name (ARN) of the user account. Username: $ref: "#/components/schemas/AgentUsername" - description: The Amazon Connect user name of the user account. + description: The Connect Customer user name of the user account. LastModifiedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when this resource was last modified. @@ -23662,7 +25326,7 @@ components: description: If there are additional results, this is the token for the next set of results. AvailableNumbersList: $ref: "#/components/schemas/AvailableNumbersList" - description: A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. + description: A list of available phone numbers that you can claim to your Connect Customer instance or traffic distribution group. AvailableNumbersList: type: array items: @@ -23813,6 +25477,72 @@ components: properties: AttributeFilter: $ref: "#/components/schemas/ControlPlaneAttributeFilter" + description: An object that can be used to specify tag conditions. + ContactEvaluationAttributeFilter: + $ref: "#/components/schemas/ContactEvaluationAttributeFilter" + description: An object that can be used to specify tag conditions and attribute conditions for contact evaluations. + ContactEvaluationAttributeFilter: + description: "An object that can be used to specify tag conditions and attribute conditions inside the SearchFilter for contact evaluations. This accepts an OR or AND (List of List) input where: The top level list specifies conditions that need to be applied with OR operator. The inner list specifies conditions that need to be applied with AND operator." + type: object + properties: + OrConditions: + $ref: "#/components/schemas/ContactEvaluationAttributeOrConditionList" + description: A list of conditions which would be applied together with an OR condition. + AndCondition: + $ref: "#/components/schemas/ContactEvaluationAttributeAndCondition" + description: A list of conditions which would be applied together with an AND condition. + TagCondition: + $ref: "#/components/schemas/TagCondition" + description: A tag condition to apply. + ContactEvaluationAttributeCondition: + $ref: "#/components/schemas/ContactEvaluationAttributeCondition" + description: An attribute condition to apply. + ContactEvaluationAttributeOrConditionList: + type: array + items: + $ref: "#/components/schemas/ContactEvaluationAttributeAndCondition" + ContactEvaluationAttributeAndCondition: + description: A list of conditions which would be applied together with an AND condition. + type: object + properties: + TagConditions: + $ref: "#/components/schemas/TagAndConditionList" + description: A list of tag conditions to apply. + AttributeConditions: + $ref: "#/components/schemas/ContactEvaluationAttributeConditionList" + description: A list of attribute conditions to apply. + ContactEvaluationAttributeConditionList: + type: array + items: + $ref: "#/components/schemas/ContactEvaluationAttributeCondition" + ContactEvaluationAttributeCondition: + description: An attribute condition for contact evaluation filtering. + type: object + properties: + AttributeKey: + $ref: "#/components/schemas/ContactEvaluationAttributeKey" + description: The key of the attribute. + AttributeValue: + $ref: "#/components/schemas/ContactEvaluationAttributeValue" + description: The value of the attribute. + ComparisonType: + $ref: "#/components/schemas/ContactEvaluationAttributeComparisonType" + description: The comparison type for the condition. + ContactEvaluationAttributeKey: + type: string + enum: + - ContactAgentId + ContactEvaluationAttributeValue: + description: The value of a contact evaluation attribute condition. + type: object + properties: + StringValue: + $ref: "#/components/schemas/String" + description: A string value for the attribute. + ContactEvaluationAttributeComparisonType: + type: string + enum: + - EXACT SearchContactEvaluationsResponse: type: object properties: @@ -23881,7 +25611,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. EvaluatorArn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the person who evaluated the contact. @@ -23927,6 +25657,15 @@ components: ContactParticipantId: $ref: "#/components/schemas/ResourceId" description: Identifier for a contact participant in the evaluation. + EarnedPoints: + $ref: "#/components/schemas/Integer" + description: The points earned for the evaluation. + MaxBasePoint: + $ref: "#/components/schemas/Integer" + description: The maximum base points possible for the evaluation. + PerformanceCategory: + $ref: "#/components/schemas/PerformanceCategoryName" + description: The performance category for the evaluation score. required: - ContactId - EvaluatorArn @@ -24120,7 +25859,7 @@ components: description: The list of channels associated with contacts. ContactAnalysis: $ref: "#/components/schemas/ContactAnalysis" - description: Search criteria based on analysis outputs from Amazon Connect Contact Lens. + description: Search criteria based on analysis outputs from Connect Customer Contact Lens. InitiationMethods: $ref: "#/components/schemas/InitiationMethodList" description: The list of initiation methods associated with contacts. @@ -24135,7 +25874,7 @@ components: description: Additional TimeRange used to filter contacts. SearchableContactAttributes: $ref: "#/components/schemas/SearchableContactAttributes" - description: The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide. To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect. + description: The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Connect Customer Administrator Guide. To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Connect Customer. SearchableSegmentAttributes: $ref: "#/components/schemas/SearchableSegmentAttributes" description: The search criteria based on searchable segment attributes of a contact. @@ -24144,6 +25883,9 @@ components: description: The list of active regions for contacts in ACGR instances. ContactTags: $ref: "#/components/schemas/ControlPlaneTagFilter" + AiAgents: + $ref: "#/components/schemas/AiAgentsCriteria" + description: AI Agent search criteria definitions. NameCriteria: description: The search criteria based on the contact name type: object @@ -24176,7 +25918,7 @@ components: items: $ref: "#/components/schemas/AgentResourceId" AgentHierarchyGroups: - description: A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide. + description: A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide. type: object properties: L1Ids: @@ -24203,14 +25945,14 @@ components: items: $ref: "#/components/schemas/Channel" ContactAnalysis: - description: A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens. + description: A structure that defines search criteria for contacts using analysis outputs from Connect Customer Contact Lens. type: object properties: Transcript: $ref: "#/components/schemas/Transcript" - description: Search criteria based on transcript analyzed by Amazon Connect Contact Lens. + description: Search criteria based on transcript analyzed by Connect Customer Contact Lens. Transcript: - description: A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens. + description: A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Connect Customer Contact Lens. type: object properties: Criteria: @@ -24407,15 +26149,49 @@ components: type: array items: $ref: "#/components/schemas/RegionName" - Sort: - description: A structure that defines the field name to sort by and a sort order. + AiAgentsCriteria: + description: AI Agent search criteria definitions. type: object properties: - FieldName: - $ref: "#/components/schemas/SortableFieldName" - description: The name of the field on which to sort. - Order: - $ref: "#/components/schemas/SortOrder" + Criteria: + $ref: "#/components/schemas/AiAgentSearchCriteriaList" + description: The list of criteria based on AI Agent metadata. + AiAgentSearchCriteriaList: + type: array + items: + $ref: "#/components/schemas/AiAgentSearchCriteria" + AiAgentSearchCriteria: + description: The search criteria based on AI Agents metadata. + type: object + properties: + Id: + $ref: "#/components/schemas/AiAgentId" + description: ID of the AI Agent that was involved in the contact. + VersionNumber: + $ref: "#/components/schemas/AiAgentVersionNumber" + description: Version of the AI agent that was involved in the contact. ID is required if VersionNumber is passed. + AiAgentEscalated: + $ref: "#/components/schemas/Boolean" + description: A boolean flag indicating whether the contact initially handled by this AI agent was escalated to a human agent. + AiUseCase: + $ref: "#/components/schemas/AiUseCase" + description: The use case or scenario for which the AI agent is involved in the contact. + AiAgentId: + type: string + minLength: 0 + maxLength: 128 + pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}" + AiAgentVersionNumber: + type: integer + Sort: + description: A structure that defines the field name to sort by and a sort order. + type: object + properties: + FieldName: + $ref: "#/components/schemas/SortableFieldName" + description: The name of the field on which to sort. + Order: + $ref: "#/components/schemas/SortOrder" description: An ascending or descending sort. required: - FieldName @@ -24481,7 +26257,7 @@ components: description: The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact. DisconnectTimestamp: $ref: "#/components/schemas/timestamp" - description: The timestamp when the customer endpoint disconnected from Amazon Connect. + description: The timestamp when the customer endpoint disconnected from Connect Customer. ScheduledTimestamp: $ref: "#/components/schemas/timestamp" description: The timestamp, in Unix epoch time format, at which to start running the inbound flow. @@ -24501,6 +26277,9 @@ components: GlobalResiliencyMetadata: $ref: "#/components/schemas/GlobalResiliencyMetadata" description: Additional routing information for contacts created in ACGR instances. + AiAgentInfo: + $ref: "#/components/schemas/ContactSearchSummaryAiAgentInfoList" + description: Information about the AI agents involved in the contact. ContactSearchSummaryQueueInfo: description: If this contact was queued, this contains information about the queue. type: object @@ -24521,6 +26300,23 @@ components: ConnectedToAgentTimestamp: $ref: "#/components/schemas/timestamp" description: The timestamp when the contact was connected to the agent. + ContactSearchSummaryAiAgentInfoList: + type: array + items: + $ref: "#/components/schemas/ContactSearchSummaryAiAgentInfo" + ContactSearchSummaryAiAgentInfo: + description: Information of the AI agent involved in the contact. + type: object + properties: + AiAgentVersionId: + $ref: "#/components/schemas/AiAgentVersionId" + description: The unique identifier that specifies both the AI agent ID and its version number that was involved in the contact. + AiAgentEscalated: + $ref: "#/components/schemas/Boolean" + description: A boolean flag indicating whether the contact initially handled by this AI agent was escalated to a human agent. + AiUseCase: + $ref: "#/components/schemas/AiUseCase" + description: The use case or scenario for which the AI agent is involved in the contact. Valid values are AgentAssistance and SelfService. TotalCount: type: integer format: int64 @@ -24828,6 +26624,47 @@ components: type: array items: $ref: "#/components/schemas/HoursOfOperation" + MetricSearchFilter: + description: Filters to apply when searching for metrics. + type: object + properties: + TagFilter: + $ref: "#/components/schemas/ControlPlaneTagFilter" + description: "An object that can be used to specify tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where: The top level list specifies conditions that need to be applied with OR operator. The inner list specifies conditions that need to be applied with AND operator." + MetricSearchCriteria: + description: Defines the search criteria for filtering metrics. + type: object + properties: + OrConditions: + $ref: "#/components/schemas/MetricSearchConditionList" + description: A list of conditions to be met, where at least one condition must be satisfied. + AndConditions: + $ref: "#/components/schemas/MetricSearchConditionList" + description: A list of conditions that must all be satisfied. + StringCondition: + $ref: "#/components/schemas/StringCondition" + BooleanCondition: + $ref: "#/components/schemas/BooleanCondition" + MetricSearchConditionList: + type: array + items: + $ref: "#/components/schemas/MetricSearchCriteria" + SearchMetricsResponse: + type: object + properties: + Metrics: + $ref: "#/components/schemas/MetricSearchSummaryList" + description: The metrics that matched the search criteria. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If there are additional results, this is the token for the next set of results. + ApproximateTotalCount: + $ref: "#/components/schemas/ApproximateTotalCount" + description: The approximate total number of metrics that matched your search criteria. + MetricSearchSummaryList: + type: array + items: + $ref: "#/components/schemas/MetricDefinition" NotificationSearchFilter: description: Filters to apply when searching for notifications. type: object @@ -25105,7 +26942,7 @@ components: properties: Tags: $ref: "#/components/schemas/TagsList" - description: A list of tags used in the Amazon Connect instance. + description: A list of tags used in the Connect Customer instance. NextToken: $ref: "#/components/schemas/NextToken2500" description: If there are additional results, this is the token for the next set of results. @@ -25170,6 +27007,119 @@ components: type: array items: $ref: "#/components/schemas/RoutingProfile" + RulesSearchCriteria: + description: The search criteria to be used to return rules. + type: object + properties: + OrConditions: + $ref: "#/components/schemas/RulesSearchConditionList" + description: A list of conditions which would be applied together with an OR condition. + AndConditions: + $ref: "#/components/schemas/RulesSearchConditionList" + description: A list of conditions which would be applied together with an AND condition. + StringCondition: + $ref: "#/components/schemas/StringCondition" + description: A leaf node condition which can be used to specify a string condition. The currently supported values for FieldName are Name, PublishStatus, EventSourceName, RuleId, IntegrationAssociationId, ActionSummaries, and RuleCapabilityTiers. + RulesSearchConditionList: + type: array + items: + $ref: "#/components/schemas/RulesSearchCriteria" + RulesSearchFilter: + description: Filters to be applied to search results. + type: object + properties: + AttributeFilter: + $ref: "#/components/schemas/RuleAttributeFilter" + description: An object that can be used to specify tag conditions inside the SearchFilter. + RuleAttributeFilter: + description: "An object that can be used to specify tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where: The top level list specifies conditions that need to be applied with OR operator. The inner list specifies conditions that need to be applied with AND operator." + type: object + properties: + OrConditions: + $ref: "#/components/schemas/RuleAttributeOrConditionList" + description: A list of conditions which would be applied together with an OR condition. + AndCondition: + $ref: "#/components/schemas/RuleAttributeAndCondition" + description: A list of conditions which would be applied together with an AND condition. + TagCondition: + $ref: "#/components/schemas/TagCondition" + RuleAttributeOrConditionList: + type: array + items: + $ref: "#/components/schemas/RuleAttributeAndCondition" + RuleAttributeAndCondition: + description: A list of conditions which would be applied together with an AND condition. + type: object + properties: + TagConditions: + $ref: "#/components/schemas/TagAndConditionList" + description: A list of tag conditions that need to be applied with AND condition. + SearchRulesResponse: + type: object + properties: + Rules: + $ref: "#/components/schemas/RuleSearchSummaryList" + description: Information about the rules. + ApproximateTotalCount: + $ref: "#/components/schemas/ApproximateTotalCount" + description: The total number of rules which matched your search query. + NextToken: + $ref: "#/components/schemas/NextToken2500" + description: If there are additional results, this is the token for the next set of results. + required: + - Rules + RuleSearchSummaryList: + type: array + items: + $ref: "#/components/schemas/RuleSearchSummary" + RuleSearchSummary: + description: A summary of information about a rule, returned as part of the response to a SearchRules operation. + type: object + properties: + Name: + $ref: "#/components/schemas/RuleName" + description: The name of the rule. + RuleId: + $ref: "#/components/schemas/RuleId" + description: A unique identifier for the rule. + RuleArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the rule. + TriggerEventSource: + $ref: "#/components/schemas/RuleTriggerEventSource" + description: The event source to trigger the rule. + ActionSummaries: + $ref: "#/components/schemas/ActionSummaries" + description: A list of ActionTypes associated with a rule. + RuleCapabilityTiers: + $ref: "#/components/schemas/RuleCapabilityTiers" + description: The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI). + PublishStatus: + $ref: "#/components/schemas/RulePublishStatus" + description: The publish status of the rule. + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp for when the rule was created. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp for when the rule was last updated. + LastUpdatedBy: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the user who last updated the rule. + Tags: + type: object + properties: {} + description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.' + required: + - Name + - RuleId + - RuleArn + - TriggerEventSource + - ActionSummaries + - PublishStatus + - CreatedTime + - LastUpdatedTime + - LastUpdatedBy SecurityProfileSearchCriteria: description: The search criteria to be used to return security profiles. The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. type: object @@ -25737,10 +27687,10 @@ components: description: Type of chat integration event. ContentType: $ref: "#/components/schemas/ChatContentType" - description: Type of content. This is required when Type is MESSAGE or EVENT. For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference. For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference. + description: Type of content. This is required when Type is MESSAGE or EVENT. For allowed message content types, see the ContentType parameter in the SendMessage topic in the Connect Customer Participant Service API Reference. For allowed event content types, see the ContentType parameter in the SendEvent topic in the Connect Customer Participant Service API Reference. Content: $ref: "#/components/schemas/ChatContent" - description: Content of the message or event. This is required when Type is MESSAGE and for certain ContentTypes when Type is EVENT. For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference. For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference. + description: Content of the message or event. This is required when Type is MESSAGE and for certain ContentTypes when Type is EVENT. For allowed message content, see the Content parameter in the SendMessage topic in the Connect Customer Participant Service API Reference. For allowed event content, see the Content parameter in the SendEvent topic in the Connect Customer Participant Service API Reference. required: - Type ChatEventType: @@ -25769,7 +27719,7 @@ components: Attributes: type: object properties: {} - description: A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. + description: A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. StreamingConfiguration: $ref: "#/components/schemas/ChatStreamingConfiguration" SupportedMessagingContentTypes: @@ -25781,7 +27731,7 @@ components: minLength: 1 maxLength: 100 ParticipantDetails: - description: The customer's details. + description: The details of the participant, including their display name. type: object properties: DisplayName: @@ -25944,6 +27894,149 @@ components: maxLength: 36 SendOutboundEmailResponse: type: object + WebBrowserId: + type: string + minLength: 1 + maxLength: 36 + WebSessionId: + type: string + minLength: 1 + maxLength: 36 + WebNotificationSource: + description: The source of an outbound web notification. Identifies the campaign and outbound request that triggered the notification. + type: object + properties: + SourceCampaign: + $ref: "#/components/schemas/SourceCampaign" + description: Information about the campaign that triggered the web notification, including the campaign identifier and outbound request identifier. + required: + - SourceCampaign + WidgetDestination: + description: The destination for an outbound web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient. + type: object + properties: + WidgetId: + $ref: "#/components/schemas/WidgetId" + description: The identifier of the communication widget that delivers the notification to the customer's browser. + ProfileId: + $ref: "#/components/schemas/CustomerProfileId" + description: The identifier of the customer profile associated with the browser session that should receive the notification. + required: + - WidgetId + - ProfileId + WidgetId: + type: string + minLength: 1 + maxLength: 36 + CustomerProfileId: + type: string + minLength: 1 + maxLength: 32 + WebNotificationContent: + description: The content of an outbound web notification, including the notification type, the view to render, and any optional attributes used to populate the view. + type: object + properties: + Type: + $ref: "#/components/schemas/NotificationType" + description: The type of web notification to send. + ViewArn: + $ref: "#/components/schemas/ViewArn" + description: The Amazon Resource Name (ARN) of the view to render for the notification. + Attributes: + $ref: "#/components/schemas/ContentAttributes" + description: Optional attributes used to populate the notification content, such as recommender configuration for personalized content. + required: + - Type + NotificationType: + type: string + enum: + - WIDGET_VIEW + - WIDGET_ACTION + ViewArn: + type: string + minLength: 1 + maxLength: 500 + ContentAttributes: + description: Optional attributes used to populate the content of an outbound web notification, such as recommender configuration for personalized content. + type: object + properties: + RecommenderConfig: + $ref: "#/components/schemas/RecommenderConfig" + description: Configuration for the recommender used to generate personalized recommendations for the notification content. + RecommenderConfig: + description: Configuration for the recommender used to generate personalized recommendations included in an outbound web notification. + type: object + properties: + DomainName: + $ref: "#/components/schemas/PersonalizeDomainName" + description: The name of the Amazon Personalize domain that hosts the recommender. + RecommenderName: + $ref: "#/components/schemas/RecommenderName" + description: The name of the recommender used to generate the recommendations. + Context: + type: object + properties: {} + description: A map of contextual key-value pairs supplied to the recommender to influence the recommendations returned. + required: + - DomainName + - RecommenderName + PersonalizeDomainName: + type: string + minLength: 1 + maxLength: 64 + RecommenderName: + type: string + minLength: 1 + maxLength: 64 + SendOutboundWebNotificationResponse: + type: object + AiAgentInput: + description: The AI agent that participates in the contact, including its identifier. + type: object + properties: + AiAgentId: + $ref: "#/components/schemas/AiAgentId" + description: The identifier of the AI agent that participates in the contact. + required: + - AiAgentId + ChatMessage: + description: A chat message. + type: object + properties: + ContentType: + $ref: "#/components/schemas/ChatContentType" + description: The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response. + Content: + $ref: "#/components/schemas/ChatContent" + description: The content of the chat message. Maximum of 16,384 bytes for all content types (text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response). Some messaging channels enforce lower limits. For channel-specific message size limits, see Chat message size limits by channel in the Amazon Connect Customer Administrator Guide. + required: + - ContentType + - Content + PersistentChat: + description: Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat. + type: object + properties: + RehydrationType: + $ref: "#/components/schemas/RehydrationType" + description: "The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Connect Customer determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field. The actual contactId used for rehydration is provided in the response of this API." + SourceContactId: + $ref: "#/components/schemas/ContactId" + description: The contactId from which a persistent chat session must be started. + StartAssistantContactResponse: + type: object + properties: + ContactId: + $ref: "#/components/schemas/ContactId" + description: The identifier of the contact within the Connect Customer instance. + ParticipantId: + $ref: "#/components/schemas/ParticipantId" + description: The identifier of the chat participant. The participant identifier remains the same throughout the chat lifecycle. + ParticipantToken: + $ref: "#/components/schemas/ParticipantToken" + description: The token that the chat participant uses with the CreateParticipantConnection operation. The token remains valid for the lifetime of the chat participant. + ContinuedFromContactId: + $ref: "#/components/schemas/ContactId" + description: The identifier of the contact from which the chat continues, returned only for persistent chats. StartAttachedFileUploadResponse: description: Response from StartAttachedFileUpload API. type: object @@ -25992,33 +28085,10 @@ components: enum: - INCREMENTAL - COMPLETE - ChatMessage: - description: A chat message. - type: object - properties: - ContentType: - $ref: "#/components/schemas/ChatContentType" - description: The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response. - Content: - $ref: "#/components/schemas/ChatContent" - description: The content of the chat message. For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024. For application/json, the Length Constraints are Minimum of 1, Maximum of 12000. For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288. - required: - - ContentType - - Content ChatDurationInMinutes: type: integer minimum: 60 maximum: 10080 - PersistentChat: - description: Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat. - type: object - properties: - RehydrationType: - $ref: "#/components/schemas/RehydrationType" - description: "The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field. The actual contactId used for rehydration is provided in the response of this API." - SourceContactId: - $ref: "#/components/schemas/ContactId" - description: The contactId from which a persistent chat session must be started. CustomerIdNonEmpty: type: string minLength: 1 @@ -26036,16 +28106,147 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of this contact within the Amazon Connect instance. - ParticipantId: - $ref: "#/components/schemas/ParticipantId" - description: The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle. - ParticipantToken: - $ref: "#/components/schemas/ParticipantToken" - description: The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant. - ContinuedFromContactId: - $ref: "#/components/schemas/ContactId" - description: The contactId from which a persistent chat session is started. This field is populated only for persistent chats. + description: The identifier of this contact within the Connect Customer instance. + ParticipantId: + $ref: "#/components/schemas/ParticipantId" + description: The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle. + ParticipantToken: + $ref: "#/components/schemas/ParticipantToken" + description: The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant. + ContinuedFromContactId: + $ref: "#/components/schemas/ContactId" + description: The contactId from which a persistent chat session is started. This field is populated only for persistent chats. + AnalyticsModes: + type: array + items: + $ref: "#/components/schemas/AnalyticsMode" + AnalyticsMode: + type: string + enum: + - PostContact + - RealTime + - ContactLens + - AutomatedInteraction + AnalyticsConfiguration: + description: The configuration for conversational analytics. + type: object + properties: + LanguageConfiguration: + $ref: "#/components/schemas/LanguageConfiguration" + description: The language configuration for conversational analytics. + RedactionConfiguration: + $ref: "#/components/schemas/RedactionConfiguration" + description: The redaction configuration for conversational analytics. + SentimentConfiguration: + $ref: "#/components/schemas/SentimentConfiguration" + description: The sentiment configuration for conversational analytics. + SummaryConfiguration: + $ref: "#/components/schemas/SummaryConfiguration" + description: The summary configuration for conversational analytics. + RulesConfiguration: + $ref: "#/components/schemas/RulesConfiguration" + description: The rules configuration for conversational analytics. + required: + - LanguageConfiguration + - RedactionConfiguration + - SentimentConfiguration + - SummaryConfiguration + - RulesConfiguration + LanguageConfiguration: + description: The language configuration for conversational analytics. + type: object + properties: + LanguageLocale: + $ref: "#/components/schemas/LanguageLocale" + description: The language locale setting for conversational analytics. + LanguageLocale: + type: string + RedactionConfiguration: + description: The redaction configuration for conversational analytics. + type: object + properties: + Behavior: + $ref: "#/components/schemas/Behavior" + description: "Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable." + Policy: + $ref: "#/components/schemas/Policy" + description: "The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal." + Entities: + $ref: "#/components/schemas/Entities" + description: The list of PII entity types to redact from the transcript (for example, NAME, ADDRESS, CREDIT_DEBIT_NUMBER). + MaskMode: + $ref: "#/components/schemas/MaskMode" + description: "The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME])." + required: + - Behavior + - Policy + Behavior: + type: string + enum: + - Enable + - Disable + Policy: + type: string + enum: + - None + - RedactedOnly + - RedactedAndOriginal + Entities: + type: array + items: + $ref: "#/components/schemas/Entity" + Entity: + type: string + minLength: 1 + MaskMode: + type: string + enum: + - PII + - EntityType + SentimentConfiguration: + description: The sentiment configuration for conversational analytics. + type: object + properties: + Behavior: + $ref: "#/components/schemas/Behavior" + description: "Controls whether sentiment analysis is applied to the analytics output. Valid values: Enable | Disable." + required: + - Behavior + SummaryConfiguration: + description: The summary configuration for conversational analytics. + type: object + properties: + SummaryModes: + $ref: "#/components/schemas/SummaryModes" + description: "The summary modes that determine what type of summarization is generated. Valid values: PostContact | AutomatedInteraction | ContactChain." + required: + - SummaryModes + SummaryModes: + type: array + items: + $ref: "#/components/schemas/SummaryMode" + SummaryMode: + type: string + enum: + - PostContact + - AutomatedInteraction + - ContactChain + RulesConfiguration: + description: The rules configuration for conversational analytics. Controls whether Contact Lens rules are evaluated against the analytics output. + type: object + properties: + Behavior: + $ref: "#/components/schemas/Behavior" + description: "Controls whether Contact Lens rules are evaluated for the contact. Valid values: Enable | Disable." + StartContactConversationalAnalyticsJobResponse: + type: object + properties: + InstanceId: + $ref: "#/components/schemas/InstanceId" + description: The identifier of the Connect Customer instance. + ContactId: + $ref: "#/components/schemas/ContactId" + description: The identifier of the contact. AutoEvaluationConfiguration: description: Configuration information about automated evaluations. type: object @@ -26185,19 +28386,35 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of this contact within the Amazon Connect instance. + description: The identifier of this contact within the Connect Customer instance. + StartEvaluationFormValidationResponse: + type: object + properties: + EvaluationFormId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for the evaluation form. + EvaluationFormArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) for the evaluation form resource. + EvaluationFormVersion: + $ref: "#/components/schemas/VersionNumber" + description: A version of the evaluation form. + required: + - EvaluationFormId + - EvaluationFormArn + - EvaluationFormVersion StartOutboundChatContactResponse: type: object properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of this contact within the Amazon Connect instance. + description: The identifier of this contact within the Connect Customer instance. StartOutboundEmailContactResponse: type: object properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. AnswerMachineDetectionConfig: description: Configuration of the answering machine detection. type: object @@ -26217,7 +28434,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of this contact within the Amazon Connect instance. + description: The identifier of this contact within the Connect Customer instance. StartScreenSharingResponse: type: object TaskAttachments: @@ -26242,7 +28459,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of this contact within the Amazon Connect instance. + description: The identifier of this contact within the Connect Customer instance. StartTestCaseExecutionResponse: type: object properties: @@ -26272,7 +28489,7 @@ components: description: Information required for the client application (mobile application or website) to connect to the call. ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. ParticipantId: $ref: "#/components/schemas/ParticipantId" description: The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle. @@ -26362,7 +28579,7 @@ components: MeetingId: type: string DisconnectReason: - description: Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field. + description: Contains details about why a contact was disconnected. Only Connect Customer outbound campaigns can provide this field. type: object properties: Code: @@ -26392,7 +28609,7 @@ components: properties: ConnectUserArn: $ref: "#/components/schemas/ARN" - description: Represents the Amazon Connect ARN of the user. + description: Represents the Connect Customer ARN of the user. SubmitContactEvaluationResponse: type: object properties: @@ -26417,7 +28634,7 @@ components: properties: ContactId: $ref: "#/components/schemas/ContactId" - description: The identifier of the contact in this instance of Amazon Connect. + description: The identifier of the contact in this instance of Connect Customer. ContactArn: $ref: "#/components/schemas/ARN" description: The Amazon Resource Name (ARN) of the contact. @@ -26445,7 +28662,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. + description: The identifier of the Connect Customer instance. AttachmentScope: $ref: "#/components/schemas/AttachmentScope" description: The scope of the attachment. @@ -26502,7 +28719,7 @@ components: properties: Steps: $ref: "#/components/schemas/RoutingCriteriaInputSteps" - description: When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. + description: When Connect Customer does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. RoutingCriteriaInputSteps: type: array items: @@ -26528,6 +28745,8 @@ components: type: object UpdateContactScheduleResponse: type: object + UpdateContactTaskTemplateResponse: + type: object UpdateDataTableAttributeResponse: type: object properties: @@ -26581,10 +28800,16 @@ components: - EvaluationFormId - EvaluationFormArn - EvaluationFormVersion + UpdateExtractionDefinitionResponse: + type: object UpdateHoursOfOperationDescription: type: string minLength: 0 maxLength: 250 + UpdateMetricContentResponse: + type: object + UpdateMetricMetadataResponse: + type: object UpdateNotificationContentResponse: description: The response from updating notification content. type: object @@ -26698,7 +28923,7 @@ components: properties: InstanceId: $ref: "#/components/schemas/InstanceId" - description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. + description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Id: $ref: "#/components/schemas/TaskTemplateId" description: The identifier of the task template resource. @@ -26719,7 +28944,7 @@ components: description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. Constraints: $ref: "#/components/schemas/TaskTemplateConstraints" - description: Constraints that are applicable to the fields listed. + description: Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields. Defaults: $ref: "#/components/schemas/TaskTemplateDefaults" description: The default values for fields when a task is created by referencing this template. @@ -26880,6 +29105,17 @@ components: config: requestBodyTranslate: algorithm: naive + start_evaluation_form_validation: + operation: + $ref: "#/paths/~1evaluation-forms~1{instance_id}~1{evaluation_form_id}~1validate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/evaluation_forms/methods/describe_evaluation_form" @@ -26967,6 +29203,17 @@ components: response: openAPIDocKey: "200" mediaType: application/json + create_auth_code: + operation: + $ref: "#/paths/~1auth~1code~1{instance_id}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive create_instance: operation: $ref: "#/paths/~1instance/put" @@ -27049,6 +29296,12 @@ components: mediaType: application/json request: nativeCasing: pascal + delete_session: + operation: + $ref: "#/paths/~1auth~1sessions~1{instance_id}~1{session_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json disassociate_flow: operation: $ref: "#/paths/~1flow-associations~1{instance_id}~1{resource_id}~1{resource_type}/delete" @@ -27132,6 +29385,28 @@ components: config: requestBodyTranslate: algorithm: naive + send_outbound_web_notification: + operation: + $ref: "#/paths/~1instance~1{instance_id}~1outbound-web-notification/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + start_assistant_contact: + operation: + $ref: "#/paths/~1contact~1assistant/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive start_email_contact: operation: $ref: "#/paths/~1contact~1email/put" @@ -27227,6 +29502,7 @@ components: insert: - $ref: "#/components/x-stackQL-resources/instances/methods/create_push_notification_registration" - $ref: "#/components/x-stackQL-resources/instances/methods/create_persistent_contact_association" + - $ref: "#/components/x-stackQL-resources/instances/methods/create_auth_code" - $ref: "#/components/x-stackQL-resources/instances/methods/create_instance" - $ref: "#/components/x-stackQL-resources/instances/methods/create_participant" update: @@ -27237,6 +29513,7 @@ components: - $ref: "#/components/x-stackQL-resources/instances/methods/update_participant_authentication" delete: - $ref: "#/components/x-stackQL-resources/instances/methods/delete_push_notification_registration" + - $ref: "#/components/x-stackQL-resources/instances/methods/delete_session" - $ref: "#/components/x-stackQL-resources/instances/methods/delete_instance" analytics_data_associations: id: aws.connect.analytics_data_associations @@ -28832,10 +31109,22 @@ components: mediaType: application/json request: nativeCasing: pascal + create_attached_file: + operation: + $ref: "#/paths/~1attached-files~1{instance_id}~1files/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/attached_files/methods/get_attached_file" - insert: [] + insert: + - $ref: "#/components/x-stackQL-resources/attached_files/methods/create_attached_file" update: [] delete: - $ref: "#/components/x-stackQL-resources/attached_files/methods/delete_attached_file" @@ -28991,6 +31280,17 @@ components: config: requestBodyTranslate: algorithm: naive + delete_contact_data: + operation: + $ref: "#/paths/~1contact~1delete~1{instance_id}~1{contact_id}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive describe_contact: operation: $ref: "#/paths/~1contacts~1{instance_id}~1{contact_id}/get" @@ -29050,6 +31350,17 @@ components: location: body requestBodyTranslate: algorithm: naive + start_contact_conversational_analytics_job: + operation: + $ref: "#/paths/~1contact~1start-conversational-analytics-job~1{instance_id}~1{contact_id}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive start_contact_media_processing: operation: $ref: "#/paths/~1contact~1start-contact-media-processing/post" @@ -29169,7 +31480,8 @@ components: - $ref: "#/components/x-stackQL-resources/contacts/methods/update_contact_schedule" - $ref: "#/components/x-stackQL-resources/contacts/methods/update_contact" - $ref: "#/components/x-stackQL-resources/contacts/methods/update_queue_max_contacts" - delete: [] + delete: + - $ref: "#/components/x-stackQL-resources/contacts/methods/delete_contact_data" contact_flow_modules: id: aws.connect.contact_flow_modules name: contact_flow_modules @@ -29480,6 +31792,73 @@ components: - $ref: "#/components/x-stackQL-resources/data_table_attributes/methods/update_data_table_attribute" delete: - $ref: "#/components/x-stackQL-resources/data_table_attributes/methods/delete_data_table_attribute" + extraction_definitions: + id: aws.connect.extraction_definitions + name: extraction_definitions + title: extraction_definitions + methods: + create_extraction_definition: + operation: + $ref: "#/paths/~1extraction-definitions~1{instance_id}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_extraction_definitions: + operation: + $ref: "#/paths/~1extraction-definitions~1{instance_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ExtractionDefinitionSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.NextToken + location: body + delete_extraction_definition: + operation: + $ref: "#/paths/~1extraction-definitions~1{instance_id}~1{extraction_definition_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_extraction_definition: + operation: + $ref: "#/paths/~1extraction-definitions~1{instance_id}~1{extraction_definition_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ExtractionDefinition + update_extraction_definition: + operation: + $ref: "#/paths/~1extraction-definitions~1{instance_id}~1{extraction_definition_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/extraction_definitions/methods/describe_extraction_definition" + - $ref: "#/components/x-stackQL-resources/extraction_definitions/methods/list_extraction_definitions" + insert: + - $ref: "#/components/x-stackQL-resources/extraction_definitions/methods/create_extraction_definition" + update: + - $ref: "#/components/x-stackQL-resources/extraction_definitions/methods/update_extraction_definition" + delete: + - $ref: "#/components/x-stackQL-resources/extraction_definitions/methods/delete_extraction_definition" hours_of_operation_overrides: id: aws.connect.hours_of_operation_overrides name: hours_of_operation_overrides @@ -29611,6 +31990,104 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/integration_associations/methods/delete_integration_association" + metrics: + id: aws.connect.metrics + name: metrics + title: metrics + methods: + create_metric: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_metrics: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.MetricSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.NextToken + location: body + delete_metric: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}~1{metric_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_metric: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}~1{metric_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Metric + search_metrics: + operation: + $ref: "#/paths/~1search-metrics/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Metrics + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_metric_content: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}~1{metric_id}~1content/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_metric_metadata: + operation: + $ref: "#/paths/~1metrics~1definitions~1{instance_id}~1{metric_id}~1metadata/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/metrics/methods/describe_metric" + - $ref: "#/components/x-stackQL-resources/metrics/methods/list_metrics" + - $ref: "#/components/x-stackQL-resources/metrics/methods/search_metrics" + insert: + - $ref: "#/components/x-stackQL-resources/metrics/methods/create_metric" + update: + - $ref: "#/components/x-stackQL-resources/metrics/methods/update_metric_content" + delete: + - $ref: "#/components/x-stackQL-resources/metrics/methods/delete_metric" notifications: id: aws.connect.notifications name: notifications @@ -30248,10 +32725,30 @@ components: config: requestBodyTranslate: algorithm: naive + search_rules: + operation: + $ref: "#/paths/~1search-rules/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Rules + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/rules/methods/describe_rule" - $ref: "#/components/x-stackQL-resources/rules/methods/list_rules" + - $ref: "#/components/x-stackQL-resources/rules/methods/search_rules" insert: - $ref: "#/components/x-stackQL-resources/rules/methods/create_rule" update: @@ -30316,6 +32813,17 @@ components: config: requestBodyTranslate: algorithm: naive + update_contact_task_template: + operation: + $ref: "#/paths/~1contact~1task-template/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/task_templates/methods/get_task_template" @@ -30323,6 +32831,7 @@ components: insert: - $ref: "#/components/x-stackQL-resources/task_templates/methods/create_task_template" update: + - $ref: "#/components/x-stackQL-resources/task_templates/methods/update_contact_task_template" - $ref: "#/components/x-stackQL-resources/task_templates/methods/update_task_template" delete: - $ref: "#/components/x-stackQL-resources/task_templates/methods/delete_task_template" @@ -31366,6 +33875,25 @@ components: insert: [] update: [] delete: [] + evaluation_form_validations: + id: aws.connect.evaluation_form_validations + name: evaluation_form_validations + title: evaluation_form_validations + methods: + get_evaluation_form_validation: + operation: + $ref: "#/paths/~1evaluation-forms~1{instance_id}~1{evaluation_form_id}~1validation-results/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/evaluation_form_validations/methods/get_evaluation_form_validation" + insert: [] + update: [] + delete: [] federation_tokens: id: aws.connect.federation_tokens name: federation_tokens diff --git a/providers/src/aws/v00.00.00000/services/connectcampaignsv2.yaml b/providers/src/aws/v00.00.00000/services/connectcampaignsv2.yaml index 0b1b22fe..bfb600c7 100644 --- a/providers/src/aws/v00.00.00000/services/connectcampaignsv2.yaml +++ b/providers/src/aws/v00.00.00000/services/connectcampaignsv2.yaml @@ -898,15 +898,71 @@ components: type: number format: double minimum: 0 - maximum: 1 + maximum: 2 PredictiveConfig: description: Predictive config type: object properties: bandwidthAllocation: $ref: "#/components/schemas/BandwidthAllocation" + pacingStrategies: + $ref: "#/components/schemas/PacingStrategyList" + description: Pacing strategies the dialer enforces simultaneously. required: - bandwidthAllocation + PacingStrategyList: + description: List of pacing strategies the dialer enforces simultaneously. + type: array + items: + $ref: "#/components/schemas/PacingStrategy" + PacingStrategy: + description: Pacing constraint the dialer may enforce. + type: object + properties: + abandonmentRate: + $ref: "#/components/schemas/AbandonmentRatePacingConfig" + AbandonmentRatePacingConfig: + description: Configuration for abandonment-rate-based dialer throttling. + type: object + properties: + targetRate: + $ref: "#/components/schemas/TargetRate" + connectionStartPoint: + $ref: "#/components/schemas/ConnectionStartPoint" + description: Event from which connectionThresholdSeconds is measured. + connectionThresholdSeconds: + $ref: "#/components/schemas/AbandonmentRatePacingConfigConnectionThresholdSecondsInteger" + description: Seconds after connectionStartPoint before a contact counts as abandoned. + evaluationWindow: + $ref: "#/components/schemas/EvaluationWindow" + description: Rolling window over which abandonmentRate is computed. + required: + - targetRate + - connectionStartPoint + - connectionThresholdSeconds + - evaluationWindow + TargetRate: + description: Target abandonment rate. + type: number + format: double + minimum: 0 + maximum: 1 + ConnectionStartPoint: + description: Reference point against which the connection threshold is measured. + type: string + enum: + - CONNECTED_TO_SYSTEM + - GREETING_START + - GREETING_END + AbandonmentRatePacingConfigConnectionThresholdSecondsInteger: + type: integer + minimum: 1 + EvaluationWindow: + description: Rolling window over which abandonmentRate is computed. Range PT1H to PT24H. + type: string + minLength: 0 + maxLength: 5 + pattern: PT([1-9]|1[0-9]|2[0-4])H AgentlessConfig: description: Agentless config type: object @@ -1951,6 +2007,8 @@ components: $ref: "#/components/schemas/ProfileId" expirationTime: $ref: "#/components/schemas/TimeStamp" + eventTriggerContext: + $ref: "#/components/schemas/EventTriggerContext" required: - clientToken - profileId @@ -1958,6 +2016,42 @@ components: description: Identifier of the customer profile type: string pattern: "[a-f0-9]{32}" + EventTriggerContext: + description: Event trigger context data + type: object + properties: + sourceEvent: + $ref: "#/components/schemas/SourceEvent" + channelContext: + $ref: "#/components/schemas/ChannelContext" + SourceEvent: + description: Source event object for event triggers + type: string + minLength: 1 + ChannelContext: + description: Additional metadata related to the event trigger context + type: object + properties: + webNotificationContext: + $ref: "#/components/schemas/WebNotificationContext" + WebNotificationContext: + description: Context metadata for the web notification type channel + type: object + properties: + sessionId: + $ref: "#/components/schemas/SessionId" + browserId: + $ref: "#/components/schemas/BrowserId" + SessionId: + description: Session Id for web notification event trigger + type: string + minLength: 1 + maxLength: 36 + BrowserId: + description: Browser Id for web notification event trigger + type: string + minLength: 1 + maxLength: 36 PutProfileOutboundRequestBatchResponse: description: The response for PutProfileOutboundRequestBatch API type: object diff --git a/providers/src/aws/v00.00.00000/services/connecthealth.yaml b/providers/src/aws/v00.00.00000/services/connecthealth.yaml index 73494c9c..8517b4e2 100644 --- a/providers/src/aws/v00.00.00000/services/connecthealth.yaml +++ b/providers/src/aws/v00.00.00000/services/connecthealth.yaml @@ -1233,6 +1233,9 @@ components: properties: audioEvent: $ref: "#/components/schemas/MedicalScribeAudioEvent" + binaryAudioEvent: + $ref: "#/components/schemas/MedicalScribeBinaryAudioEvent" + description: An event containing raw binary audio data for the Medical Scribe stream. The audio is sent as a raw binary payload rather than as a base64-encoded value. sessionControlEvent: $ref: "#/components/schemas/MedicalScribeSessionControlEvent" configurationEvent: @@ -1249,6 +1252,15 @@ components: AudioChunk: type: string format: byte + MedicalScribeBinaryAudioEvent: + description: An event containing raw binary audio data for the Medical Scribe stream. The audio is sent as a raw binary payload rather than as a base64-encoded value. + type: object + properties: + audioChunk: + $ref: "#/components/schemas/AudioChunk" + description: The raw binary audio data chunk + required: + - audioChunk MedicalScribeSessionControlEvent: description: An event for controlling the Medical Scribe session type: object @@ -1348,7 +1360,7 @@ components: pattern: "[a-zA-Z0-9]+" SensitiveMarkdownString: type: string - pattern: "[a-zA-Z0-9\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~/]+" + pattern: "[\\p{L}\\p{N}\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~/|+=&%@\\\\{}^]+" EncounterContext: description: Context information about the clinical encounter type: object diff --git a/providers/src/aws/v00.00.00000/services/connectparticipant.yaml b/providers/src/aws/v00.00.00000/services/connectparticipant.yaml index f08a97ff..4a3a414a 100644 --- a/providers/src/aws/v00.00.00000/services/connectparticipant.yaml +++ b/providers/src/aws/v00.00.00000/services/connectparticipant.yaml @@ -49,7 +49,7 @@ paths: /participant/complete-attachment-upload: post: operationId: CompleteAttachmentUpload - description: Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -81,7 +81,7 @@ paths: /participant/connection: post: operationId: CreateParticipantConnection - description: "Creates the participant's connection. For security recommendations, see Amazon Connect Chat security best practices. For WebRTC security recommendations, see Amazon Connect WebRTC security best practices. ParticipantToken is used for invoking this API instead of ConnectionToken. The participant token is valid for the lifetime of the participant – until they are part of a contact. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created using the CreateParticipant API. For WEBSOCKET Type: The response URL for has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. For chat, you need to publish the following on the established websocket connection: {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}} Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before. The expiry time for the connection token is different than the ChatDurationInMinutes. Expiry time for the connection token is 1 day. For WEBRTC_CONNECTION Type: The response includes connection data required for the client application to join the call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains Meeting and Attendee information needed to establish the media connection. The attendee join token in WebRTCConnection response is valid for the lifetime of the participant in the call. If a participant leaves or is disconnected for 60 seconds, their participant credentials will no longer be valid, and a new participant will need to be created to rejoin the call. Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide. Multi-user web, in-app, video calling support: For WebRTC calls, this API is used in conjunction with the CreateParticipant API to enable multi-party calling. The StartWebRTCContact API creates the initial contact and routes it to an agent, while CreateParticipant adds additional participants to the ongoing call. For more information about multi-party WebRTC calls, see Enable multi-user web, in-app, and video calling in the Amazon Connect Administrator Guide. Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant or maximum number of WebRTC participants, see Feature specifications in the Amazon Connect Administrator Guide. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication." + description: "Creates the participant's connection. For security recommendations, see Connect Customer Chat security best practices. For WebRTC security recommendations, see Connect Customer WebRTC security best practices. ParticipantToken is used for invoking this API instead of ConnectionToken. The participant token is valid for the lifetime of the participant – until they are part of a contact. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created using the CreateParticipant API. For WEBSOCKET Type: The response URL for has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. For chat, you need to publish the following on the established websocket connection: {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}} Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before. The expiry time for the connection token is different than the ChatDurationInMinutes. Expiry time for the connection token is 1 day. For WEBRTC_CONNECTION Type: The response includes connection data required for the client application to join the call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains Meeting and Attendee information needed to establish the media connection. The attendee join token in WebRTCConnection response is valid for the lifetime of the participant in the call. If a participant leaves or is disconnected for 60 seconds, their participant credentials will no longer be valid, and a new participant will need to be created to rejoin the call. Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide. Multi-user web, in-app, video calling support: For WebRTC calls, this API is used in conjunction with the CreateParticipant API to enable multi-party calling. The StartWebRTCContact API creates the initial contact and routes it to an agent, while CreateParticipant adds additional participants to the ongoing call. For more information about multi-party WebRTC calls, see Enable multi-user web, in-app, and video calling in the Amazon Connect Administrator Guide. Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant or maximum number of WebRTC participants, see Feature specifications in the Amazon Connect Administrator Guide. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication." parameters: - name: X-Amz-Bearer in: header @@ -110,7 +110,7 @@ paths: /participant/views/{view_token}: get: operationId: DescribeView - description: Retrieves the view for the specified view token. For security recommendations, see Amazon Connect Chat security best practices. + description: Retrieves the view for the specified view token. For security recommendations, see Connect Customer Chat security best practices. parameters: - name: view_token in: path @@ -134,7 +134,7 @@ paths: /participant/disconnect: post: operationId: DisconnectParticipant - description: Disconnects a participant. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Disconnects a participant. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -161,7 +161,7 @@ paths: /participant/attachment: post: operationId: GetAttachment - description: Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see Amazon Connect Chat security best practices. The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see Connect Customer Chat security best practices. The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -192,7 +192,7 @@ paths: /participant/authentication-url: post: operationId: GetAuthenticationUrl - description: Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Amazon Connect Chat security best practices. This API can only be called within one minute of receiving the authenticationInitiated event. The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Connect Customer Chat security best practices. This API can only be called within one minute of receiving the authenticationInitiated event. The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -224,7 +224,7 @@ paths: /participant/transcript: post: operationId: GetTranscript - description: "Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat. For security recommendations, see Amazon Connect Chat security best practices. If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session: application/vnd.amazonaws.connect.event.participant.invited application/vnd.amazonaws.connect.event.participant.joined application/vnd.amazonaws.connect.event.participant.left application/vnd.amazonaws.connect.event.chat.ended application/vnd.amazonaws.connect.event.transfer.succeeded application/vnd.amazonaws.connect.event.transfer.failed ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication." + description: "Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat. For security recommendations, see Connect Customer Chat security best practices. If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session: application/vnd.amazonaws.connect.event.participant.invited application/vnd.amazonaws.connect.event.participant.joined application/vnd.amazonaws.connect.event.participant.left application/vnd.amazonaws.connect.event.chat.ended application/vnd.amazonaws.connect.event.transfer.succeeded application/vnd.amazonaws.connect.event.transfer.failed ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication." parameters: - name: X-Amz-Bearer in: header @@ -261,7 +261,7 @@ paths: /participant/event: post: operationId: SendEvent - description: The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field. Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field. Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -294,7 +294,7 @@ paths: /participant/message: post: operationId: SendMessage - description: Sends a message. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Sends a message. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header @@ -328,7 +328,7 @@ paths: /participant/start-attachment-upload: post: operationId: StartAttachmentUpload - description: Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. + description: Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. parameters: - name: X-Amz-Bearer in: header diff --git a/providers/src/aws/v00.00.00000/services/controlcatalog.yaml b/providers/src/aws/v00.00.00000/services/controlcatalog.yaml index c5e17668..12e7a728 100644 --- a/providers/src/aws/v00.00.00000/services/controlcatalog.yaml +++ b/providers/src/aws/v00.00.00000/services/controlcatalog.yaml @@ -271,6 +271,9 @@ components: Implementation: $ref: "#/components/schemas/ImplementationDetails" description: Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control. + ParameterRequirementSummary: + $ref: "#/components/schemas/ParameterRequirementSummary" + description: A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control. Parameters: $ref: "#/components/schemas/ControlParameters" description: Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters. @@ -279,7 +282,10 @@ components: description: A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services. GovernedResources: $ref: "#/components/schemas/GovernedResources" - description: A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources cannot be represented by available CloudFormation resource types, it’s returned as an empty list. + description: A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list. + GovernedProviders: + $ref: "#/components/schemas/GovernedProviders" + description: A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources. required: - Arn - Name @@ -354,6 +360,12 @@ components: minLength: 1 maxLength: 256 pattern: "[a-zA-Z0-9_\\.-]+" + ParameterRequirementSummary: + type: string + enum: + - REQUIRED + - OPTIONAL + - NONE ControlParameters: type: array items: @@ -365,8 +377,16 @@ components: Name: $ref: "#/components/schemas/String" description: The parameter name. This name is the parameter key when you call EnableControl or UpdateEnabledControl . + Requirement: + $ref: "#/components/schemas/ControlParameterRequirement" + description: Indicates whether the parameter is required or optional when you enable the control. required: - Name + ControlParameterRequirement: + type: string + enum: + - REQUIRED + - OPTIONAL Timestamp: type: string format: date-time @@ -376,7 +396,16 @@ components: $ref: "#/components/schemas/GovernedResource" GovernedResource: type: string - pattern: "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}" + pattern: "[A-Za-z0-9][A-Za-z0-9.:/_-]{1,254}" + GovernedProviders: + type: array + items: + $ref: "#/components/schemas/GovernedProvider" + GovernedProvider: + type: string + minLength: 2 + maxLength: 64 + pattern: "[A-Z]{2,64}" MaxListCommonControlsResults: type: integer minimum: 1 @@ -625,6 +654,9 @@ components: Implementations: $ref: "#/components/schemas/ImplementationFilter" description: A filter that narrows the results to controls with specific implementation types or identifiers. This field allows you to find controls that are implemented by specific Amazon Web Services services or with specific service identifiers. + GovernedProviders: + $ref: "#/components/schemas/GovernedProviderFilterList" + description: A filter that narrows the results to controls that govern a specific provider's resources. ImplementationFilter: description: A structure that defines filtering criteria for control implementations. You can use this filter to find controls that are implemented by specific Amazon Web Services services or with specific service identifiers. type: object @@ -643,6 +675,10 @@ components: type: array items: $ref: "#/components/schemas/ImplementationIdentifier" + GovernedProviderFilterList: + type: array + items: + $ref: "#/components/schemas/GovernedProvider" ListControlsResponse: type: object properties: @@ -680,6 +716,9 @@ components: Severity: $ref: "#/components/schemas/ControlSeverity" description: "An enumerated type, with the following possible values:" + ParameterRequirementSummary: + $ref: "#/components/schemas/ParameterRequirementSummary" + description: A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control. Implementation: $ref: "#/components/schemas/ImplementationSummary" description: An object of type ImplementationSummary that describes how the control is implemented. @@ -688,7 +727,10 @@ components: description: A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services. GovernedResources: $ref: "#/components/schemas/GovernedResources" - description: A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources cannot be represented by available CloudFormation resource types, it’s returned as an empty list. + description: A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list. + GovernedProviders: + $ref: "#/components/schemas/GovernedProviders" + description: A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources. required: - Arn - Name diff --git a/providers/src/aws/v00.00.00000/services/cost_optimization_hub.yaml b/providers/src/aws/v00.00.00000/services/cost_optimization_hub.yaml index 97559629..456d7b40 100644 --- a/providers/src/aws/v00.00.00000/services/cost_optimization_hub.yaml +++ b/providers/src/aws/v00.00.00000/services/cost_optimization_hub.yaml @@ -516,6 +516,12 @@ components: - DynamoDbReservedCapacity - MemoryDbReservedInstances - NatGateway + - DynamoDBTable + - ElastiCacheCluster + - MemoryDBCluster + - DocumentDBCluster + - WorkSpaces + - SageMakerEndpoint Source: type: string enum: @@ -606,6 +612,24 @@ components: natGateway: $ref: "#/components/schemas/NatGateway" description: The NAT Gateway recommendation details. + dynamoDbTable: + $ref: "#/components/schemas/DynamoDbTable" + description: The DynamoDB table recommendation details. + elastiCacheCluster: + $ref: "#/components/schemas/ElastiCacheCluster" + description: The ElastiCache cluster recommendation details. + memoryDbCluster: + $ref: "#/components/schemas/MemoryDbCluster" + description: The MemoryDB cluster recommendation details. + documentDbCluster: + $ref: "#/components/schemas/DocumentDbCluster" + description: The Amazon DocumentDB cluster recommendation details. + workSpaces: + $ref: "#/components/schemas/WorkSpaces" + description: The WorkSpaces recommendation details. + sageMakerEndpoint: + $ref: "#/components/schemas/SageMakerEndpoint" + description: The SageMaker endpoint recommendation details. LambdaFunction: description: The Lambda function recommendation details. type: object @@ -1426,6 +1450,42 @@ components: Long: type: integer format: int64 + DynamoDbTable: + description: The DynamoDB table recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" + ElastiCacheCluster: + description: The ElastiCache cluster recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" + MemoryDbCluster: + description: The MemoryDB cluster recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" + DocumentDbCluster: + description: The Amazon DocumentDB cluster recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" + WorkSpaces: + description: The WorkSpaces recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" + SageMakerEndpoint: + description: The SageMaker endpoint recommendation details. + type: object + properties: + costCalculation: + $ref: "#/components/schemas/ResourceCostCalculation" TagList: type: array items: @@ -1462,7 +1522,7 @@ components: ListEfficiencyMetricsRequestMaxResultsInteger: type: integer minimum: 0 - maximum: 100 + maximum: 1000 OrderBy: description: Defines how rows will be sorted in the response. type: object diff --git a/providers/src/aws/v00.00.00000/services/customer_profiles.yaml b/providers/src/aws/v00.00.00000/services/customer_profiles.yaml index d4aa5e12..53bc4f30 100644 --- a/providers/src/aws/v00.00.00000/services/customer_profiles.yaml +++ b/providers/src/aws/v00.00.00000/services/customer_profiles.yaml @@ -117,6 +117,37 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetProfileResponse" + /domains/{domain_name}/profiles/objects/batch-put-profile-object: + put: + operationId: BatchPutProfileObject + description: Adds multiple profile objects to a domain of a given ObjectType in a single API call. When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile. When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition. BatchPutProfileObject needs an ObjectType, which can be created using PutProfileObjectType. + parameters: + - name: domain_name + in: path + required: true + schema: + $ref: "#/components/schemas/name" + description: The unique name of the domain. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ObjectTypeName: + $ref: "#/components/schemas/typeName" + Items: + $ref: "#/components/schemas/BatchPutProfileObjectRequestItemList" + required: + - ObjectTypeName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchPutProfileObjectResponse" /domains/{domain_name}/calculated-attributes/{calculated_attribute_name}: post: operationId: CreateCalculatedAttributeDefinition @@ -251,7 +282,7 @@ paths: /domains/{domain_name}: post: operationId: CreateDomain - description: "Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. Use this API or UpdateDomain to enable identity resolution: set Matching to true. To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply. It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain." + description: "Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations. Each Connect Customer instance can be associated with only one domain. Multiple Connect Customer instances can be associated with one domain. Use this API or UpdateDomain to enable identity resolution: set Matching to true. To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply. It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain." parameters: - name: domain_name in: path @@ -496,7 +527,7 @@ paths: /domains/{domain_name}/event-streams/{event_stream_name}: post: operationId: CreateEventStream - description: Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain + description: Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain parameters: - name: domain_name in: path @@ -1023,6 +1054,8 @@ paths: $ref: "#/components/schemas/sensitiveText" RecommenderConfig: $ref: "#/components/schemas/RecommenderConfig" + RecommenderVersionName: + $ref: "#/components/schemas/RecommenderVersionName" responses: "200": description: Success @@ -2191,6 +2224,8 @@ paths: $ref: "#/components/schemas/maxSize500" MetadataConfig: $ref: "#/components/schemas/MetadataConfig" + DiversityConfig: + $ref: "#/components/schemas/RecommendationDiversityConfig" required: - RecommenderName responses: @@ -3820,6 +3855,81 @@ components: type: array items: $ref: "#/components/schemas/ContactPreference" + BatchPutProfileObjectRequestItemList: + type: array + items: + $ref: "#/components/schemas/BatchPutProfileObjectRequestItem" + BatchPutProfileObjectRequestItem: + description: An item to add to the domain as part of a batch request. + type: object + properties: + Id: + $ref: "#/components/schemas/name" + description: A unique identifier for this item in the batch request. Used to correlate items in the response. + Object: + $ref: "#/components/schemas/stringifiedJson" + description: A string that is serialized from a JSON object. + required: + - Id + - Object + stringifiedJson: + type: string + minLength: 1 + maxLength: 256000 + BatchPutProfileObjectResponse: + type: object + properties: + Successful: + $ref: "#/components/schemas/BatchPutProfileObjectResponseList" + description: A list of items that were successfully added to the domain. + Failed: + $ref: "#/components/schemas/BatchPutProfileObjectErrorList" + description: A list of items that failed to be added to the domain. + BatchPutProfileObjectResponseList: + type: array + items: + $ref: "#/components/schemas/BatchPutProfileObjectResponseItem" + BatchPutProfileObjectResponseItem: + description: An item that was successfully added to the domain. + type: object + properties: + Id: + $ref: "#/components/schemas/name" + description: The unique identifier of the item in the batch request. + ProfileObjectUniqueKey: + $ref: "#/components/schemas/string1To255" + description: The unique identifier of the profile object generated by the service. + required: + - Id + - ProfileObjectUniqueKey + BatchPutProfileObjectErrorList: + type: array + items: + $ref: "#/components/schemas/BatchPutProfileObjectErrorItem" + BatchPutProfileObjectErrorItem: + description: An item that failed to be added to the domain. + type: object + properties: + Id: + $ref: "#/components/schemas/name" + description: The unique identifier of the item in the batch request that failed. + Code: + $ref: "#/components/schemas/responseCode" + description: The HTTP status code for the error. + Message: + $ref: "#/components/schemas/text" + description: A message describing the error. + required: + - Id + - Code + responseCode: + type: integer + minimum: 200 + maximum: 599 + text: + type: string + minLength: 1 + maxLength: 1000 sensitiveText: type: string minLength: 1 @@ -4071,10 +4181,6 @@ components: type: integer minimum: 0 maximum: 100 - text: - type: string - minLength: 1 - maxLength: 1000 expirationDaysInteger: type: integer minimum: 1 @@ -4331,7 +4437,7 @@ components: description: The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3. RuleBasedMatching: $ref: "#/components/schemas/RuleBasedMatchingResponse" - description: The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. + description: The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. DataStore: $ref: "#/components/schemas/DataStoreResponse" description: The data store. @@ -4582,7 +4688,7 @@ components: $ref: "#/components/schemas/PeriodUnit" description: The unit of time. Value: - $ref: "#/components/schemas/maxSize24" + $ref: "#/components/schemas/maxSize60" description: The amount of time of the specified unit. MaxInvocationsPerProfile: $ref: "#/components/schemas/maxSize1000" @@ -4596,14 +4702,15 @@ components: PeriodUnit: type: string enum: + - MINUTES - HOURS - DAYS - WEEKS - MONTHS - maxSize24: + maxSize60: type: integer minimum: 1 - maximum: 24 + maximum: 60 maxSize1000: type: integer minimum: 1 @@ -5140,14 +5247,21 @@ components: description: Configuration settings for how the recommender processes and uses events. TrainingFrequency: $ref: "#/components/schemas/RecommenderConfigTrainingFrequencyInteger" - description: How often the recommender should retrain its model with new data. + description: How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled. InferenceConfig: $ref: "#/components/schemas/InferenceConfig" description: Configuration settings for how the recommender handles inference requests. IncludedColumns: type: object properties: {} - description: "A map of dataset type to a list of column names to train on. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included and do not need to be specified: Item.Id, ItemList[].Id, EventTimestamp, EventType, and EventValue." + description: "A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request." + ExcludedColumns: + type: object + properties: {} + description: "A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request." + DiversityConfig: + $ref: "#/components/schemas/DiversityConfig" + description: Configuration for diversity-aware recommendations. When set, the recommender applies diversity constraints defined per item column to reduce over-concentration of similar items in the results. EventsConfig: description: Configuration settings that define how events are processed and tracked. type: object @@ -5190,7 +5304,7 @@ components: maximum: 1 RecommenderConfigTrainingFrequencyInteger: type: integer - minimum: 1 + minimum: 0 maximum: 30 InferenceConfig: description: Configuration settings for inference behavior of the recommender. @@ -5202,7 +5316,45 @@ components: InferenceConfigMinProvisionedTPSInteger: type: integer minimum: 1 - maximum: 500 + maximum: 1000 + DiversityConfig: + description: Configuration that controls diversity of recommendation results by capping the representation of specified item columns. + type: object + properties: + DiversityColumns: + $ref: "#/components/schemas/DiversityColumnsList" + description: A list of up to two diversity columns. Each column defines a cap on the number or percentage of recommended items that share the same value for that column. + DiversityColumnsList: + type: array + items: + $ref: "#/components/schemas/DiversityColumn" + DiversityColumn: + description: Defines a diversity constraint for a single item column, specifying a cap type and a target value or placeholder that controls how many recommended items may share the same column value. + type: object + properties: + Name: + $ref: "#/components/schemas/text" + description: The name of the item catalog column on which to apply the diversity cap. The column must be defined in the recommender schema. + CapType: + $ref: "#/components/schemas/DiversityCapType" + description: The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count). + Target: + $ref: "#/components/schemas/DiversityTargetExpression" + description: The diversity cap target. Either an integer literal (for example, "25") or a placeholder expression of the form $name whose value is supplied at inference time through GetProfileRecommendations. + required: + - Name + - CapType + - Target + DiversityCapType: + type: string + enum: + - PERCENTAGE + - VALUE + DiversityTargetExpression: + type: string + minLength: 1 + maxLength: 64 + pattern: (\d+|\$[a-z_]+) CreateRecommenderResponse: type: object properties: @@ -5745,10 +5897,6 @@ components: type: array items: $ref: "#/components/schemas/stringifiedJson" - stringifiedJson: - type: string - minLength: 1 - maxLength: 256000 DetectProfileObjectTypeResponse: type: object properties: @@ -5878,7 +6026,7 @@ components: description: The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3. RuleBasedMatching: $ref: "#/components/schemas/RuleBasedMatchingResponse" - description: The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. + description: The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. DataStore: $ref: "#/components/schemas/DataStoreResponse" description: True if data store is enabled for this domain. @@ -6519,6 +6667,19 @@ components: type: string minLength: 1 maxLength: 150 + RecommendationDiversityConfig: + description: Runtime diversity configuration for a GetProfileRecommendations request. + type: object + properties: + Enabled: + $ref: "#/components/schemas/optionalBoolean" + description: Whether diversity-aware recommendations are enabled for this request. + Values: + type: object + properties: {} + description: An optional map of placeholder name to integer cap value used to resolve $name placeholders defined in the recommender's DiversityConfig at inference time. Up to 2 entries are supported. + required: + - Enabled GetProfileRecommendationsResponse: type: object properties: @@ -6620,6 +6781,9 @@ components: LatestRecommenderUpdate: $ref: "#/components/schemas/RecommenderUpdate" description: Information about the most recent update performed on the recommender, including status and timestamp. + ActiveRecommenderVersionName: + $ref: "#/components/schemas/RecommenderVersionName" + description: The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set. TrainingMetrics: $ref: "#/components/schemas/TrainingMetricsList" description: A set of metrics that provide information about the recommender's training performance and accuracy. @@ -6660,6 +6824,14 @@ components: FailureReason: $ref: "#/components/schemas/String" description: If the update operation failed, provides the reason for the failure. + RecommenderVersionName: + $ref: "#/components/schemas/RecommenderVersionName" + description: The name of the recommender version associated with this update operation. + RecommenderVersionName: + type: string + minLength: 1 + maxLength: 100 + pattern: "[a-zA-Z0-9_-]+/\\d{4}-\\d{2}-\\d{2}T\\d{2}-\\d{2}-\\d{2}Z" TrainingMetricsList: type: array items: @@ -6675,6 +6847,9 @@ components: type: object properties: {} description: A collection of performance metrics and statistics from the training process. + RecommenderVersionName: + $ref: "#/components/schemas/RecommenderVersionName" + description: The name of the recommender version that produced these training metrics. GetRecommenderFilterResponse: type: object properties: @@ -6898,7 +7073,7 @@ components: description: The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations. DestinationUri: $ref: "#/components/schemas/string1To255" - description: The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website. + description: The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Connect Customer Admin Website. required: - SnapshotId - Status @@ -8421,7 +8596,7 @@ components: description: The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3. RuleBasedMatching: $ref: "#/components/schemas/RuleBasedMatchingResponse" - description: The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. + description: The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. DataStore: $ref: "#/components/schemas/DataStoreResponse" description: The data store. @@ -8704,37 +8879,14 @@ components: insert: [] update: [] delete: [] - calculated_attribute_definitions: - id: aws.customer_profiles.calculated_attribute_definitions - name: calculated_attribute_definitions - title: calculated_attribute_definitions + domains: + id: aws.customer_profiles.domains + name: domains + title: domains methods: - create_calculated_attribute_definition: - operation: - $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - delete_calculated_attribute_definition: - operation: - $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - get_calculated_attribute_definition: - operation: - $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - update_calculated_attribute_definition: + batch_put_profile_object: operation: - $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/put" + $ref: "#/paths/~1domains~1{domain_name}~1profiles~1objects~1batch-put-profile-object/put" response: openAPIDocKey: "200" mediaType: application/json @@ -8743,29 +8895,6 @@ components: config: requestBodyTranslate: algorithm: naive - list_calculated_attribute_definitions: - operation: - $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/get_calculated_attribute_definition" - - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/list_calculated_attribute_definitions" - insert: - - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/create_calculated_attribute_definition" - update: - - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/update_calculated_attribute_definition" - delete: - - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/delete_calculated_attribute_definition" - domains: - id: aws.customer_profiles.domains - name: domains - title: domains - methods: create_domain: operation: $ref: "#/paths/~1domains~1{domain_name}/post" @@ -8841,6 +8970,63 @@ components: - $ref: "#/components/x-stackQL-resources/domains/methods/update_domain" delete: - $ref: "#/components/x-stackQL-resources/domains/methods/delete_domain" + calculated_attribute_definitions: + id: aws.customer_profiles.calculated_attribute_definitions + name: calculated_attribute_definitions + title: calculated_attribute_definitions + methods: + create_calculated_attribute_definition: + operation: + $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_calculated_attribute_definition: + operation: + $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_calculated_attribute_definition: + operation: + $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_calculated_attribute_definition: + operation: + $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes~1{calculated_attribute_name}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_calculated_attribute_definitions: + operation: + $ref: "#/paths/~1domains~1{domain_name}~1calculated-attributes/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/get_calculated_attribute_definition" + - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/list_calculated_attribute_definitions" + insert: + - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/create_calculated_attribute_definition" + update: + - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/update_calculated_attribute_definition" + delete: + - $ref: "#/components/x-stackQL-resources/calculated_attribute_definitions/methods/delete_calculated_attribute_definition" domain_layouts: id: aws.customer_profiles.domain_layouts name: domain_layouts diff --git a/providers/src/aws/v00.00.00000/services/datasync.yaml b/providers/src/aws/v00.00.00000/services/datasync.yaml index 0d9198ce..131869ae 100644 --- a/providers/src/aws/v00.00.00000/services/datasync.yaml +++ b/providers/src/aws/v00.00.00000/services/datasync.yaml @@ -430,7 +430,7 @@ paths: description: A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /. NameNodes: $ref: "#/components/schemas/HdfsNameNodeList" - description: The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode. + description: "The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. The number of NameNodes you can specify depends on the task mode: Enhanced mode – You can specify multiple NameNodes for HDFS High Availability (HA) configurations. Basic mode – You can specify only one NameNode." BlockSize: $ref: "#/components/schemas/HdfsBlockSize" description: The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). @@ -1987,7 +1987,7 @@ paths: description: A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. NameNodes: $ref: "#/components/schemas/HdfsNameNodeList" - description: The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode. + description: "The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. The number of NameNodes you can specify depends on the task mode: Enhanced mode – You can specify multiple NameNodes for HDFS High Availability (HA) configurations. Basic mode – You can specify only one NameNode." BlockSize: $ref: "#/components/schemas/HdfsBlockSize" description: The size of the data blocks to write into the HDFS cluster. @@ -2953,10 +2953,10 @@ components: description: Specifies whether DataSync should modify or preserve data at the destination location. ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers. NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination. Atime: $ref: "#/components/schemas/Atime" - description: Specifies whether to preserve metadata indicating the last time a file was read or written to. The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis. BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING steps of the task execution). This option is recommended. NONE - Ignores Atime. If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. + description: "Specifies whether to preserve metadata indicating the last time a file was read or written to. The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis. BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING steps of the task execution). This option is recommended. NONE - Ignores Atime. The following applies only to Basic mode tasks: If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. Enhanced mode tasks support configuring Atime independently of Mtime." Mtime: $ref: "#/components/schemas/Mtime" - description: Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once. PRESERVE (default) - Preserves original Mtime, which is recommended. NONE - Ignores Mtime. If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE. + description: "Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once. PRESERVE (default) - Preserves original Mtime, which is recommended. NONE - Ignores Mtime. The following applies only to Basic mode tasks: If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE. Enhanced mode tasks don't support Mtime set to NONE." Uid: $ref: "#/components/schemas/Uid" description: Specifies the POSIX user ID (UID) of the file's owner. INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended. NONE - Ignores UID and GID. For more information, see Metadata copied by DataSync. diff --git a/providers/src/aws/v00.00.00000/services/datazone.yaml b/providers/src/aws/v00.00.00000/services/datazone.yaml index 64c69b3c..b35f17f0 100644 --- a/providers/src/aws/v00.00.00000/services/datazone.yaml +++ b/providers/src/aws/v00.00.00000/services/datazone.yaml @@ -3697,6 +3697,10 @@ paths: $ref: "#/components/schemas/EnabledRegionList" regionalParameters: $ref: "#/components/schemas/RegionalParameterMap" + resourceConfigurations: + $ref: "#/components/schemas/PutResourceConfigurations" + allowUserProvidedConfigurations: + $ref: "#/components/schemas/Boolean" globalParameters: $ref: "#/components/schemas/GlobalParameterMap" provisioningConfigurations: @@ -4020,6 +4024,53 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateGlossaryTermOutput" + /v2/domains/{domain_identifier}/lineage/events/{identifier}: + delete: + operationId: DeleteLineageEvent + description: Deletes the specified lineage event. + parameters: + - name: domain_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/DomainId" + description: The ID of the domain. + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/LineageEventIdentifier" + description: The ID of the lineage event. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteLineageEventOutput" + get: + operationId: GetLineageEvent + description: Describes the lineage event. + parameters: + - name: domain_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/DomainId" + description: The ID of the domain. + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/LineageEventIdentifier" + description: The ID of the lineage event. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetLineageEventOutput" /v2/domains/{domain_identifier}/listings/{identifier}: delete: operationId: DeleteListing @@ -5047,30 +5098,6 @@ paths: application/json: schema: $ref: "#/components/schemas/GetJobRunOutput" - /v2/domains/{domain_identifier}/lineage/events/{identifier}: - get: - operationId: GetLineageEvent - description: Describes the lineage event. - parameters: - - name: domain_identifier - in: path - required: true - schema: - $ref: "#/components/schemas/DomainId" - description: The ID of the domain. - - name: identifier - in: path - required: true - schema: - $ref: "#/components/schemas/LineageEventIdentifier" - description: The ID of the lineage event. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/GetLineageEventOutput" /v2/domains/{domain_identifier}/lineage/nodes/{identifier}: get: operationId: GetLineageNode @@ -6843,6 +6870,48 @@ paths: application/json: schema: $ref: "#/components/schemas/StartNotebookImportOutput" + /v2/domains/{domain_identifier}/notebook-syncs: + post: + operationId: StartNotebookSync + description: Starts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project. + parameters: + - name: domain_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/DomainId" + description: The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owningProjectIdentifier: + $ref: "#/components/schemas/ProjectId" + sourceLocation: + $ref: "#/components/schemas/SourceLocation" + gitMetadata: + $ref: "#/components/schemas/GitMetadata" + notebookId: + $ref: "#/components/schemas/NotebookId" + name: + $ref: "#/components/schemas/NotebookName" + description: + $ref: "#/components/schemas/Description" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - owningProjectIdentifier + - sourceLocation + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartNotebookSyncOutput" /v2/domains/{domain_identifier}/notebook-runs/{identifier}/stop: put: operationId: StopNotebookRun @@ -7471,6 +7540,9 @@ components: status: $ref: "#/components/schemas/String" description: The status of the asset scope. + scopeName: + $ref: "#/components/schemas/String" + description: The name of the materialized asset scope. errorMessage: $ref: "#/components/schemas/String" description: The error message of the asset scope. @@ -8872,6 +8944,9 @@ components: s3Properties: $ref: "#/components/schemas/S3PropertiesInput" description: The Amazon S3 properties of a connection. + snowflakeProperties: + $ref: "#/components/schemas/SnowflakePropertiesInput" + description: The Snowflake-specific connection properties to use when creating the connection. amazonQProperties: $ref: "#/components/schemas/AmazonQPropertiesInput" description: The Amazon Q properties of the connection. @@ -8887,6 +8962,12 @@ components: lakehouseProperties: $ref: "#/components/schemas/LakehousePropertiesInput" description: The lakehouse properties of a connection. + vpcProperties: + $ref: "#/components/schemas/VpcPropertiesInput" + description: The VPC properties of a connection. + gitProperties: + $ref: "#/components/schemas/GitPropertiesInput" + description: The Git properties of a connection. AthenaPropertiesInput: description: The Amazon Athena properties of a connection. type: object @@ -9456,6 +9537,179 @@ components: minLength: 0 maxLength: 64 pattern: "[a-zA-Z0-9\\-]+" + SnowflakePropertiesInput: + description: Contains the Snowflake-specific settings required when creating or updating a connection, including the Snowflake role, identity mapping, and lineage sync configuration. + type: object + properties: + connectivityProperties: + $ref: "#/components/schemas/ConnectivityProperties" + description: The connectivity properties of the Snowflake connection. + snowflakeRole: + $ref: "#/components/schemas/SnowflakeRole" + description: The Snowflake role used to access Snowflake resources. + identityMapping: + $ref: "#/components/schemas/IdentityMapping" + description: The identity mapping configuration for the Snowflake connection. + lineageSync: + $ref: "#/components/schemas/LineageSyncInput" + description: The lineage sync configuration for the Snowflake connection. + required: + - snowflakeRole + - identityMapping + ConnectivityProperties: + description: Contains the network and authentication settings for a connection, including connection credentials, physical network requirements, and compute-environment validation options. + type: object + properties: + connectionProperties: + type: object + properties: {} + description: The connection properties for this configuration. + physicalConnectionRequirements: + $ref: "#/components/schemas/PhysicalConnectionRequirements" + description: The physical network requirements for the connection, such as the subnet, security group, and VPC settings needed to reach the data source. + name: + $ref: "#/components/schemas/ConnectivityPropertiesNameString" + description: The name of the connectivity configuration. + description: + $ref: "#/components/schemas/ConnectivityPropertiesDescriptionString" + description: The description of the connectivity configuration. + validateCredentials: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to validate credentials for the connectivity configuration. Defaults to true if not specified. + validateForComputeEnvironments: + $ref: "#/components/schemas/ComputeEnvironmentsList" + description: The compute environments to use when validating connectivity. The service validates that the connection is reachable from each specified environment. + sparkProperties: + type: object + properties: {} + description: The Spark properties for this configuration. + athenaProperties: + type: object + properties: {} + description: The Athena properties for this configuration. + pythonProperties: + type: object + properties: {} + description: The Python properties for this configuration. + authenticationConfiguration: + $ref: "#/components/schemas/AuthenticationConfigurationInput" + description: The authentication settings for this configuration. + ConnectivityPropertiesNameString: + type: string + minLength: 1 + maxLength: 41 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFF\\t]*" + ConnectivityPropertiesDescriptionString: + type: string + minLength: 0 + maxLength: 2048 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFF\\r\\n\\t]*" + SnowflakeRole: + description: The name of the Snowflake role to use for the connection. + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9_$]+" + IdentityMapping: + description: Contains the configuration for mapping user identities to Snowflake users, including the username attribute and optional prefix applied during the mapping. + type: object + properties: + usernameAttribute: + $ref: "#/components/schemas/String" + description: The username attribute used for the identity mapping. + prefix: + $ref: "#/components/schemas/String" + description: The prefix used for the identity mapping. + required: + - usernameAttribute + LineageSyncInput: + description: Contains the settings for configuring lineage sync on a Snowflake connection, including the schedule, timezone, and enabled state. + type: object + properties: + timezone: + $ref: "#/components/schemas/Timezone" + description: The timezone of the lineage sync schedule. + enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether lineage sync is enabled. + schedule: + $ref: "#/components/schemas/LineageSyncScheduleCronString" + description: The schedule of the lineage sync. + required: + - enabled + Timezone: + type: string + enum: + - UTC + - AFRICA_JOHANNESBURG + - AMERICA_MONTREAL + - AMERICA_SAO_PAULO + - ASIA_BAHRAIN + - ASIA_BANGKOK + - ASIA_CALCUTTA + - ASIA_DUBAI + - ASIA_HONG_KONG + - ASIA_JAKARTA + - ASIA_KUALA_LUMPUR + - ASIA_SEOUL + - ASIA_SHANGHAI + - ASIA_SINGAPORE + - ASIA_TAIPEI + - ASIA_TOKYO + - AUSTRALIA_MELBOURNE + - AUSTRALIA_SYDNEY + - CANADA_CENTRAL + - CET + - CST6CDT + - ETC_GMT + - ETC_GMT0 + - ETC_GMT_ADD_0 + - ETC_GMT_ADD_1 + - ETC_GMT_ADD_10 + - ETC_GMT_ADD_11 + - ETC_GMT_ADD_12 + - ETC_GMT_ADD_2 + - ETC_GMT_ADD_3 + - ETC_GMT_ADD_4 + - ETC_GMT_ADD_5 + - ETC_GMT_ADD_6 + - ETC_GMT_ADD_7 + - ETC_GMT_ADD_8 + - ETC_GMT_ADD_9 + - ETC_GMT_NEG_0 + - ETC_GMT_NEG_1 + - ETC_GMT_NEG_10 + - ETC_GMT_NEG_11 + - ETC_GMT_NEG_12 + - ETC_GMT_NEG_13 + - ETC_GMT_NEG_14 + - ETC_GMT_NEG_2 + - ETC_GMT_NEG_3 + - ETC_GMT_NEG_4 + - ETC_GMT_NEG_5 + - ETC_GMT_NEG_6 + - ETC_GMT_NEG_7 + - ETC_GMT_NEG_8 + - ETC_GMT_NEG_9 + - EUROPE_DUBLIN + - EUROPE_LONDON + - EUROPE_PARIS + - EUROPE_STOCKHOLM + - EUROPE_ZURICH + - ISRAEL + - MEXICO_GENERAL + - MST7MDT + - PACIFIC_AUCKLAND + - US_CENTRAL + - US_EASTERN + - US_MOUNTAIN + - US_PACIFIC + LineageSyncScheduleCronString: + description: The cron expression for the lineage sync schedule. + type: string + minLength: 1 + maxLength: 256 + pattern: cron\((\b[0-5]?[0-9]\b) ([*]|\b2[0-3]\b|\b[0-1]?[0-9]\b) ([-?*,/\dLW]){1,83} ([-*,/\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\dL]|[a-zA-Z]{3}){1,13} ([^\)]+)\) AmazonQPropertiesInput: description: The Amazon Q properties of the connection. type: object @@ -9504,6 +9758,68 @@ components: glueLineageSyncEnabled: $ref: "#/components/schemas/Boolean" description: Specifies whether to enable Glue lineage sync for tables managed by Glue crawlers. + VpcPropertiesInput: + description: The VPC connection properties used when creating a connection. + type: object + properties: + vpcId: + $ref: "#/components/schemas/VpcId" + description: The identifier of the VPC. Must match the pattern ^vpc-[a-z0-9]+$. Maximum length of 32. + subnetIds: + $ref: "#/components/schemas/VpcConnectionSubnetIdList" + description: The subnet IDs of the VPC connection. You can specify between 1 and 16 subnet IDs. + securityGroupId: + $ref: "#/components/schemas/SecurityGroupId" + description: The security group ID of the VPC connection. Must match the pattern ^sg-[a-z0-9]+$. Maximum length of 32. + required: + - vpcId + - subnetIds + VpcId: + type: string + minLength: 0 + maxLength: 32 + pattern: vpc-[a-z0-9]+ + VpcConnectionSubnetIdList: + type: array + items: + $ref: "#/components/schemas/SubnetId" + SecurityGroupId: + type: string + minLength: 0 + maxLength: 32 + pattern: sg-[a-z0-9]+ + GitPropertiesInput: + description: Contains the Git connection properties that you specify when creating a Git connection. + type: object + properties: + codeConnectionArn: + $ref: "#/components/schemas/GitPropertiesInputCodeConnectionArnString" + description: The ARN of the CodeConnections connection used to connect to the Git repository. + repositoryId: + $ref: "#/components/schemas/GitPropertiesInputRepositoryIdString" + description: The ID of the Git repository. This is the owner and repository name, for example, owner/repo-name. + defaultBranch: + $ref: "#/components/schemas/GitPropertiesInputDefaultBranchString" + description: The default branch of the Git repository. + required: + - codeConnectionArn + - repositoryId + - defaultBranch + GitPropertiesInputCodeConnectionArnString: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws[^:]*:(codeconnections|codestar-connections):[a-z0-9\-]+:\d{12}:connection/[a-f0-9\-]+ + GitPropertiesInputRepositoryIdString: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9._\\-]+(/[a-zA-Z0-9._\\-]+)+" + GitPropertiesInputDefaultBranchString: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9._\\-/]+" ConnectionScope: type: string enum: @@ -9681,6 +9997,8 @@ components: - WORKFLOWS_MWAA - AMAZON_Q - MLFLOW + - VPC + - GIT MatchCriteria: type: array items: @@ -9758,6 +10076,9 @@ components: s3Properties: $ref: "#/components/schemas/S3PropertiesOutput" description: The Amazon S3 properties of a connection. + snowflakeProperties: + $ref: "#/components/schemas/SnowflakePropertiesOutput" + description: The Snowflake-specific connection properties for an existing connection. amazonQProperties: $ref: "#/components/schemas/AmazonQPropertiesOutput" description: The Amazon Q properties of the connection. @@ -9773,6 +10094,12 @@ components: lakehouseProperties: $ref: "#/components/schemas/LakehousePropertiesOutput" description: The lakehouse properties of a connection. + vpcProperties: + $ref: "#/components/schemas/VpcPropertiesOutput" + description: The VPC properties of a connection. + gitProperties: + $ref: "#/components/schemas/GitPropertiesOutput" + description: The Git properties of a connection. AthenaPropertiesOutput: description: The Amazon Athena properties of a connection. type: object @@ -9989,6 +10316,46 @@ components: description: The error message that gets displayed. required: - s3Uri + SnowflakePropertiesOutput: + description: Contains the Snowflake-specific settings returned for an existing connection, including the current role, identity mapping, lineage sync state, and connection status. + type: object + properties: + snowflakeRole: + $ref: "#/components/schemas/SnowflakeRole" + description: The Snowflake role used to access Snowflake resources. + identityMapping: + $ref: "#/components/schemas/IdentityMapping" + description: The identity mapping configuration for the Snowflake connection. + lineageSync: + $ref: "#/components/schemas/LineageSyncOutput" + description: The lineage sync configuration for the Snowflake connection. + status: + $ref: "#/components/schemas/ConnectionStatus" + description: The status of the Snowflake connection. + errorMessage: + $ref: "#/components/schemas/String" + description: An error message returned if the Snowflake connection failed to establish or validate. + required: + - snowflakeRole + - identityMapping + - lineageSync + - status + LineageSyncOutput: + description: Contains the current state of lineage sync for a Snowflake connection, including the schedule, timezone, enabled state, and the ID of the associated lineage job. + type: object + properties: + lineageJobId: + $ref: "#/components/schemas/String" + description: The ID of the lineage sync job. + timezone: + $ref: "#/components/schemas/Timezone" + description: The timezone of the lineage sync schedule. + enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether lineage sync is enabled. + schedule: + $ref: "#/components/schemas/LineageSyncScheduleCronString" + description: The schedule of the lineage sync. AmazonQPropertiesOutput: description: The Amazon Q properties of the connection. type: object @@ -10037,6 +10404,67 @@ components: glueLineageSyncEnabled: $ref: "#/components/schemas/Boolean" description: Specifies whether Glue lineage sync is enabled for tables managed by Glue crawlers. + VpcPropertiesOutput: + description: The VPC connection properties returned in responses. + type: object + properties: + vpcId: + $ref: "#/components/schemas/VpcId" + description: The identifier of the VPC. + subnetIds: + $ref: "#/components/schemas/VpcConnectionSubnetIdList" + description: The subnet IDs of the VPC connection. + status: + $ref: "#/components/schemas/ConnectionStatus" + description: The status of the VPC connection. + securityGroupId: + $ref: "#/components/schemas/SecurityGroupId" + description: The security group ID of the VPC connection. + glueConnectionNames: + $ref: "#/components/schemas/GlueConnectionNames" + description: The Amazon Web Services Glue connection names associated with the VPC connection. + required: + - vpcId + - subnetIds + - status + GitPropertiesOutput: + description: The properties of a Git connection returned by get and list operations, including connection status and any error details. + type: object + properties: + codeConnectionArn: + $ref: "#/components/schemas/GitPropertiesOutputCodeConnectionArnString" + description: The ARN of the CodeConnections connection used to connect to the Git repository. + repositoryId: + $ref: "#/components/schemas/GitPropertiesOutputRepositoryIdString" + description: The ID of the Git repository. This is the owner and repository name, for example, owner/repo-name. + defaultBranch: + $ref: "#/components/schemas/GitPropertiesOutputDefaultBranchString" + description: The default branch of the Git repository. + status: + $ref: "#/components/schemas/ConnectionStatus" + description: The status of the Git connection. + errorMessage: + $ref: "#/components/schemas/String" + description: The error message that describes why the Git connection failed. This member is populated when the connection status is CREATE_FAILED or UPDATE_FAILED. + required: + - codeConnectionArn + - repositoryId + - defaultBranch + GitPropertiesOutputCodeConnectionArnString: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws[^:]*:(codeconnections|codestar-connections):[a-z0-9\-]+:\d{12}:connection/[a-f0-9\-]+ + GitPropertiesOutputRepositoryIdString: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9._\\-]+(/[a-zA-Z0-9._\\-]+)+" + GitPropertiesOutputDefaultBranchString: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9._\\-/]+" DataProductName: type: string minLength: 1 @@ -10367,106 +10795,39 @@ components: type: string minLength: 3 maxLength: 64 - pattern: "[a-z0-9-]+" - SageMakerRunConfigurationInput: - description: The Amazon SageMaker run configuration. - type: object - properties: - trackingAssets: - type: object - properties: {} - description: The tracking assets of the Amazon SageMaker run. - required: - - trackingAssets - RecommendationConfiguration: - description: The recommendation to be updated as part of the UpdateDataSource action. - type: object - properties: - enableBusinessNameGeneration: - $ref: "#/components/schemas/Boolean" - description: Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. - EnableSetting: - type: string - enum: - - ENABLED - - DISABLED - ScheduleConfiguration: - description: The details of the schedule of the data source runs. - type: object - properties: - timezone: - $ref: "#/components/schemas/Timezone" - description: The timezone of the data source run. - schedule: - $ref: "#/components/schemas/CronString" - description: The schedule of the data source runs. - Timezone: - type: string - enum: - - UTC - - AFRICA_JOHANNESBURG - - AMERICA_MONTREAL - - AMERICA_SAO_PAULO - - ASIA_BAHRAIN - - ASIA_BANGKOK - - ASIA_CALCUTTA - - ASIA_DUBAI - - ASIA_HONG_KONG - - ASIA_JAKARTA - - ASIA_KUALA_LUMPUR - - ASIA_SEOUL - - ASIA_SHANGHAI - - ASIA_SINGAPORE - - ASIA_TAIPEI - - ASIA_TOKYO - - AUSTRALIA_MELBOURNE - - AUSTRALIA_SYDNEY - - CANADA_CENTRAL - - CET - - CST6CDT - - ETC_GMT - - ETC_GMT0 - - ETC_GMT_ADD_0 - - ETC_GMT_ADD_1 - - ETC_GMT_ADD_10 - - ETC_GMT_ADD_11 - - ETC_GMT_ADD_12 - - ETC_GMT_ADD_2 - - ETC_GMT_ADD_3 - - ETC_GMT_ADD_4 - - ETC_GMT_ADD_5 - - ETC_GMT_ADD_6 - - ETC_GMT_ADD_7 - - ETC_GMT_ADD_8 - - ETC_GMT_ADD_9 - - ETC_GMT_NEG_0 - - ETC_GMT_NEG_1 - - ETC_GMT_NEG_10 - - ETC_GMT_NEG_11 - - ETC_GMT_NEG_12 - - ETC_GMT_NEG_13 - - ETC_GMT_NEG_14 - - ETC_GMT_NEG_2 - - ETC_GMT_NEG_3 - - ETC_GMT_NEG_4 - - ETC_GMT_NEG_5 - - ETC_GMT_NEG_6 - - ETC_GMT_NEG_7 - - ETC_GMT_NEG_8 - - ETC_GMT_NEG_9 - - EUROPE_DUBLIN - - EUROPE_LONDON - - EUROPE_PARIS - - EUROPE_STOCKHOLM - - EUROPE_ZURICH - - ISRAEL - - MEXICO_GENERAL - - MST7MDT - - PACIFIC_AUCKLAND - - US_CENTRAL - - US_EASTERN - - US_MOUNTAIN - - US_PACIFIC + pattern: "[a-z0-9-]+" + SageMakerRunConfigurationInput: + description: The Amazon SageMaker run configuration. + type: object + properties: + trackingAssets: + type: object + properties: {} + description: The tracking assets of the Amazon SageMaker run. + required: + - trackingAssets + RecommendationConfiguration: + description: The recommendation to be updated as part of the UpdateDataSource action. + type: object + properties: + enableBusinessNameGeneration: + $ref: "#/components/schemas/Boolean" + description: Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. + EnableSetting: + type: string + enum: + - ENABLED + - DISABLED + ScheduleConfiguration: + description: The details of the schedule of the data source runs. + type: object + properties: + timezone: + $ref: "#/components/schemas/Timezone" + description: The timezone of the data source run. + schedule: + $ref: "#/components/schemas/CronString" + description: The schedule of the data source runs. CronString: type: string minLength: 1 @@ -11611,6 +11972,9 @@ components: error: $ref: "#/components/schemas/NotebookError" description: The error details if the notebook creation failed. + gitMetadata: + $ref: "#/components/schemas/GitMetadata" + description: The Git metadata associated with the notebook. required: - id - name @@ -11634,6 +11998,8 @@ components: enum: - ACTIVE - ARCHIVED + - SYNC_IN_PROGRESS + - SYNC_FAILED ComputeId: type: string minLength: 0 @@ -11682,6 +12048,62 @@ components: type: string minLength: 0 maxLength: 256 + GitMetadata: + description: The Git metadata for a notebook sync operation in Amazon SageMaker Unified Studio. Contains information about the Git repository, branch, and commit associated with the notebook. + type: object + properties: + connectionId: + $ref: "#/components/schemas/GitConnectionId" + description: The identifier of the Git connection. + repository: + $ref: "#/components/schemas/GitRepository" + description: The name of the Git repository. + branch: + $ref: "#/components/schemas/GitBranch" + description: The name of the Git branch. + commitHash: + $ref: "#/components/schemas/CommitHash" + description: The commit hash in the Git repository. + fileName: + $ref: "#/components/schemas/FileName" + description: The name of the file in the Git repository. + committedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of when the commit was made. + commitMessage: + $ref: "#/components/schemas/CommitMessage" + description: The commit message associated with the Git commit. + required: + - connectionId + - repository + - branch + - commitHash + GitConnectionId: + type: string + minLength: 1 + maxLength: 40 + pattern: "[a-zA-Z0-9_-]+" + GitRepository: + type: string + minLength: 1 + maxLength: 512 + GitBranch: + type: string + minLength: 1 + maxLength: 256 + CommitHash: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9]+" + FileName: + type: string + minLength: 1 + maxLength: 255 + CommitMessage: + type: string + minLength: 0 + maxLength: 2048 CreateProjectInputResourceTagsMap: type: object properties: {} @@ -12899,6 +13321,28 @@ components: type: object DeleteGlossaryTermOutput: type: object + LineageEventIdentifier: + type: string + pattern: "[a-z0-9]{14}" + DeleteLineageEventOutput: + type: object + properties: + id: + $ref: "#/components/schemas/LineageEventIdentifier" + description: The ID of the lineage event. + domainId: + $ref: "#/components/schemas/DomainId" + description: The ID of the domain. + processingStatus: + $ref: "#/components/schemas/LineageEventProcessingStatus" + description: The progressing status of the lineage event. + LineageEventProcessingStatus: + type: string + enum: + - REQUESTED + - PROCESSING + - SUCCESS + - FAILED DeleteListingOutput: type: object DeleteNotebookOutput: @@ -13761,12 +14205,18 @@ components: type: object properties: {} description: The regional parameters of the blueprint. + allowUserProvidedConfigurations: + $ref: "#/components/schemas/Boolean" + description: Specifies whether user-provided resource configurations are allowed for the environment blueprint. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when this blueprint was created. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when this blueprint was upated. + resourceConfigurations: + $ref: "#/components/schemas/ResourceConfigurations" + description: The resource configurations of the environment blueprint. provisioningConfigurations: $ref: "#/components/schemas/ProvisioningConfigurationList" description: The provisioning configuration of a blueprint. @@ -13780,6 +14230,35 @@ components: type: array items: $ref: "#/components/schemas/RegionName" + ResourceConfigurations: + type: array + items: + $ref: "#/components/schemas/ResourceConfiguration" + ResourceConfiguration: + description: The details of the resource configuration. + type: object + properties: + identifier: + $ref: "#/components/schemas/String" + description: The identifier of the resource configuration. + name: + $ref: "#/components/schemas/String" + description: The name of the resource configuration. + description: + $ref: "#/components/schemas/String" + description: The description of the resource configuration. + region: + $ref: "#/components/schemas/RegionName" + description: The Amazon Web Services Region of the resource configuration. + parameters: + type: object + properties: {} + description: The parameters of the resource configuration. + required: + - identifier + - name + - region + - parameters ProvisioningConfigurationList: type: array items: @@ -14161,9 +14640,6 @@ components: description: The job run error message. required: - message - LineageEventIdentifier: - type: string - pattern: "[a-z0-9]{14}" GetLineageEventOutput: type: object properties: @@ -14193,13 +14669,6 @@ components: format: byte minLength: 0 maxLength: 300000 - LineageEventProcessingStatus: - type: string - enum: - - REQUESTED - - PROCESSING - - SUCCESS - - FAILED LineageNodeIdentifier: type: string minLength: 1 @@ -14558,6 +15027,9 @@ components: error: $ref: "#/components/schemas/NotebookError" description: The error details if the notebook is in a failed state. + gitMetadata: + $ref: "#/components/schemas/GitMetadata" + description: The Git metadata associated with the notebook. required: - id - name @@ -15983,12 +16455,18 @@ components: type: object properties: {} description: The regional parameters of the environment blueprint. + allowUserProvidedConfigurations: + $ref: "#/components/schemas/Boolean" + description: Specifies whether user-provided resource configurations are allowed for the environment blueprint. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when an environment blueprint was created. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when the environment blueprint was updated. + resourceConfigurations: + $ref: "#/components/schemas/ResourceConfigurations" + description: The resource configurations of the environment blueprint. provisioningConfigurations: $ref: "#/components/schemas/ProvisioningConfigurationList" description: The provisioning configuration of a blueprint. @@ -17313,6 +17791,35 @@ components: RegionalParameterMap: type: object properties: {} + PutResourceConfigurations: + type: array + items: + $ref: "#/components/schemas/PutResourceConfiguration" + PutResourceConfiguration: + description: The resource configuration that is used to configure the environment blueprint. + type: object + properties: + name: + $ref: "#/components/schemas/PutResourceConfigurationNameString" + description: The name of the resource configuration. + description: + $ref: "#/components/schemas/String" + description: The description of the resource configuration. + region: + $ref: "#/components/schemas/RegionName" + description: The Amazon Web Services Region of the resource configuration. + parameters: + type: object + properties: {} + description: The parameters of the resource configuration. + required: + - name + - region + - parameters + PutResourceConfigurationNameString: + type: string + minLength: 1 + maxLength: 64 GlobalParameterMap: type: object properties: {} @@ -17341,12 +17848,18 @@ components: type: object properties: {} description: The regional parameters in the environment blueprint. + allowUserProvidedConfigurations: + $ref: "#/components/schemas/Boolean" + description: Specifies whether user-provided resource configurations are allowed for the environment blueprint. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when the environment blueprint was created. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of when the environment blueprint was updated. + resourceConfigurations: + $ref: "#/components/schemas/ResourceConfigurations" + description: The resource configurations of the environment blueprint. provisioningConfigurations: $ref: "#/components/schemas/ProvisioningConfigurationList" description: The provisioning configuration of a blueprint. @@ -18790,6 +19303,39 @@ components: - owningProjectId - notebookId - status + StartNotebookSyncOutput: + type: object + properties: + notebookId: + $ref: "#/components/schemas/NotebookId" + description: The identifier of the synced notebook. + status: + $ref: "#/components/schemas/NotebookStatus" + description: The status of the notebook sync. + domainId: + $ref: "#/components/schemas/DomainId" + description: The identifier of the Amazon SageMaker Unified Studio domain. + owningProjectId: + $ref: "#/components/schemas/ProjectId" + description: The identifier of the project that owns the synced notebook. + sourceLocation: + $ref: "#/components/schemas/SourceLocation" + description: The source location from which the notebook was synced. + gitMetadata: + $ref: "#/components/schemas/GitMetadata" + description: The Git metadata associated with the synced notebook. + name: + $ref: "#/components/schemas/NotebookName" + description: The name of the synced notebook. + description: + $ref: "#/components/schemas/Description" + description: The description of the synced notebook. + createdAt: + $ref: "#/components/schemas/CreatedAt" + description: The timestamp of when the notebook sync was started. + createdBy: + $ref: "#/components/schemas/CreatedBy" + description: The identifier of the user who started the notebook sync. StopNotebookRunOutput: type: object properties: @@ -18925,6 +19471,9 @@ components: s3Properties: $ref: "#/components/schemas/S3PropertiesPatch" description: The Amazon S3 properties of a connection properties patch. + snowflakeProperties: + $ref: "#/components/schemas/SnowflakePropertiesPatch" + description: The Snowflake-specific connection properties to update. amazonQProperties: $ref: "#/components/schemas/AmazonQPropertiesPatch" description: The Amazon Q properties of the connection. @@ -18934,6 +19483,12 @@ components: lakehouseProperties: $ref: "#/components/schemas/LakehousePropertiesPatch" description: The lakehouse properties of a connection properties patch. + vpcProperties: + $ref: "#/components/schemas/VpcPropertiesPatch" + description: The VPC properties of a connection properties patch. + gitProperties: + $ref: "#/components/schemas/GitPropertiesPatch" + description: The Git properties of a connection properties patch. AthenaPropertiesPatch: description: The Amazon Athena properties patch of a connection. type: object @@ -19091,6 +19646,38 @@ components: description: Specifies whether to register the Amazon S3 Access Grant location. required: - s3Uri + SnowflakePropertiesPatch: + description: Contains the Snowflake-specific settings to update on an existing connection. Include only the fields you want to change. + type: object + properties: + connectivityPropertiesPatch: + $ref: "#/components/schemas/ConnectivityPropertiesPatch" + description: The connectivity properties patch of the Snowflake connection. + snowflakeRole: + $ref: "#/components/schemas/SnowflakeRole" + description: The Snowflake role used to access Snowflake resources. + lineageSync: + $ref: "#/components/schemas/LineageSyncInput" + description: The lineage sync configuration for the Snowflake connection. + ConnectivityPropertiesPatch: + description: Contains the connectivity settings to update on an existing connection. Include only the fields you want to change. + type: object + properties: + description: + $ref: "#/components/schemas/ConnectivityPropertiesPatchDescriptionString" + description: A description of the connectivity properties update. + connectionProperties: + type: object + properties: {} + description: The connection properties to update. + authenticationConfiguration: + $ref: "#/components/schemas/AuthenticationConfigurationPatch" + description: The authentication settings to update. + ConnectivityPropertiesPatchDescriptionString: + type: string + minLength: 0 + maxLength: 2048 + pattern: "[\\S\\s]*" AmazonQPropertiesPatch: description: The Amazon Q properties of the connection. type: object @@ -19129,6 +19716,39 @@ components: glueLineageSyncEnabled: $ref: "#/components/schemas/Boolean" description: Specifies whether to enable Glue lineage sync for tables managed by Glue crawlers. + VpcPropertiesPatch: + description: The VPC connection properties used when updating a connection. + type: object + properties: + vpcId: + $ref: "#/components/schemas/VpcId" + description: The identifier of the VPC. + subnetIds: + $ref: "#/components/schemas/VpcConnectionSubnetIdList" + description: The subnet IDs of the VPC connection. + securityGroupId: + $ref: "#/components/schemas/SecurityGroupId" + description: The security group ID of the VPC connection. + GitPropertiesPatch: + description: The properties used to update an existing Git connection, such as the CodeConnections ARN or the default branch. + type: object + properties: + codeConnectionArn: + $ref: "#/components/schemas/GitPropertiesPatchCodeConnectionArnString" + description: The ARN of the CodeConnections connection used to connect to the Git repository. + defaultBranch: + $ref: "#/components/schemas/GitPropertiesPatchDefaultBranchString" + description: The default branch of the Git repository. + GitPropertiesPatchCodeConnectionArnString: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws[^:]*:(codeconnections|codestar-connections):[a-z0-9\-]+:\d{12}:connection/[a-f0-9\-]+ + GitPropertiesPatchDefaultBranchString: + type: string + minLength: 0 + maxLength: 256 + pattern: "[a-zA-Z0-9._\\-/]+" UpdateConnectionOutput: type: object properties: @@ -19655,6 +20275,9 @@ components: error: $ref: "#/components/schemas/NotebookError" description: The error details if the notebook is in a failed state. + gitMetadata: + $ref: "#/components/schemas/GitMetadata" + description: The Git metadata associated with the notebook. required: - id - name @@ -21584,6 +22207,17 @@ components: config: requestBodyTranslate: algorithm: naive + start_notebook_sync: + operation: + $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1notebook-syncs/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive stop_notebook_run: operation: $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1notebook-runs~1{identifier}~1stop/put" @@ -22203,6 +22837,48 @@ components: - $ref: "#/components/x-stackQL-resources/environment_blueprint_configurations/methods/put_environment_blueprint_configuration" delete: - $ref: "#/components/x-stackQL-resources/environment_blueprint_configurations/methods/delete_environment_blueprint_configuration" + lineage_events: + id: aws.datazone.lineage_events + name: lineage_events + title: lineage_events + methods: + delete_lineage_event: + operation: + $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1lineage~1events~1{identifier}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_lineage_event: + operation: + $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1lineage~1events~1{identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_lineage_events: + operation: + $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1lineage~1events/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/lineage_events/methods/get_lineage_event" + - $ref: "#/components/x-stackQL-resources/lineage_events/methods/list_lineage_events" + insert: [] + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/lineage_events/methods/delete_lineage_event" subscription_request_details: id: aws.datazone.subscription_request_details name: subscription_request_details @@ -22381,41 +23057,6 @@ components: insert: [] update: [] delete: [] - lineage_events: - id: aws.datazone.lineage_events - name: lineage_events - title: lineage_events - methods: - get_lineage_event: - operation: - $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1lineage~1events~1{identifier}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - list_lineage_events: - operation: - $ref: "#/paths/~1v2~1domains~1{domain_identifier}~1lineage~1events/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.items_ - request: - nativeCasing: pascal - config: - pagination: - requestToken: - key: nextToken - location: query - responseToken: - key: $.nextToken - location: body - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/lineage_events/methods/get_lineage_event" - - $ref: "#/components/x-stackQL-resources/lineage_events/methods/list_lineage_events" - insert: [] - update: [] - delete: [] lineage_nodes: id: aws.datazone.lineage_nodes name: lineage_nodes diff --git a/providers/src/aws/v00.00.00000/services/deadline.yaml b/providers/src/aws/v00.00.00000/services/deadline.yaml index 7fdb1530..7019ad2d 100644 --- a/providers/src/aws/v00.00.00000/services/deadline.yaml +++ b/providers/src/aws/v00.00.00000/services/deadline.yaml @@ -46,6 +46,8 @@ paths: $ref: "#/components/schemas/IdentityStoreId" membershipLevel: $ref: "#/components/schemas/MembershipLevel" + identityCenterRegion: + $ref: "#/components/schemas/Region" required: - principalType - identityStoreId @@ -116,6 +118,8 @@ paths: $ref: "#/components/schemas/IdentityStoreId" membershipLevel: $ref: "#/components/schemas/MembershipLevel" + identityCenterRegion: + $ref: "#/components/schemas/Region" required: - principalType - identityStoreId @@ -198,6 +202,8 @@ paths: $ref: "#/components/schemas/IdentityStoreId" membershipLevel: $ref: "#/components/schemas/MembershipLevel" + identityCenterRegion: + $ref: "#/components/schemas/Region" required: - principalType - identityStoreId @@ -280,6 +286,8 @@ paths: $ref: "#/components/schemas/IdentityStoreId" membershipLevel: $ref: "#/components/schemas/MembershipLevel" + identityCenterRegion: + $ref: "#/components/schemas/Region" required: - principalType - identityStoreId @@ -2755,6 +2763,65 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateStorageProfileResponse" + /2023-10-12/farms/{farm_id}/fleets/{fleet_id}/volumes/{volume_id}: + delete: + operationId: DeleteVolume + description: Deletes a persistent volume. + parameters: + - name: farm_id + in: path + required: true + schema: + $ref: "#/components/schemas/FarmId" + description: The farm ID of the farm that contains the fleet. + - name: fleet_id + in: path + required: true + schema: + $ref: "#/components/schemas/FleetId" + description: The fleet ID of the fleet that contains the volume. + - name: volume_id + in: path + required: true + schema: + $ref: "#/components/schemas/VolumeId" + description: The volume ID of the volume to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteVolumeResponse" + get: + operationId: GetVolume + description: Gets a persistent volume. + parameters: + - name: farm_id + in: path + required: true + schema: + $ref: "#/components/schemas/FarmId" + description: The farm ID of the farm that contains the fleet. + - name: fleet_id + in: path + required: true + schema: + $ref: "#/components/schemas/FleetId" + description: The fleet ID of the fleet that contains the volume. + - name: volume_id + in: path + required: true + schema: + $ref: "#/components/schemas/VolumeId" + description: The volume ID of the volume to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetVolumeResponse" /2023-10-12/farms/{farm_id}/fleets/{fleet_id}/workers/{worker_id}: delete: operationId: DeleteWorker @@ -4079,6 +4146,42 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTasksResponse" + /2023-10-12/farms/{farm_id}/fleets/{fleet_id}/volumes: + get: + operationId: ListVolumes + description: Lists the persistent volumes in a fleet. + parameters: + - name: farm_id + in: path + required: true + schema: + $ref: "#/components/schemas/FarmId" + description: The farm ID of the farm that contains the fleet. + - name: fleet_id + in: path + required: true + schema: + $ref: "#/components/schemas/FleetId" + description: The fleet ID of the fleet that contains the volumes. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null to start from the beginning. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListVolumesResponse" /2023-10-12/farms/{farm_id}/search/jobs: post: operationId: SearchJobs @@ -4344,6 +4447,11 @@ components: - CONTRIBUTOR - OWNER - MANAGER + Region: + type: string + minLength: 1 + maxLength: 25 + pattern: "[a-z0-9-]+" AssociateMemberToFarmResponse: type: object FleetId: @@ -4874,7 +4982,7 @@ components: $ref: "#/components/schemas/JobId" description: The job ID. jobAttachmentSettings: - $ref: "#/components/schemas/JobAttachmentSettings" + $ref: "#/components/schemas/JobDetailsJobAttachmentSettings" description: The job attachment settings. jobRunAsUser: $ref: "#/components/schemas/JobRunAsUser" @@ -4899,8 +5007,8 @@ components: - jobId - logGroupName - schemaVersion - JobAttachmentSettings: - description: The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix. + JobDetailsJobAttachmentSettings: + description: The job attachment settings returned to workers for a job. These are the Amazon S3 bucket name and the Amazon S3 prefix. type: object properties: s3BucketName: @@ -6383,7 +6491,6 @@ components: enum: - ARCHIVED JobDescriptionOverride: - description: The input description for the job. Passing in an empty string removes any existing description. type: string minLength: 0 maxLength: 2048 @@ -6644,7 +6751,6 @@ components: type: string pattern: arn:(aws[a-zA-Z-]*):kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:key/[\w-]{1,120} CostScaleFactor: - description: A multiplier applied to calculated costs. Valid range is 0 to 100. Values less than 1.0 represent discounts, values greater than 1.0 represent markups, and a value of 1.0 represents no adjustment. type: number format: float minimum: 0 @@ -6888,6 +6994,9 @@ components: storageProfileId: $ref: "#/components/schemas/StorageProfileId" description: The storage profile ID for the service managed EC2 fleet. + persistentVolumeConfiguration: + $ref: "#/components/schemas/PersistentVolumeConfiguration" + description: The persistent volume configuration for the service managed EC2 fleet. autoScalingConfiguration: $ref: "#/components/schemas/ServiceManagedEc2AutoScalingConfiguration" description: The auto scaling configuration settings for the service managed EC2 fleet. @@ -7033,6 +7142,47 @@ components: type: string minLength: 1 maxLength: 2048 + PersistentVolumeConfiguration: + description: Specifies the persistent EBS volume configuration for workers in a service managed fleet. + type: object + properties: + sizeGiB: + $ref: "#/components/schemas/PersistentVolumeSizeGiB" + description: The persistent volume size in GiB. The default is 250. + iops: + $ref: "#/components/schemas/PersistentVolumeIops" + description: The IOPS per persistent volume. The default is 3000. + throughputMiB: + $ref: "#/components/schemas/PersistentVolumeThroughputMiB" + description: The throughput per persistent volume in MiB. The default is 125. + mountPath: + $ref: "#/components/schemas/MountPath" + description: The file system path where the persistent volume is mounted on the worker instance. + lastUsedTtlHours: + $ref: "#/components/schemas/PersistentVolumeTtlHours" + description: The number of hours a persistent volume can remain unused before it is deleted. The default is 168 (7 days). + required: + - mountPath + PersistentVolumeSizeGiB: + type: integer + minimum: 1 + maximum: 65536 + PersistentVolumeIops: + type: integer + minimum: 100 + maximum: 80000 + PersistentVolumeThroughputMiB: + type: integer + minimum: 125 + maximum: 2000 + MountPath: + type: string + minLength: 1 + maxLength: 255 + PersistentVolumeTtlHours: + type: integer + minimum: 1 + maximum: 8760 ServiceManagedEc2AutoScalingConfiguration: description: The auto scaling configuration settings for a service managed EC2 fleet. type: object @@ -7153,11 +7303,6 @@ components: IdentityCenterInstanceArn: type: string pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} - Region: - type: string - minLength: 1 - maxLength: 25 - pattern: "[a-z0-9-]+" Subdomain: type: string pattern: "[a-z0-9-]{1,100}" @@ -7185,6 +7330,19 @@ components: - NONE - STOP_SCHEDULING_AND_COMPLETE_TASKS - STOP_SCHEDULING_AND_CANCEL_TASKS + JobAttachmentSettings: + description: The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix. + type: object + properties: + s3BucketName: + $ref: "#/components/schemas/S3BucketName" + description: The Amazon S3 bucket name. + rootPrefix: + $ref: "#/components/schemas/S3Prefix" + description: The root prefix. + required: + - s3BucketName + - rootPrefix RequiredFileSystemLocationNames: type: array items: @@ -7417,6 +7575,11 @@ components: type: object DeleteStorageProfileResponse: type: object + VolumeId: + type: string + pattern: volume-[0-9a-f]{32} + DeleteVolumeResponse: + type: object DeleteWorkerResponse: type: object DisassociateMemberFromFarmResponse: @@ -7864,7 +8027,7 @@ components: description: The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users. identityCenterRegion: $ref: "#/components/schemas/Region" - description: The AWS Region where IAM Identity Center is enabled. + description: The Region where IAM Identity Center is enabled. identityCenterApplicationArn: $ref: "#/components/schemas/IdentityCenterApplicationArn" description: The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created. @@ -8269,6 +8432,7 @@ components: enum: - COMPUTE - LICENSE + - PERSISTENT_VOLUME LicenseProduct: type: string Stats: @@ -8457,6 +8621,75 @@ components: - createdAt - createdBy - runStatus + GetVolumeResponse: + description: Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs. + type: object + properties: + volumeId: + $ref: "#/components/schemas/VolumeId" + description: The volume ID. + farmId: + $ref: "#/components/schemas/FarmId" + description: The farm ID of the farm that contains the fleet. + fleetId: + $ref: "#/components/schemas/FleetId" + description: The fleet ID of the fleet that contains the volume. + state: + $ref: "#/components/schemas/VolumeState" + description: The state of the volume. + sizeGiB: + $ref: "#/components/schemas/PersistentVolumeSizeGiB" + description: The volume size in GiB. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The Availability Zone ID of the volume. + attachedWorkerId: + $ref: "#/components/schemas/WorkerId" + description: The worker ID of the worker the volume is attached to. + volumeType: + $ref: "#/components/schemas/EbsVolumeType" + description: The EBS volume type. + iops: + $ref: "#/components/schemas/PersistentVolumeIops" + description: The IOPS of the volume. + throughputMiB: + $ref: "#/components/schemas/PersistentVolumeThroughputMiB" + description: The throughput of the volume in MiB. + createdAt: + $ref: "#/components/schemas/CreatedAt" + description: The date and time the resource was created. + lastAssignedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time the volume was last assigned to a worker. + lastReleasedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time the volume was last released from a worker. + expiresAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time the volume expires and will be deleted. + required: + - volumeId + - farmId + - fleetId + - state + - sizeGiB + - availabilityZoneId + - volumeType + - createdAt + VolumeState: + description: The state of a persistent volume. + type: string + enum: + - PENDING_CREATION + - PENDING_ATTACHMENT + - IN_USE + - AVAILABLE + - PENDING_DELETION + EbsVolumeType: + description: The EBS volume type. + type: string + enum: + - gp3 GetWorkerResponse: description: Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs. type: object @@ -9104,7 +9337,7 @@ components: description: The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users. identityCenterRegion: $ref: "#/components/schemas/Region" - description: The AWS Region where IAM Identity Center is enabled. + description: The Region where IAM Identity Center is enabled. identityCenterApplicationArn: $ref: "#/components/schemas/IdentityCenterApplicationArn" description: The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created. @@ -9824,6 +10057,54 @@ components: - createdAt - createdBy - runStatus + ListVolumesResponse: + description: Shared pagination field for List operation outputs (nextToken). + type: object + properties: + volumes: + $ref: "#/components/schemas/VolumeSummaries" + description: The volumes on the list. + nextToken: + $ref: "#/components/schemas/NextToken" + description: If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error. + required: + - volumes + VolumeSummaries: + type: array + items: + $ref: "#/components/schemas/VolumeSummary" + VolumeSummary: + description: The summary of a persistent volume. + type: object + properties: + volumeId: + $ref: "#/components/schemas/VolumeId" + description: The volume ID. + farmId: + $ref: "#/components/schemas/FarmId" + description: The farm ID of the farm that contains the fleet. + fleetId: + $ref: "#/components/schemas/FleetId" + description: The fleet ID of the fleet that contains the volume. + state: + $ref: "#/components/schemas/VolumeState" + description: The state of the volume. + sizeGiB: + $ref: "#/components/schemas/PersistentVolumeSizeGiB" + description: The volume size in GiB. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The Availability Zone ID of the volume. + attachedWorkerId: + $ref: "#/components/schemas/WorkerId" + description: The worker ID of the worker the volume is attached to. + required: + - volumeId + - farmId + - fleetId + - state + - sizeGiB + - availabilityZoneId ListWorkersResponse: description: Shared pagination field for List operation outputs (nextToken). type: object @@ -11995,6 +12276,48 @@ components: - $ref: "#/components/x-stackQL-resources/metered_products/methods/put_metered_product" delete: - $ref: "#/components/x-stackQL-resources/metered_products/methods/delete_metered_product" + volumes: + id: aws.deadline.volumes + name: volumes + title: volumes + methods: + delete_volume: + operation: + $ref: "#/paths/~12023-10-12~1farms~1{farm_id}~1fleets~1{fleet_id}~1volumes~1{volume_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_volume: + operation: + $ref: "#/paths/~12023-10-12~1farms~1{farm_id}~1fleets~1{fleet_id}~1volumes~1{volume_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_volumes: + operation: + $ref: "#/paths/~12023-10-12~1farms~1{farm_id}~1fleets~1{fleet_id}~1volumes/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.volumes + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/volumes/methods/get_volume" + - $ref: "#/components/x-stackQL-resources/volumes/methods/list_volumes" + insert: [] + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/volumes/methods/delete_volume" monitor_settings: id: aws.deadline.monitor_settings name: monitor_settings diff --git a/providers/src/aws/v00.00.00000/services/devicefarm.yaml b/providers/src/aws/v00.00.00000/services/devicefarm.yaml index a5a0bdaf..7744efd0 100644 --- a/providers/src/aws/v00.00.00000/services/devicefarm.yaml +++ b/providers/src/aws/v00.00.00000/services/devicefarm.yaml @@ -4001,6 +4001,9 @@ components: executionRoleArn: $ref: "#/components/schemas/AmazonRoleResourceName" description: An IAM role to be assumed by the test host for the run. + insightsTypes: + $ref: "#/components/schemas/InsightsTypes" + description: The types of insights to generate for a run. Specify one or more values to opt in to insights generation when scheduling a run. Insights are currently supported for custom mode runs with Instrumentation, Appium Java TestNG, and XCTest UI test types. Location: description: Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491). Elevation is currently not supported. type: object @@ -4055,6 +4058,15 @@ components: gps: $ref: "#/components/schemas/Boolean" description: True if GPS is enabled at the beginning of the test. Otherwise, false. + InsightsTypes: + type: array + items: + $ref: "#/components/schemas/InsightsType" + InsightsType: + description: The type of insights to generate. + type: string + enum: + - TEST_REPORT GetDevicePoolCompatibilityResult: description: Represents the result of describe device pool compatibility request. type: object @@ -4158,6 +4170,9 @@ components: videoCapture: $ref: "#/components/schemas/VideoCapture" description: This value is set to true if video capture is enabled. Otherwise, it is set to false. + insights: + $ref: "#/components/schemas/JobInsights" + description: The insights for the job, including the report status and test-level metrics. This field contains data only if you specified insightsTypes when you scheduled the run. Counters: description: Represents entity counters. type: object @@ -4185,6 +4200,73 @@ components: description: The number of skipped entities. VideoCapture: type: boolean + JobInsights: + description: Contains insights for a job, including report status, and test-level aggregated metrics such as per test execution time and median test execution time. + type: object + properties: + status: + $ref: "#/components/schemas/ReportStatus" + description: The status of the insights report for the job. + testReport: + $ref: "#/components/schemas/TestReport" + description: The test-level aggregated report for the job. + ReportStatus: + description: "The status of an insights report. Possible values are: PENDING: The service has queued the report and generation has not started. RUNNING: The service is generating the report. COMPLETED: The service successfully generated the report. SKIPPED: The service did not generate the report because the necessary conditions were not met. For more information about why the service could not generate the report, view the message field in TestReport or JobReport. ERRORED: An error occurred while generating the report. For more information about why the service could not generate the report, view the message field in TestReport or JobReport." + type: string + enum: + - PENDING + - RUNNING + - COMPLETED + - SKIPPED + - ERRORED + TestReport: + description: Contains aggregated test-level metrics for a job. + type: object + properties: + message: + $ref: "#/components/schemas/ReportMessage" + description: A message associated with the test report. + metrics: + $ref: "#/components/schemas/TestReportMetrics" + description: The aggregated test-level metrics for the job. + testDetailsUrl: + $ref: "#/components/schemas/SensitiveURL" + description: A URL to the detailed test results. + ReportMessage: + type: string + minLength: 0 + maxLength: 4096 + TestReportMetrics: + description: Contains aggregated metrics across all tests in a job. + type: object + properties: + testsTotal: + $ref: "#/components/schemas/Integer" + description: The total number of tests in the job. + testsPassed: + $ref: "#/components/schemas/Integer" + description: The number of tests that passed. + testsFailed: + $ref: "#/components/schemas/Integer" + description: The number of tests that failed. + testsSkipped: + $ref: "#/components/schemas/Integer" + description: The number of tests that were skipped. + testsErrored: + $ref: "#/components/schemas/Integer" + description: The number of tests that errored. + testsOther: + $ref: "#/components/schemas/Integer" + description: The number of tests with other result types. + testsPassedPercentage: + $ref: "#/components/schemas/Double" + description: The percentage of tests that passed. + totalTestExecutionDurationSeconds: + $ref: "#/components/schemas/Double" + description: The total execution duration of all tests in the job, in seconds. + medianTestExecutionDurationSeconds: + $ref: "#/components/schemas/Double" + description: The median execution duration of tests in the job, in seconds. GetNetworkProfileResult: type: object properties: @@ -4340,6 +4422,12 @@ components: environmentVariables: $ref: "#/components/schemas/EnvironmentVariables" description: Environment variables associated with the run. + insightsTypes: + $ref: "#/components/schemas/InsightsTypes" + description: The types of insights requested for the run. + insights: + $ref: "#/components/schemas/RunInsights" + description: The insights for the run, including the report status and job-level metrics. This field contains data only if you specified insightsTypes when you scheduled the run. ExecutionResultCode: type: string enum: @@ -4398,6 +4486,63 @@ components: type: array items: $ref: "#/components/schemas/String" + RunInsights: + description: Contains insights for a run, including report status, and job-level aggregated metrics such as per job execution time and median job execution time. + type: object + properties: + status: + $ref: "#/components/schemas/ReportStatus" + description: The status of the insights report for the run. + jobReport: + $ref: "#/components/schemas/JobReport" + description: The job-level aggregated report for the run. + JobReport: + description: Contains aggregated job-level metrics for a run. + type: object + properties: + message: + $ref: "#/components/schemas/ReportMessage" + description: A message associated with the job report. + metrics: + $ref: "#/components/schemas/JobReportMetrics" + description: The aggregated job-level metrics for the run. + jobDetailsUrl: + $ref: "#/components/schemas/SensitiveURL" + description: A URL to the detailed job results. + JobReportMetrics: + description: Contains aggregated metrics across all jobs in a run. + type: object + properties: + jobsTotal: + $ref: "#/components/schemas/Integer" + description: The total number of jobs in the run. + jobsPassed: + $ref: "#/components/schemas/Integer" + description: The number of jobs that passed. + jobsFailed: + $ref: "#/components/schemas/Integer" + description: The number of jobs that failed. + jobsSkipped: + $ref: "#/components/schemas/Integer" + description: The number of jobs that were skipped. + jobsErrored: + $ref: "#/components/schemas/Integer" + description: The number of jobs that errored. + jobsStopped: + $ref: "#/components/schemas/Integer" + description: The number of jobs that were stopped. + jobsPassedPercentage: + $ref: "#/components/schemas/Double" + description: The percentage of jobs that passed. + totalJobExecutionDurationSeconds: + $ref: "#/components/schemas/Double" + description: The total execution duration of all jobs in the run, in seconds. + averageJobExecutionDurationSeconds: + $ref: "#/components/schemas/Double" + description: The average execution duration of jobs in the run, in seconds. + medianJobExecutionDurationSeconds: + $ref: "#/components/schemas/Double" + description: The median execution duration of jobs in the run, in seconds. GetSuiteResult: description: Represents the result of a get suite request. type: object diff --git a/providers/src/aws/v00.00.00000/services/devops_agent.yaml b/providers/src/aws/v00.00.00000/services/devops_agent.yaml index 92d84496..bbf07ed9 100644 --- a/providers/src/aws/v00.00.00000/services/devops_agent.yaml +++ b/providers/src/aws/v00.00.00000/services/devops_agent.yaml @@ -38,6 +38,8 @@ paths: $ref: "#/components/schemas/ServiceId" configuration: $ref: "#/components/schemas/ServiceConfiguration" + capabilities: + $ref: "#/components/schemas/AssociationCapabilities" required: - serviceId - configuration @@ -81,6 +83,240 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateAgentSpaceOutput" + /asset/agent-space/{agent_space_id}/assets: + post: + operationId: CreateAsset + description: Creates a new asset in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space where the asset will be created + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + assetType: + $ref: "#/components/schemas/AssetType" + metadata: + $ref: "#/components/schemas/Document" + content: + $ref: "#/components/schemas/AssetContent" + clientToken: + $ref: "#/components/schemas/CreateAssetRequestClientTokenString" + required: + - assetType + - content + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAssetResponse" + get: + operationId: ListAssets + description: Lists assets in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space to list assets from + - name: assetType + in: query + required: false + schema: + $ref: "#/components/schemas/AssetType" + description: Filter results to only assets of this type + - name: updatedAfter + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Filter results to only assets updated after this timestamp + - name: updatedBefore + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Filter results to only assets updated before this timestamp + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous response to retrieve the next page of results + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAssetsRequestMaxResultsInteger" + description: The maximum number of results to return in a single response + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssetsResponse" + /asset/agent-space/{agent_space_id}/assets/{asset_id}/files/{path}: + post: + operationId: CreateAssetFile + description: Creates a file in an asset + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset to create the file in + - name: path + in: path + required: true + schema: + $ref: "#/components/schemas/AssetFilePath" + description: The path of the file within the asset + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + $ref: "#/components/schemas/AssetFileBody" + metadata: + $ref: "#/components/schemas/Document" + clientToken: + $ref: "#/components/schemas/CreateAssetFileRequestClientTokenString" + required: + - content + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAssetFileResponse" + delete: + operationId: DeleteAssetFile + description: Deletes a file from an asset + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset containing the file + - name: path + in: path + required: true + schema: + $ref: "#/components/schemas/AssetFilePath" + description: The path of the file within the asset to delete + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssetFileResponse" + get: + operationId: GetAssetFile + description: Gets a file from an asset + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset containing the file + - name: path + in: path + required: true + schema: + $ref: "#/components/schemas/AssetFilePath" + description: The path of the file within the asset to retrieve + - name: assetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/GetAssetFileRequestAssetVersionInteger" + description: The specific asset version to retrieve the file from. If omitted, the latest version is returned. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAssetFileResponse" + patch: + operationId: UpdateAssetFile + description: Updates a file in an asset + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset containing the file + - name: path + in: path + required: true + schema: + $ref: "#/components/schemas/AssetFilePath" + description: The path of the file within the asset to update + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + content: + $ref: "#/components/schemas/AssetFileBody" + metadata: + $ref: "#/components/schemas/Document" + clientToken: + $ref: "#/components/schemas/UpdateAssetFileRequestClientTokenString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAssetFileResponse" /backlog/agent-space/{agent_space_id}/tasks: post: operationId: CreateBacklogTask @@ -190,6 +426,80 @@ paths: application/json: schema: $ref: "#/components/schemas/ListPrivateConnectionsOutput" + /trigger/agent-space/{agent_space_id}/triggers: + post: + operationId: CreateTrigger + description: Creates a new Trigger in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space where the Trigger will be created + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + type: + $ref: "#/components/schemas/TriggerType" + condition: + $ref: "#/components/schemas/TriggerCondition" + action: + $ref: "#/components/schemas/TriggerAction" + status: + $ref: "#/components/schemas/TriggerStatus" + clientToken: + $ref: "#/components/schemas/CreateTriggerRequestClientTokenString" + required: + - type + - condition + - action + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTriggerResponse" + get: + operationId: ListTriggers + description: Lists Triggers in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space whose Triggers should be listed + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/TriggerStatus" + description: Filter results to Triggers in this status + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous response to retrieve the next page of results + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListTriggersRequestMaxResultsInteger" + description: The maximum number of results to return in a single response + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTriggersResponse" /v1/agentspaces/{agent_space_id}: delete: operationId: DeleteAgentSpace @@ -255,6 +565,95 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateAgentSpaceOutput" + /asset/agent-space/{agent_space_id}/assets/{asset_id}: + delete: + operationId: DeleteAsset + description: Deletes an asset and all its files from the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset to delete + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssetResponse" + get: + operationId: GetAsset + description: Gets an asset from the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset to retrieve + - name: assetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/GetAssetRequestAssetVersionInteger" + description: The specific version of the asset to retrieve. If omitted, the latest version is returned. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAssetResponse" + patch: + operationId: UpdateAsset + description: Updates an asset in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset to update + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + metadata: + $ref: "#/components/schemas/Document" + content: + $ref: "#/components/schemas/AssetContent" + clientToken: + $ref: "#/components/schemas/UpdateAssetRequestClientTokenString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAssetResponse" /v1/private-connections/{name}: delete: operationId: DeletePrivateConnection @@ -290,6 +689,87 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribePrivateConnectionOutput" + /trigger/agent-space/{agent_space_id}/triggers/{trigger_id}: + delete: + operationId: DeleteTrigger + description: Deletes a Trigger from the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the Trigger + - name: trigger_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Trigger to delete + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteTriggerResponse" + get: + operationId: GetTrigger + description: Gets a Trigger from the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the Trigger + - name: trigger_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Trigger to retrieve + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetTriggerResponse" + patch: + operationId: UpdateTrigger + description: Updates the status of an existing Trigger + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the Trigger + - name: trigger_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Trigger to update + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + status: + $ref: "#/components/schemas/TriggerStatus" + clientToken: + $ref: "#/components/schemas/UpdateTriggerRequestClientTokenString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTriggerResponse" /v1/services/{service_id}: delete: operationId: DeregisterService @@ -458,6 +938,8 @@ paths: properties: configuration: $ref: "#/components/schemas/ServiceConfiguration" + capabilities: + $ref: "#/components/schemas/AssociationCapabilities" required: - configuration responses: @@ -469,16 +951,46 @@ paths: $ref: "#/components/schemas/UpdateAssociationOutput" /usage/account: get: - operationId: GetAccountUsage - description: Retrieves monthly account usage metrics and limits for the AWS account. - parameters: [] + operationId: GetAccountUsage + description: Retrieves monthly account usage metrics and limits for the AWS account. + parameters: [] + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAccountUsageOutput" + /asset/agent-space/{agent_space_id}/assets/{asset_id}/content: + get: + operationId: GetAssetContent + description: Gets an asset's content as a zip bundle + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset + - name: assetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/GetAssetContentRequestAssetVersionInteger" + description: The specific asset version to export. If omitted, the latest version is returned. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/GetAccountUsageOutput" + $ref: "#/components/schemas/GetAssetContentResponse" /backlog/agent-space/{agent_space_id}/tasks/{task_id}: get: operationId: GetBacklogTask @@ -645,6 +1157,108 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAgentSpacesOutput" + /asset/agent-space/{agent_space_id}/assets/{asset_id}/files: + get: + operationId: ListAssetFiles + description: Lists files in an asset + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset whose files to list + - name: assetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/ListAssetFilesRequestAssetVersionInteger" + description: The specific asset version to list files from. If omitted, files from the latest version are returned. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous response to retrieve the next page of results + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAssetFilesRequestMaxResultsInteger" + description: The maximum number of results to return in a single response + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssetFilesResponse" + /asset/types: + get: + operationId: ListAssetTypes + description: Lists the supported asset types + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous response to retrieve the next page of results + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAssetTypesRequestMaxResultsInteger" + description: The maximum number of results to return in a single response + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssetTypesResponse" + /asset/agent-space/{agent_space_id}/assets/{asset_id}/versions: + get: + operationId: ListAssetVersions + description: Lists versions of an asset in the specified agent space + parameters: + - name: agent_space_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier for the agent space containing the asset + - name: asset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the asset whose versions to list + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAssetVersionsRequestMaxResultsInteger" + description: The maximum number of results to return in a single response + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous response to retrieve the next page of results + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssetVersionsResponse" /v1/agentspaces/{agent_space_id}/associations/list: post: operationId: ListAssociations @@ -1065,6 +1679,10 @@ paths: $ref: "#/components/schemas/KmsKeyArn" privateConnectionName: $ref: "#/components/schemas/PrivateConnectionName" + targetUrlPrivateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + exchangeUrlPrivateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" name: $ref: "#/components/schemas/ServiceName" tags: @@ -1097,13 +1715,15 @@ paths: type: object properties: executionId: - $ref: "#/components/schemas/ResourceId" + $ref: "#/components/schemas/ChatExecutionId" content: $ref: "#/components/schemas/MessageContent" context: $ref: "#/components/schemas/SendMessageContext" userId: $ref: "#/components/schemas/ResourceId" + assetIds: + $ref: "#/components/schemas/AssetIdList" required: - executionId - content @@ -1330,6 +1950,15 @@ components: pagerduty: $ref: "#/components/schemas/PagerDutyConfiguration" description: PagerDuty integration configuration + mcpserversigv4: + $ref: "#/components/schemas/MCPServerSigV4Configuration" + description: SigV4-authenticated MCP server integration configuration. + remoteagent: + $ref: "#/components/schemas/RemoteAgentConfiguration" + description: Remote A2A agent integration configuration (token-based auth). + remoteagentsigv4: + $ref: "#/components/schemas/RemoteAgentSigV4Configuration" + description: Remote A2A agent integration configuration (SigV4 auth). SourceAwsConfiguration: description: "Configuration for AWS source account integration. Note: passRole check on 'assumableRoleArn' is not supported." type: object @@ -1409,6 +2038,9 @@ components: instanceIdentifier: $ref: "#/components/schemas/String" description: GitHub instance identifier (e.g., github.com or github.enterprise.com) + runtimeRoleArn: + $ref: "#/components/schemas/RoleArn" + description: Optional role ARN that AIDevOps assumes at runtime for automatic verification testing and VPC connectivity on this association. required: - repoName - repoId @@ -1516,7 +2148,8 @@ components: - endpoint MCPServerNewRelicConfigurationAccountIdString: type: string - minLength: 6 + minLength: 3 + maxLength: 7 pattern: "[0-9]+" MCPServerNewRelicConfigurationEndpointString: type: string @@ -1554,6 +2187,9 @@ components: instanceIdentifier: $ref: "#/components/schemas/String" description: GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev) + runtimeRoleArn: + $ref: "#/components/schemas/RoleArn" + description: Optional role ARN that AIDevOps assumes at runtime for automatic verification testing and VPC connectivity on this association. required: - projectId - projectPath @@ -1632,6 +2268,25 @@ components: description: Email address type: string pattern: "[a-zA-Z0-9._%+\\-]+@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]{2,}" + MCPServerSigV4Configuration: + description: Configuration for SigV4-authenticated MCP server integration. + type: object + properties: + tools: + $ref: "#/components/schemas/MCPToolsList" + description: List of MCP tools available for the association. + required: + - tools + RemoteAgentConfiguration: + description: Configuration for token-based remote A2A agent integration. + type: object + RemoteAgentSigV4Configuration: + description: Configuration for SigV4-authenticated remote A2A agent integration. + type: object + AssociationCapabilities: + description: Per-capability enablement for the AWS DevOps Agent. Absent capability = disabled. + type: object + properties: {} AssociateServiceOutput: description: Output containing the newly created association and optional webhook configuration. type: object @@ -1668,6 +2323,10 @@ components: configuration: $ref: "#/components/schemas/ServiceConfiguration" description: The configuration that directs how AgentSpace interacts with the given service. + capabilities: + type: object + properties: {} + description: Enabled capabilities for this association. required: - agentSpaceId - createdAt @@ -1799,6 +2458,191 @@ components: - createdAt - updatedAt - agentSpaceId + AssetType: + description: The type of asset (e.g. skill, artifact) + type: string + minLength: 1 + maxLength: 64 + Document: + type: object + AssetContent: + description: "Content for an asset: a single file, a zip bundle, or a source URL to import from" + type: object + properties: + file: + $ref: "#/components/schemas/AssetFileContent" + description: A single file with path and content + zip: + $ref: "#/components/schemas/AssetZipContent" + description: A zip file containing multiple files + sourceUrl: + $ref: "#/components/schemas/AssetSourceUrlContent" + description: A source URL to import asset content from + AssetFileContent: + description: A single file with path and content + type: object + properties: + path: + $ref: "#/components/schemas/AssetFilePath" + description: The path of the file within the asset + body: + $ref: "#/components/schemas/AssetFileBody" + description: The file content + metadata: + $ref: "#/components/schemas/Document" + description: Optional metadata for this file + required: + - path + - body + AssetFilePath: + description: The path of a file within an asset + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9_./ ()-]+" + AssetFileBody: + description: Content of an individual asset file + type: object + properties: + bytes: + $ref: "#/components/schemas/AssetFileBytes" + text: + $ref: "#/components/schemas/AssetFileText" + AssetFileBytes: + description: Binary file content + type: string + format: byte + minLength: 0 + maxLength: 6291456 + AssetFileText: + description: Text file content + type: string + minLength: 0 + maxLength: 1572864 + AssetZipContent: + description: A zip file containing asset files + type: object + properties: + zipFile: + $ref: "#/components/schemas/AssetZipBytes" + description: The zip file bytes + required: + - zipFile + AssetZipBytes: + description: Zip file content as bytes + type: string + format: byte + minLength: 0 + maxLength: 6291456 + AssetSourceUrlContent: + description: Content for an asset sourced from an external URL. + type: object + properties: + url: + $ref: "#/components/schemas/AssetContentUrl" + description: The source URL to import asset content from + required: + - url + AssetContentUrl: + description: URL to a source repository or directory containing asset content + type: string + minLength: 1 + maxLength: 2048 + pattern: https://.* + CreateAssetRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateAssetResponse: + description: Response structure for creating a new asset + type: object + properties: + asset: + $ref: "#/components/schemas/Asset" + description: The asset object + required: + - asset + Asset: + description: Represents an asset in an agent space, including its identifier, type, metadata, version, and timestamps. + type: object + properties: + assetId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for this asset + assetType: + $ref: "#/components/schemas/AssetType" + description: The type of this asset + metadata: + $ref: "#/components/schemas/Document" + description: The metadata for this asset + version: + $ref: "#/components/schemas/Integer" + description: The version number of this asset + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this asset was created + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this asset was last updated + required: + - assetId + - assetType + - metadata + - version + - createdAt + - updatedAt + ResourceId: + description: Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters) + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9_.-]+" + Integer: + type: integer + Timestamp: + type: string + format: date-time + CreateAssetFileRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateAssetFileResponse: + description: Response structure for creating an asset file + type: object + properties: + file: + $ref: "#/components/schemas/AssetFile" + description: The asset file object + required: + - file + AssetFile: + description: Represents a single file within an asset, including its path, content, version, and timestamps. + type: object + properties: + path: + $ref: "#/components/schemas/AssetFilePath" + description: The path of this file within the asset + content: + $ref: "#/components/schemas/AssetFileBody" + description: The content of this file + metadata: + $ref: "#/components/schemas/Document" + description: The metadata for this file + version: + $ref: "#/components/schemas/Integer" + description: The asset version this file belongs to + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this file was created + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this file was last updated + required: + - path + - content + - version + - createdAt + - updatedAt ReferenceInput: description: Reference information linking a task to external systems - for input with validation type: object @@ -1831,12 +2675,6 @@ components: type: string minLength: 1 maxLength: 512 - ResourceId: - description: Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters) - type: string - minLength: 1 - maxLength: 128 - pattern: "[a-zA-Z0-9_.-]+" ReferenceInputReferenceUrlString: type: string minLength: 1 @@ -1847,6 +2685,8 @@ components: enum: - INVESTIGATION - EVALUATION + - RELEASE_READINESS_REVIEW + - RELEASE_TESTING BacklogTaskTitle: description: Title for a backlog task (allows printable ASCII characters, tabs, and newlines; 1-400 characters) type: string @@ -1977,14 +2817,11 @@ components: - FAILED - TIMED_OUT - CANCELED + - SKIPPED BackLogTimestamp: description: Timestamp format used for backlog operations type: string format: date-time - Integer: - type: integer - Document: - type: object Boolean: type: boolean UserType: @@ -2007,9 +2844,6 @@ components: required: - executionId - createdAt - Timestamp: - type: string - format: date-time PrivateConnectionName: description: Unique name for a Private Connection within an account. type: string @@ -2054,6 +2888,9 @@ components: certificate: $ref: "#/components/schemas/CertificateString" description: Certificate for the Private Connection. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set. required: - hostAddress - vpcId @@ -2116,6 +2953,12 @@ components: type: string minLength: 1 maxLength: 32768 + ResourceConfigDnsResolution: + description: DNS resolution mode for a Resource Gateway. + type: string + enum: + - PUBLIC + - IN_VPC SelfManagedInput: description: Configuration for a self-managed Private Connection. type: object @@ -2162,38 +3005,139 @@ components: certificateExpiryTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: DNS resolution mode for the Private Connection's resource gateway. + failureMessage: + $ref: "#/components/schemas/FailureMessage" + description: Message describing the reason for a failed Private Connection creation, if applicable. tags: type: object properties: {} description: Tags associated with the created Private Connection. required: - - name + - name + - type_ + - status + PrivateConnectionType: + description: The type of Private Connection. + type: string + enum: + - SELF_MANAGED + - SERVICE_MANAGED + ResourceGatewayArn: + description: Resource Gateway ARN. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17} + PrivateConnectionStatus: + description: Status of a Private Connection. + type: string + enum: + - ACTIVE + - CREATE_IN_PROGRESS + - CREATE_FAILED + - DELETE_IN_PROGRESS + - DELETE_FAILED + FailureMessage: + description: Failure message describing why a Private Connection has a FAILED status. + type: string + minLength: 1 + maxLength: 1000 + TriggerType: + description: How a Trigger is fired + type: string + minLength: 1 + maxLength: 64 + TriggerCondition: + description: Defines the firing condition for a Trigger + type: object + properties: + schedule: + $ref: "#/components/schemas/ScheduleCondition" + description: Time-based firing condition + ScheduleCondition: + description: Schedule-based condition that fires the Trigger + type: object + properties: + expression: + $ref: "#/components/schemas/ScheduleExpression" + description: The schedule expression + required: + - expression + ScheduleExpression: + description: Schedule expression used by a TIME_BASED Trigger + type: string + minLength: 1 + maxLength: 256 + TriggerAction: + description: Action a Trigger performs when it fires + type: object + TriggerStatus: + description: The status of a Trigger + type: string + minLength: 1 + maxLength: 64 + CreateTriggerRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateTriggerResponse: + description: Response structure for creating a new Trigger + type: object + properties: + trigger: + $ref: "#/components/schemas/Trigger" + description: The Trigger object + required: + - trigger + Trigger: + description: A Trigger fires on a schedule and invokes an agent + type: object + properties: + triggerId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier for this Trigger + agentSpaceId: + $ref: "#/components/schemas/AgentSpaceId" + description: The agent space this Trigger belongs to + type_: + $ref: "#/components/schemas/TriggerType" + description: How this Trigger fires + condition: + $ref: "#/components/schemas/TriggerCondition" + description: The condition that fires this Trigger + action: + $ref: "#/components/schemas/TriggerAction" + description: The action this Trigger performs when it fires + status: + $ref: "#/components/schemas/TriggerStatus" + description: The status of this Trigger + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this Trigger was created + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this Trigger was last updated + required: + - triggerId + - agentSpaceId - type_ + - condition + - action - status - PrivateConnectionType: - description: The type of Private Connection. - type: string - enum: - - SELF_MANAGED - - SERVICE_MANAGED - ResourceGatewayArn: - description: Resource Gateway ARN. - type: string - minLength: 20 - maxLength: 2048 - pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17} - PrivateConnectionStatus: - description: Status of a Private Connection. - type: string - enum: - - ACTIVE - - CREATE_IN_PROGRESS - - CREATE_FAILED - - DELETE_IN_PROGRESS - - DELETE_FAILED + - createdAt + - updatedAt DeleteAgentSpaceOutput: description: Empty output for successful AgentSpace deletion. type: object + DeleteAssetResponse: + description: Response structure for deleting an asset + type: object + DeleteAssetFileResponse: + description: Response structure for deleting an asset file + type: object DeletePrivateConnectionOutput: description: Output containing the status of the Private Connection deletion. type: object @@ -2207,6 +3151,9 @@ components: required: - name - status + DeleteTriggerResponse: + description: Response structure for deleting a Trigger + type: object DeregisterServiceOutput: description: Empty output for successful service deregistration. type: object @@ -2238,6 +3185,12 @@ components: certificateExpiryTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: DNS resolution mode for the Private Connection's resource gateway. + failureMessage: + $ref: "#/components/schemas/FailureMessage" + description: Message describing the reason for a failed Private Connection, if applicable. tags: type: object properties: {} @@ -2273,6 +3226,9 @@ components: agentSpaceId: $ref: "#/components/schemas/AgentSpaceId" description: The unique identifier of the AgentSpace + operatorAppUrl: + $ref: "#/components/schemas/OperatorAppUrl" + description: The URL for operators to access the Operator App iam: $ref: "#/components/schemas/IamAuthConfiguration" idc: @@ -2281,6 +3237,12 @@ components: $ref: "#/components/schemas/IdpAuthConfiguration" required: - agentSpaceId + OperatorAppUrl: + description: The URL for operators to access the Operator App. + type: string + minLength: 1 + maxLength: 2048 + pattern: https://[a-zA-Z0-9.-]+(/.*)? IamAuthConfiguration: description: Configuration for IAM-based authentication flow for the Operator App. type: object @@ -2378,7 +3340,7 @@ components: properties: limit: $ref: "#/components/schemas/Integer" - description: Configured limit for this metric. + description: Configured limit for this metric. A value of -1 indicates no limit is enforced. usage: $ref: "#/components/schemas/Double" description: Current usage for this metric @@ -2403,6 +3365,46 @@ components: description: Tags associated with the AgentSpace. required: - agentSpace + GetAssetRequestAssetVersionInteger: + type: integer + minimum: 1 + GetAssetResponse: + description: Response structure for getting an asset + type: object + properties: + asset: + $ref: "#/components/schemas/Asset" + description: The asset object + required: + - asset + GetAssetContentRequestAssetVersionInteger: + type: integer + minimum: 1 + GetAssetContentResponse: + description: Response structure for getting an asset's content as a zip bundle + type: object + properties: + content: + $ref: "#/components/schemas/AssetZipContent" + description: The asset content as a zip file + version: + $ref: "#/components/schemas/Integer" + description: The asset version this content belongs to + required: + - content + - version + GetAssetFileRequestAssetVersionInteger: + type: integer + minimum: 1 + GetAssetFileResponse: + description: Response structure for getting an asset file + type: object + properties: + file: + $ref: "#/components/schemas/AssetFile" + description: The asset file object + required: + - file GetAssociationOutput: description: Output containing the requested association details. type: object @@ -2424,6 +3426,9 @@ components: description: Output containing the Operator App configuration including authentication details. type: object properties: + operatorAppUrl: + $ref: "#/components/schemas/OperatorAppUrl" + description: The URL for operators to access the Operator App iam: $ref: "#/components/schemas/IamAuthConfiguration" idc: @@ -2476,6 +3481,12 @@ components: additionalContext: $ref: "#/components/schemas/String" description: Additional context for recommendation + rankPosition: + $ref: "#/components/schemas/RecommendationRankPositionInteger" + description: Position in ranked list (1 = highest priority) + rankedAt: + $ref: "#/components/schemas/BackLogTimestamp" + description: Timestamp when the recommendation was last ranked createdAt: $ref: "#/components/schemas/BackLogTimestamp" description: Timestamp when this recommendation was created @@ -2529,6 +3540,9 @@ components: - HIGH - MEDIUM - LOW + RecommendationRankPositionInteger: + type: integer + minimum: 1 GetServiceOutput: description: Output containing the requested service details. type: object @@ -2588,6 +3602,9 @@ components: - mcpserver - mcpserversplunk - azureidentity + - mcpserversigv4 + - remoteagent + - remoteagentsigv4 ServiceName: description: The display name for a registered service. type: string @@ -2639,6 +3656,15 @@ components: pagerduty: $ref: "#/components/schemas/RegisteredPagerDutyDetails" description: Pagerduty service details. + mcpserversigv4: + $ref: "#/components/schemas/RegisteredMCPServerSigV4Details" + description: SigV4-authenticated MCP server-specific service details. + remoteagent: + $ref: "#/components/schemas/RegisteredRemoteAgentDetails" + description: Remote A2A agent-specific service details (token-based auth). + remoteagentsigv4: + $ref: "#/components/schemas/RegisteredRemoteAgentSigV4Details" + description: Remote A2A agent-specific service details (SigV4 auth). RegisteredGithubServiceDetails: description: Details specific to a registered GitHub service. type: object @@ -2782,77 +3808,367 @@ components: $ref: "#/components/schemas/WebIdentityTokenAudienceList" description: The audiences for the Web Identity Token. required: - - tenantId - - clientId - - webIdentityRoleArn - - webIdentityTokenAudiences - Guid: - description: Globally Unique Identifier (GUID) in standard format. - type: string - minLength: 0 - maxLength: 36 - pattern: "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" - WebIdentityTokenAudienceList: - description: List of audiences for Web Identity Token. + - tenantId + - clientId + - webIdentityRoleArn + - webIdentityTokenAudiences + Guid: + description: Globally Unique Identifier (GUID) in standard format. + type: string + minLength: 0 + maxLength: 36 + pattern: "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + WebIdentityTokenAudienceList: + description: List of audiences for Web Identity Token. + type: array + items: + $ref: "#/components/schemas/String" + RegisteredGrafanaServerDetails: + description: Details specific to a registered Grafana server, used by the built-in MCP server. + type: object + properties: + endpoint: + $ref: "#/components/schemas/MCPServerEndpoint" + description: Grafana instance URL (e.g., https://your-instance.grafana.net) + authorizationMethod: + $ref: "#/components/schemas/MCPServerAuthorizationMethod" + description: The authz method used by the MCP server. + required: + - endpoint + - authorizationMethod + MCPServerEndpoint: + description: HTTPS endpoint URL for an MCP server. + type: string + minLength: 1 + maxLength: 2048 + pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? + RegisteredPagerDutyDetails: + description: Details specific to a registered PagerDuty service. + type: object + properties: + scopes: + $ref: "#/components/schemas/PagerDutyScopesList" + description: The scopes that were assigned to the service + required: + - scopes + PagerDutyScopesList: + description: PagerDuty list of scopes. + type: array + items: + $ref: "#/components/schemas/String" + RegisteredMCPServerSigV4Details: + description: Details specific to a registered SigV4-authenticated MCP server. + type: object + properties: + name: + $ref: "#/components/schemas/MCPServerName" + description: MCP server name. + endpoint: + $ref: "#/components/schemas/MCPServerEndpoint" + description: MCP server endpoint URL. + description: + $ref: "#/components/schemas/RegisteredMCPServerSigV4DetailsDescriptionString" + description: Optional description for the MCP server. + region: + $ref: "#/components/schemas/SigV4Region" + description: AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing. + service: + $ref: "#/components/schemas/RegisteredMCPServerSigV4DetailsServiceString" + description: AWS service name for SigV4 signing. + roleArn: + $ref: "#/components/schemas/RegisteredMCPServerSigV4DetailsRoleArnString" + description: IAM role ARN to assume for SigV4 signing. + mcpRoleArn: + $ref: "#/components/schemas/RoleArn" + customHeaders: + type: object + properties: {} + description: Custom headers for the SigV4 MCP server. + required: + - name + - endpoint + - region + - service + - roleArn + MCPServerName: + description: Name identifier for an MCP server. + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + RegisteredMCPServerSigV4DetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + SigV4Region: + description: AWS region identifier or wildcard (*) for SigV4a multi-region signing. + type: string + minLength: 1 + maxLength: 50 + pattern: (\*|[a-z]{2,4}(-[a-z]+)+-\d+) + RegisteredMCPServerSigV4DetailsServiceString: + type: string + minLength: 1 + maxLength: 100 + RegisteredMCPServerSigV4DetailsRoleArnString: + type: string + minLength: 0 + maxLength: 255 + RegisteredRemoteAgentDetails: + description: Details specific to a registered token-based remote A2A agent. + type: object + properties: + name: + $ref: "#/components/schemas/RemoteAgentName" + endpoint: + $ref: "#/components/schemas/RemoteAgentEndpoint" + description: + $ref: "#/components/schemas/RegisteredRemoteAgentDetailsDescriptionString" + authorizationMethod: + $ref: "#/components/schemas/RemoteAgentAuthorizationMethod" + description: The authorization method used by the remote agent. + apiKeyHeader: + $ref: "#/components/schemas/String" + description: If the remote agent uses API key authentication, the header name. + required: + - name + - endpoint + - authorizationMethod + RemoteAgentName: + description: Name identifier for a remote A2A agent. + type: string + minLength: 1 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + RemoteAgentEndpoint: + description: HTTPS endpoint URL for a remote A2A agent. + type: string + minLength: 1 + maxLength: 2048 + pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? + RegisteredRemoteAgentDetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + RemoteAgentAuthorizationMethod: + description: Supported authorization methods for remote A2A agents. + type: string + enum: + - oauth-client-credentials + - api-key + - bearer-token + RegisteredRemoteAgentSigV4Details: + description: Details specific to a registered SigV4-authenticated remote A2A agent. + type: object + properties: + name: + $ref: "#/components/schemas/RemoteAgentName" + endpoint: + $ref: "#/components/schemas/RemoteAgentEndpoint" + description: + $ref: "#/components/schemas/RegisteredRemoteAgentSigV4DetailsDescriptionString" + region: + $ref: "#/components/schemas/SigV4Region" + service: + $ref: "#/components/schemas/RegisteredRemoteAgentSigV4DetailsServiceString" + description: The AWS service name for SigV4 signing. + roleArn: + $ref: "#/components/schemas/RoleArn" + required: + - name + - endpoint + - region + - service + RegisteredRemoteAgentSigV4DetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + RegisteredRemoteAgentSigV4DetailsServiceString: + type: string + minLength: 1 + maxLength: 100 + GetTriggerResponse: + description: Response structure for getting a Trigger + type: object + properties: + trigger: + $ref: "#/components/schemas/Trigger" + description: The Trigger object + required: + - trigger + ListAgentSpacesInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + NextToken: + description: Pagination token for list operations (1-2048 characters) + type: string + minLength: 1 + maxLength: 2048 + ListAgentSpacesOutput: + description: Output containing a list of AgentSpaces and pagination token. + type: object + properties: + nextToken: + $ref: "#/components/schemas/NextToken" + description: Token to retrieve the next page of results, if there are more results. + agentSpaces: + $ref: "#/components/schemas/AgentSpaceList" + description: The list of AgentSpaces. + required: + - agentSpaces + AgentSpaceList: + description: A list of AgentSpace resources. + type: array + items: + $ref: "#/components/schemas/AgentSpace" + ListAssetFilesRequestAssetVersionInteger: + type: integer + minimum: 1 + ListAssetFilesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAssetFilesResponse: + description: Response structure for listing asset files + type: object + properties: + items_: + $ref: "#/components/schemas/AssetFileSummaryList" + description: The list of asset file summaries + nextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to retrieve the next page of results. Absent when there are no more results. + required: + - items_ + AssetFileSummaryList: + type: array + items: + $ref: "#/components/schemas/AssetFileSummary" + AssetFileSummary: + description: Summary of a file within an asset, including its path, version, and timestamps. + type: object + properties: + path: + $ref: "#/components/schemas/AssetFilePath" + description: The path of this file within the asset + metadata: + $ref: "#/components/schemas/Document" + description: The metadata for this file + version: + $ref: "#/components/schemas/Integer" + description: The asset version this file belongs to + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this file was created + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this file was last updated + required: + - path + - version + - createdAt + - updatedAt + ListAssetTypesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAssetTypesResponse: + description: Response structure for listing asset types + type: object + properties: + items_: + $ref: "#/components/schemas/AssetTypeList" + description: The list of supported asset types + nextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to retrieve the next page of results. Absent when there are no more results. + required: + - items_ + AssetTypeList: type: array items: - $ref: "#/components/schemas/String" - RegisteredGrafanaServerDetails: - description: Details specific to a registered Grafana server, used by the built-in MCP server. + $ref: "#/components/schemas/AssetTypeSummary" + AssetTypeSummary: + description: Summary of an asset type, including its identifier and description. type: object properties: - endpoint: - $ref: "#/components/schemas/RegisteredGrafanaServerDetailsEndpointString" - description: Grafana instance URL (e.g., https://your-instance.grafana.net) - authorizationMethod: - $ref: "#/components/schemas/MCPServerAuthorizationMethod" - description: The authz method used by the MCP server. + assetType: + $ref: "#/components/schemas/AssetType" + description: The asset type identifier + description: + $ref: "#/components/schemas/AssetTypeSummaryDescriptionString" + description: A description of the asset type required: - - endpoint - - authorizationMethod - RegisteredGrafanaServerDetailsEndpointString: + - assetType + - description + AssetTypeSummaryDescriptionString: type: string - pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? - RegisteredPagerDutyDetails: - description: Details specific to a registered PagerDuty service. + minLength: 0 + maxLength: 1024 + ListAssetVersionsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAssetVersionsResponse: + description: Response structure for listing asset versions type: object properties: - scopes: - $ref: "#/components/schemas/PagerDutyScopesList" - description: The scopes that were assigned to the service + items_: + $ref: "#/components/schemas/AssetVersionMetadataList" + description: The list of version metadata for the asset + nextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to retrieve the next page of results. Absent when there are no more results. required: - - scopes - PagerDutyScopesList: - description: PagerDuty list of scopes. + - items_ + AssetVersionMetadataList: type: array items: - $ref: "#/components/schemas/String" - ListAgentSpacesInputMaxResultsInteger: + $ref: "#/components/schemas/AssetVersionMetadata" + AssetVersionMetadata: + description: Metadata for a single version of an asset, including the version number and timestamps. + type: object + properties: + version: + $ref: "#/components/schemas/Integer" + description: The version number of this asset + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this asset version was created + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when this asset version was last updated + required: + - version + - createdAt + - updatedAt + ListAssetsRequestMaxResultsInteger: type: integer minimum: 1 maximum: 100 - NextToken: - description: Pagination token for list operations (1-2048 characters) - type: string - minLength: 1 - maxLength: 2048 - ListAgentSpacesOutput: - description: Output containing a list of AgentSpaces and pagination token. + ListAssetsResponse: + description: Response structure for listing assets type: object properties: + items_: + $ref: "#/components/schemas/AssetList" + description: The list of assets for the agent space nextToken: $ref: "#/components/schemas/NextToken" - description: Token to retrieve the next page of results, if there are more results. - agentSpaces: - $ref: "#/components/schemas/AgentSpaceList" - description: The list of AgentSpaces. + description: Pagination token to retrieve the next page of results. Absent when there are no more results. required: - - agentSpaces - AgentSpaceList: - description: A list of AgentSpace resources. + - items_ + AssetList: type: array items: - $ref: "#/components/schemas/AgentSpace" + $ref: "#/components/schemas/Asset" ListAssociationsInputMaxResultsInteger: type: integer minimum: 1 @@ -3360,6 +4676,12 @@ components: certificateExpiryTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: DNS resolution mode for the Private Connection's resource gateway. + failureMessage: + $ref: "#/components/schemas/FailureMessage" + description: Message describing the reason for a failed Private Connection, if applicable. required: - name - type_ @@ -3416,6 +4738,27 @@ components: description: Tags associated with the resource. required: - tags + ListTriggersRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListTriggersResponse: + description: Response structure for listing Triggers + type: object + properties: + items_: + $ref: "#/components/schemas/TriggerList" + description: The list of Triggers + nextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to retrieve the next page of results + required: + - items_ + TriggerList: + description: List of Triggers + type: array + items: + $ref: "#/components/schemas/Trigger" ListWebhooksOutput: description: Output containing a list of service association webhooks. type: object @@ -3468,6 +4811,9 @@ components: - mcpserver - mcpserversplunk - azureidentity + - mcpserversigv4 + - remoteagent + - remoteagentsigv4 ServiceDetails: description: Union of service-specific configuration details for service registration. type: object @@ -3505,6 +4851,15 @@ components: azureidentity: $ref: "#/components/schemas/RegisteredAzureIdentityDetails" description: Azure integration with AWS Outbound Identity Federation specific service details. + mcpserversigv4: + $ref: "#/components/schemas/MCPServerSigV4ServiceDetails" + description: SigV4-authenticated MCP server-specific service details. + remoteagent: + $ref: "#/components/schemas/RemoteAgentServiceDetails" + description: Remote A2A agent service details (token-based auth). + remoteagentsigv4: + $ref: "#/components/schemas/RemoteAgentSigV4ServiceDetails" + description: Remote A2A agent service details (SigV4 auth). DynatraceServiceDetails: description: Complete service details for Dynatrace integration. type: object @@ -3559,7 +4914,7 @@ components: type: string minLength: 1 maxLength: 255 - pattern: "[a-zA-Z0-9._-]+" + pattern: "[\\u0020-\\u007E]+" ClientSecret: description: Client secret for service authentication. type: string @@ -3615,10 +4970,10 @@ components: type: object properties: name: - $ref: "#/components/schemas/DatadogServiceDetailsNameString" + $ref: "#/components/schemas/MCPServerName" description: MCP server name. endpoint: - $ref: "#/components/schemas/DatadogServiceDetailsEndpointString" + $ref: "#/components/schemas/MCPServerEndpoint" description: MCP server endpoint URL. description: $ref: "#/components/schemas/DatadogServiceDetailsDescriptionString" @@ -3630,12 +4985,6 @@ components: - name - endpoint - authorizationConfig - DatadogServiceDetailsNameString: - type: string - pattern: "[a-zA-Z0-9_-]+" - DatadogServiceDetailsEndpointString: - type: string - pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? DatadogServiceDetailsDescriptionString: description: Description field type: string @@ -3666,10 +5015,10 @@ components: type: object properties: name: - $ref: "#/components/schemas/MCPServerDetailsNameString" + $ref: "#/components/schemas/MCPServerName" description: MCP server name. endpoint: - $ref: "#/components/schemas/MCPServerDetailsEndpointString" + $ref: "#/components/schemas/MCPServerEndpoint" description: MCP server endpoint URL. description: $ref: "#/components/schemas/MCPServerDetailsDescriptionString" @@ -3681,12 +5030,6 @@ components: - name - endpoint - authorizationConfig - MCPServerDetailsNameString: - type: string - pattern: "[a-zA-Z0-9_-]+" - MCPServerDetailsEndpointString: - type: string - pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? MCPServerDetailsDescriptionString: description: Description field type: string @@ -3751,7 +5094,13 @@ components: description: List of OAuth scopes. type: array items: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/OAuthScope" + OAuthScope: + description: OAuth scope parameter + type: string + minLength: 1 + maxLength: 128 + pattern: "[!#-\\[\\]-~]+" MCPServerOAuth3LOConfig: description: OAuth 3-legged authorization configuration for MCP server. type: object @@ -3776,7 +5125,7 @@ components: $ref: "#/components/schemas/MCPServerOAuth3LOConfigExchangeUrlString" description: OAuth token exchange URL. clientSecret: - $ref: "#/components/schemas/ClientSecret" + $ref: "#/components/schemas/MCPServerOAuth3LOConfigClientSecretString" description: OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE. supportCodeChallenge: $ref: "#/components/schemas/Boolean" @@ -3803,6 +5152,12 @@ components: MCPServerOAuth3LOConfigExchangeUrlString: type: string pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? + MCPServerOAuth3LOConfigClientSecretString: + description: Client secret for service authentication. + type: string + minLength: 0 + maxLength: 512 + pattern: "[\\S]*" MCPServerAPIKeyConfig: description: API key configuration for MCP server. type: object @@ -3933,6 +5288,8 @@ components: pattern: NRAK-[A-Z0-9]+ NewRelicApiKeyConfigAccountIdString: type: string + minLength: 3 + maxLength: 7 pattern: "[0-9]+" NewRelicApplicationIds: description: List of New Relic application IDs @@ -3975,10 +5332,10 @@ components: type: object properties: name: - $ref: "#/components/schemas/GrafanaServiceDetailsNameString" + $ref: "#/components/schemas/MCPServerName" description: MCP server name. endpoint: - $ref: "#/components/schemas/GrafanaServiceDetailsEndpointString" + $ref: "#/components/schemas/MCPServerEndpoint" description: MCP server endpoint URL. description: $ref: "#/components/schemas/GrafanaServiceDetailsDescriptionString" @@ -3990,12 +5347,6 @@ components: - name - endpoint - authorizationConfig - GrafanaServiceDetailsNameString: - type: string - pattern: "[a-zA-Z0-9_-]+" - GrafanaServiceDetailsEndpointString: - type: string - pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? GrafanaServiceDetailsDescriptionString: description: Description field type: string @@ -4023,34 +5374,257 @@ components: description: Authorization configuration options for PagerDuty service. type: object properties: - oAuthClientCredentials: - $ref: "#/components/schemas/PagerDutyOAuthClientCredentialsConfig" - description: OAuth client credentials configuration. - PagerDutyOAuthClientCredentialsConfig: - description: OAuth client credentials configuration for PagerDuty. + oAuthClientCredentials: + $ref: "#/components/schemas/PagerDutyOAuthClientCredentialsConfig" + description: OAuth client credentials configuration. + PagerDutyOAuthClientCredentialsConfig: + description: OAuth client credentials configuration for PagerDuty. + type: object + properties: + clientName: + $ref: "#/components/schemas/PagerDutyOAuthClientCredentialsConfigClientNameString" + description: User friendly OAuth client name specified by end user. + clientId: + $ref: "#/components/schemas/ClientId" + description: OAuth client ID for authenticating with the service. + exchangeParameters: + type: object + properties: {} + description: OAuth token exchange parameters for authenticating with the service. + clientSecret: + $ref: "#/components/schemas/ClientSecret" + description: OAuth client secret for authenticating with the service. + required: + - clientId + - clientSecret + PagerDutyOAuthClientCredentialsConfigClientNameString: + type: string + minLength: 1 + maxLength: 100 + pattern: "[\\p{L}\\p{N}\\p{Z}._-]+" + MCPServerSigV4ServiceDetails: + description: Complete service details for SigV4-authenticated MCP server integration. + type: object + properties: + name: + $ref: "#/components/schemas/MCPServerName" + description: MCP server name. + endpoint: + $ref: "#/components/schemas/MCPServerEndpoint" + description: MCP server endpoint URL. + description: + $ref: "#/components/schemas/MCPServerSigV4ServiceDetailsDescriptionString" + description: Optional description for the MCP server. + authorizationConfig: + $ref: "#/components/schemas/MCPServerSigV4AuthorizationConfig" + description: MCP Server SigV4 authorization configuration. + required: + - name + - endpoint + - authorizationConfig + MCPServerSigV4ServiceDetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + MCPServerSigV4AuthorizationConfig: + description: Authorization configuration for SigV4-authenticated MCP server. + type: object + properties: + region: + $ref: "#/components/schemas/SigV4Region" + description: AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing. + service: + $ref: "#/components/schemas/MCPServerSigV4AuthorizationConfigServiceString" + description: AWS service name for SigV4 signing. + roleArn: + $ref: "#/components/schemas/MCPServerSigV4AuthorizationConfigRoleArnString" + description: Deprecated — use mcpRoleArn instead. IAM role ARN to assume for SigV4 signing. + mcpRoleArn: + $ref: "#/components/schemas/RoleArn" + description: IAM role ARN to assume for SigV4 signing. Optional — when omitted, credentials are resolved at runtime via a monitor account association. + customHeaders: + type: object + properties: {} + description: Custom headers for the SigV4 MCP server. + required: + - region + - service + MCPServerSigV4AuthorizationConfigServiceString: + type: string + minLength: 1 + maxLength: 100 + MCPServerSigV4AuthorizationConfigRoleArnString: + type: string + minLength: 0 + maxLength: 255 + RemoteAgentServiceDetails: + description: Complete service details for token-based remote A2A agent integration. + type: object + properties: + name: + $ref: "#/components/schemas/RemoteAgentName" + endpoint: + $ref: "#/components/schemas/RemoteAgentEndpoint" + description: + $ref: "#/components/schemas/RemoteAgentServiceDetailsDescriptionString" + authorizationConfig: + $ref: "#/components/schemas/RemoteAgentAuthorizationConfig" + description: Remote agent authorization configuration. + required: + - name + - endpoint + - authorizationConfig + RemoteAgentServiceDetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + RemoteAgentAuthorizationConfig: + description: Authorization configuration for remote A2A agents with token-based auth (API key, OAuth, bearer token). + type: object + properties: + apiKey: + $ref: "#/components/schemas/RemoteAgentAPIKeyConfig" + description: Remote agent configuration with API key authentication. + oAuthClientCredentials: + $ref: "#/components/schemas/RemoteAgentOAuthClientCredentialsConfig" + description: Remote agent configuration with OAuth client credentials. + bearerToken: + $ref: "#/components/schemas/RemoteAgentBearerTokenConfig" + description: Remote agent configuration with Bearer token (RFC 6750). + RemoteAgentAPIKeyConfig: + description: API key configuration for remote A2A agent. + type: object + properties: + apiKeyName: + $ref: "#/components/schemas/RemoteAgentAPIKeyConfigApiKeyNameString" + description: User friendly API key name specified by end user. + apiKeyValue: + $ref: "#/components/schemas/RemoteAgentAPIKeyConfigApiKeyValueString" + description: API key value for authenticating with the service. + apiKeyHeader: + $ref: "#/components/schemas/RemoteAgentAPIKeyConfigApiKeyHeaderString" + description: HTTP header name to send the API key in requests to the service. + required: + - apiKeyName + - apiKeyValue + - apiKeyHeader + RemoteAgentAPIKeyConfigApiKeyNameString: + type: string + pattern: "[a-zA-Z0-9_\\s-]+" + RemoteAgentAPIKeyConfigApiKeyValueString: + description: API Key Value for service. + type: string + minLength: 1 + pattern: "[!-~]([ \\t]*[!-~])*" + RemoteAgentAPIKeyConfigApiKeyHeaderString: + type: string + pattern: "[a-zA-Z0-9-_]+" + RemoteAgentOAuthClientCredentialsConfig: + description: OAuth client credentials configuration for remote A2A agent. + type: object + properties: + clientName: + $ref: "#/components/schemas/RemoteAgentOAuthClientCredentialsConfigClientNameString" + description: User friendly OAuth client name specified by end user. + clientId: + $ref: "#/components/schemas/ClientId" + description: OAuth client ID for authenticating with the service. + exchangeParameters: + type: object + properties: {} + description: OAuth token exchange parameters for authenticating with the service. + clientSecret: + $ref: "#/components/schemas/ClientSecret" + description: OAuth client secret for authenticating with the service. + exchangeUrl: + $ref: "#/components/schemas/RemoteAgentOAuthClientCredentialsConfigExchangeUrlString" + description: OAuth token exchange URL. + scopes: + $ref: "#/components/schemas/Scopes" + description: OAuth scopes for authentication. + required: + - clientId + - clientSecret + - exchangeUrl + RemoteAgentOAuthClientCredentialsConfigClientNameString: + type: string + minLength: 1 + maxLength: 100 + pattern: "[\\p{L}\\p{N}\\p{Z}._-]+" + RemoteAgentOAuthClientCredentialsConfigExchangeUrlString: + type: string + pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)? + RemoteAgentBearerTokenConfig: + description: Bearer token configuration for remote A2A agent (RFC 6750). + type: object + properties: + tokenName: + $ref: "#/components/schemas/RemoteAgentBearerTokenConfigTokenNameString" + description: User friendly bearer token name specified by end user. + tokenValue: + $ref: "#/components/schemas/RemoteAgentBearerTokenConfigTokenValueString" + description: Bearer token value in alphanumeric for authenticating with the service. + authorizationHeader: + $ref: "#/components/schemas/RemoteAgentBearerTokenConfigAuthorizationHeaderString" + description: HTTP header name to send the bearer token in requests to the service. Defaults to 'Authorization' per RFC 6750. + required: + - tokenName + - tokenValue + RemoteAgentBearerTokenConfigTokenNameString: + type: string + pattern: "[a-zA-Z0-9_\\s-]+" + RemoteAgentBearerTokenConfigTokenValueString: + description: Token value for authentication. + type: string + pattern: "[\\S]+" + RemoteAgentBearerTokenConfigAuthorizationHeaderString: + type: string + pattern: "[a-zA-Z0-9-]+" + RemoteAgentSigV4ServiceDetails: + description: Complete service details for SigV4-authenticated remote A2A agent integration. + type: object + properties: + name: + $ref: "#/components/schemas/RemoteAgentName" + endpoint: + $ref: "#/components/schemas/RemoteAgentEndpoint" + description: + $ref: "#/components/schemas/RemoteAgentSigV4ServiceDetailsDescriptionString" + authorizationConfig: + $ref: "#/components/schemas/RemoteAgentSigV4AuthorizationConfig" + description: Remote agent SigV4 authorization configuration. + required: + - name + - endpoint + - authorizationConfig + RemoteAgentSigV4ServiceDetailsDescriptionString: + description: Description field + type: string + minLength: 0 + maxLength: 500 + pattern: "[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]+" + RemoteAgentSigV4AuthorizationConfig: + description: SigV4 authorization configuration for remote A2A agent. type: object properties: - clientName: - $ref: "#/components/schemas/PagerDutyOAuthClientCredentialsConfigClientNameString" - description: User friendly OAuth client name specified by end user. - clientId: - $ref: "#/components/schemas/ClientId" - description: OAuth client ID for authenticating with the service. - exchangeParameters: - type: object - properties: {} - description: OAuth token exchange parameters for authenticating with the service. - clientSecret: - $ref: "#/components/schemas/ClientSecret" - description: OAuth client secret for authenticating with the service. + region: + $ref: "#/components/schemas/SigV4Region" + service: + $ref: "#/components/schemas/RemoteAgentSigV4AuthorizationConfigServiceString" + description: The AWS service name for SigV4 signing. + roleArn: + $ref: "#/components/schemas/RoleArn" required: - - clientId - - clientSecret - PagerDutyOAuthClientCredentialsConfigClientNameString: + - region + - service + RemoteAgentSigV4AuthorizationConfigServiceString: type: string minLength: 1 maxLength: 100 - pattern: "[\\p{L}\\p{N}\\p{Z}._-]+" RegisterServiceOutput: description: Output containing the service ID and any additional steps required for registration. type: object @@ -4084,6 +5658,10 @@ components: description: The URL to redirect the user to for OAuth authorization. required: - authorizationUrl + ChatExecutionId: + description: Chat execution identifier — must be a valid UUID + type: string + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" MessageContent: description: Message content with size constraint type: string @@ -4101,7 +5679,12 @@ components: description: The ID of the last message in the conversation userActionResponse: $ref: "#/components/schemas/String" - description: Response to a UI prompt (not a text conversation message) + description: 'Response to a UI prompt (not a text conversation message). Operator App SDK clients set this to the control-string sentinel `"APPROVAL_ACTION"` when the request is resuming a paused tool call after an operator approval decision; in that case the structured decision context lives on the sibling `approvalAction` member and the chat agent reads from there. Preserved as a String for back-compat: pre-typed-approval clients still encode arbitrary UI-prompt responses as JSON in this field, and the chat agent parses them out during the transition.' + AssetIdList: + description: List of asset identifiers to attach to a message + type: array + items: + $ref: "#/components/schemas/String" SendMessageResponse: description: Response structure for sending chat message events type: object @@ -4321,6 +5904,32 @@ components: $ref: "#/components/schemas/AgentSpace" required: - agentSpace + UpdateAssetRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + UpdateAssetResponse: + description: Response structure for updating an asset + type: object + properties: + asset: + $ref: "#/components/schemas/Asset" + description: The asset object + required: + - asset + UpdateAssetFileRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + UpdateAssetFileResponse: + description: Response structure for updating an asset file + type: object + properties: + file: + $ref: "#/components/schemas/AssetFile" + description: The asset file object + required: + - file UpdateAssociationOutput: description: Output containing the updated association and optional webhook configuration. type: object @@ -4399,6 +6008,12 @@ components: certificateExpiryTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: DNS resolution mode for the Private Connection's resource gateway. + failureMessage: + $ref: "#/components/schemas/FailureMessage" + description: Message describing the reason for a failed Private Connection update, if applicable. required: - name - type_ @@ -4412,6 +6027,19 @@ components: description: The updated recommendation required: - recommendation + UpdateTriggerRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + UpdateTriggerResponse: + description: Response structure for updating a Trigger + type: object + properties: + trigger: + $ref: "#/components/schemas/Trigger" + description: The Trigger object + required: + - trigger ValidateAwsAssociationsOutput: description: Empty Output for successful validating an aws association type: object @@ -4582,6 +6210,144 @@ components: - $ref: "#/components/x-stackQL-resources/agent_spaces/methods/update_agent_space" delete: - $ref: "#/components/x-stackQL-resources/agent_spaces/methods/delete_agent_space" + assets: + id: aws.devops_agent.assets + name: assets + title: assets + methods: + create_asset: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_assets: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_asset: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_asset: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.asset + request: + nativeCasing: pascal + update_asset: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/assets/methods/get_asset" + - $ref: "#/components/x-stackQL-resources/assets/methods/list_assets" + insert: + - $ref: "#/components/x-stackQL-resources/assets/methods/create_asset" + update: + - $ref: "#/components/x-stackQL-resources/assets/methods/update_asset" + delete: + - $ref: "#/components/x-stackQL-resources/assets/methods/delete_asset" + asset_files: + id: aws.devops_agent.asset_files + name: asset_files + title: asset_files + methods: + create_asset_file: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1files~1{path}/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_asset_file: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1files~1{path}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_asset_file: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1files~1{path}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.file + request: + nativeCasing: pascal + update_asset_file: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1files~1{path}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_asset_files: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1files/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/asset_files/methods/get_asset_file" + - $ref: "#/components/x-stackQL-resources/asset_files/methods/list_asset_files" + insert: + - $ref: "#/components/x-stackQL-resources/asset_files/methods/create_asset_file" + update: + - $ref: "#/components/x-stackQL-resources/asset_files/methods/update_asset_file" + delete: + - $ref: "#/components/x-stackQL-resources/asset_files/methods/delete_asset_file" backlog_tasks: id: aws.devops_agent.backlog_tasks name: backlog_tasks @@ -4727,6 +6493,73 @@ components: - $ref: "#/components/x-stackQL-resources/private_connections/methods/update_private_connection_certificate" delete: - $ref: "#/components/x-stackQL-resources/private_connections/methods/delete_private_connection" + triggers: + id: aws.devops_agent.triggers + name: triggers + title: triggers + methods: + create_trigger: + operation: + $ref: "#/paths/~1trigger~1agent-space~1{agent_space_id}~1triggers/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_triggers: + operation: + $ref: "#/paths/~1trigger~1agent-space~1{agent_space_id}~1triggers/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_trigger: + operation: + $ref: "#/paths/~1trigger~1agent-space~1{agent_space_id}~1triggers~1{trigger_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_trigger: + operation: + $ref: "#/paths/~1trigger~1agent-space~1{agent_space_id}~1triggers~1{trigger_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.trigger + update_trigger: + operation: + $ref: "#/paths/~1trigger~1agent-space~1{agent_space_id}~1triggers~1{trigger_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/triggers/methods/get_trigger" + - $ref: "#/components/x-stackQL-resources/triggers/methods/list_triggers" + insert: + - $ref: "#/components/x-stackQL-resources/triggers/methods/create_trigger" + update: + - $ref: "#/components/x-stackQL-resources/triggers/methods/update_trigger" + delete: + - $ref: "#/components/x-stackQL-resources/triggers/methods/delete_trigger" associations: id: aws.devops_agent.associations name: associations @@ -4798,6 +6631,25 @@ components: insert: [] update: [] delete: [] + asset_contents: + id: aws.devops_agent.asset_contents + name: asset_contents + title: asset_contents + methods: + get_asset_content: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1content/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/asset_contents/methods/get_asset_content" + insert: [] + update: [] + delete: [] operator_apps: id: aws.devops_agent.operator_apps name: operator_apps @@ -4871,6 +6723,62 @@ components: update: - $ref: "#/components/x-stackQL-resources/recommendations/methods/update_recommendation" delete: [] + asset_types: + id: aws.devops_agent.asset_types + name: asset_types + title: asset_types + methods: + list_asset_types: + operation: + $ref: "#/paths/~1asset~1types/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/asset_types/methods/list_asset_types" + insert: [] + update: [] + delete: [] + asset_versions: + id: aws.devops_agent.asset_versions + name: asset_versions + title: asset_versions + methods: + list_asset_versions: + operation: + $ref: "#/paths/~1asset~1agent-space~1{agent_space_id}~1assets~1{asset_id}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/asset_versions/methods/list_asset_versions" + insert: [] + update: [] + delete: [] executions: id: aws.devops_agent.executions name: executions diff --git a/providers/src/aws/v00.00.00000/services/directconnect.yaml b/providers/src/aws/v00.00.00000/services/directconnect.yaml index 50b65b5a..5d5b34e4 100644 --- a/providers/src/aws/v00.00.00000/services/directconnect.yaml +++ b/providers/src/aws/v00.00.00000/services/directconnect.yaml @@ -1077,10 +1077,10 @@ paths: description: The ID of the virtual interface. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." customerAddress: $ref: "#/components/schemas/CustomerAddress" description: The IP address assigned to the customer interface. @@ -1930,7 +1930,7 @@ paths: /DescribeVirtualInterfaces: post: operationId: DescribeVirtualInterfaces - description: Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network. If you're using an asn, the response includes ASN value in both the asn and asnLong fields. If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support + description: Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network. If you're using an asn, the response includes the ASN value in both the asn and asnLong fields. If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support parameters: - name: X-Amz-Target in: header @@ -2041,6 +2041,46 @@ paths: application/json: schema: $ref: "#/components/schemas/DisassociateMacSecKeyResponse" + /ListVirtualInterfaceRoutes: + post: + operationId: ListVirtualInterfaceRoutes + description: "Lists the routes for the specified virtual interface. Use the routeDirection filter to control which routes are returned: accepted: routes received from the customer network over the virtual interface. advertised: routes advertised to the customer network over the virtual interface." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - OvertureService.ListVirtualInterfaceRoutes + default: OvertureService.ListVirtualInterfaceRoutes + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + virtualInterfaceId: + $ref: "#/components/schemas/VirtualInterfaceId" + description: The ID of the virtual interface. + filters: + $ref: "#/components/schemas/RouteFilters" + description: The filters to apply to the routes returned. + maxResults: + $ref: "#/components/schemas/MaxResultSetSize" + description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next page of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListVirtualInterfaceRoutesResponse" /ListVirtualInterfaceTestHistory: post: operationId: ListVirtualInterfaceTestHistory @@ -2421,6 +2461,9 @@ paths: virtualInterfaceName: $ref: "#/components/schemas/VirtualInterfaceName" description: The name of the virtual private interface. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. Use this to update the bandwidth allocation on an existing virtual interface. required: - virtualInterfaceId responses: @@ -2679,6 +2722,9 @@ components: macSecKeys: $ref: "#/components/schemas/MacSecKeyList" description: The MAC Security (MACsec) security keys associated with the connection. + rateLimiterStatus: + $ref: "#/components/schemas/RateLimiterStatus" + description: The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed. partnerInterconnectMacSecCapable: $ref: "#/components/schemas/PartnerInterconnectMacSecCapable" description: Indicates whether the interconnect hosting this connection supports MAC Security (MACsec). @@ -2781,6 +2827,24 @@ components: type: string StartOnDate: type: string + RateLimiterStatus: + description: Contains information about the rate limiter status for a connection, including the maximum number of rate limiters allowed, the number currently in use, and the remaining capacity. + type: object + properties: + maxAllowed: + $ref: "#/components/schemas/Count" + description: The maximum number of rate limiters allowed on the connection. + inUse: + $ref: "#/components/schemas/Count" + description: The number of rate limiters currently in use on the connection. + remaining: + $ref: "#/components/schemas/Count" + description: The number of rate limiters remaining (available) on the connection. + totalBandwidth: + $ref: "#/components/schemas/Bandwidth" + description: The total bandwidth allocated across all rate limiters on the connection. + Count: + type: integer PartnerInterconnectMacSecCapable: type: boolean NewPrivateVirtualInterfaceAllocation: @@ -2795,10 +2859,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. The valid values are 1-2147483646. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. The valid values are 1-2147483646. asnLong: $ref: "#/components/schemas/LongAsn" - description: The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." mtu: $ref: "#/components/schemas/MTU" description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500. @@ -2817,6 +2881,9 @@ components: tags: $ref: "#/components/schemas/TagList" description: The tags associated with the private virtual interface. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. required: - virtualInterfaceName - vlan @@ -2840,6 +2907,8 @@ components: - ipv6 CustomerAddress: type: string + RateLimit: + type: string VirtualInterface: description: Information about a virtual interface. type: object @@ -2867,10 +2936,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." amazonSideAsn: $ref: "#/components/schemas/LongAsn" description: The autonomous system number (AS) for the Amazon side of the connection. @@ -2925,6 +2994,9 @@ components: siteLinkEnabled: $ref: "#/components/schemas/SiteLinkEnabled" description: Indicates whether SiteLink is enabled. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: "The rate limit (bandwidth allocation) applied to the virtual interface. The value must be one of the supported bandwidth values and cannot exceed the bandwidth of the parent connection or LAG. Supported values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 600Mbps, 700Mbps, 800Mbps, 900Mbps, 1Gbps, 1.2Gbps, 1.5Gbps, 1.8Gbps, 2Gbps, 2.1Gbps, 2.4Gbps, 2.7Gbps, 3Gbps, 3.2Gbps, 3.6Gbps, 4Gbps, 5Gbps, 6Gbps, 7Gbps, 8Gbps, 9Gbps, 10Gbps, 12Gbps, 15Gbps, 18Gbps, 20Gbps, 21Gbps, 24Gbps, 27Gbps, 30Gbps, 32Gbps, 36Gbps, 40Gbps, 50Gbps, 60Gbps, 70Gbps, 80Gbps, 100Gbps, 120Gbps, 150Gbps, 180Gbps, 200Gbps, 210Gbps, 240Gbps, 270Gbps, 300Gbps, 320Gbps, 360Gbps, 400Gbps, 450Gbps, 480Gbps, 500Gbps, 540Gbps, 600Gbps, 700Gbps, 800Gbps, 900Gbps, 1Tbps, 1.1Tbps, 1.2Tbps, 1.3Tbps, 1.4Tbps, 1.5Tbps, 1.6Tbps." VirtualInterfaceId: type: string VirtualInterfaceType: @@ -2957,10 +3029,10 @@ components: description: The ID of the BGP peer. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." authKey: $ref: "#/components/schemas/BGPAuthKey" description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. @@ -3015,10 +3087,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. The valid values are 1-2147483646. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. The valid values are 1-2147483646. asnLong: $ref: "#/components/schemas/LongAsn" - description: The ASN when allocating a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The ASN when allocating a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." authKey: $ref: "#/components/schemas/BGPAuthKey" description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. @@ -3037,6 +3109,9 @@ components: tags: $ref: "#/components/schemas/TagList" description: The tags associated with the public virtual interface. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. required: - virtualInterfaceName - vlan @@ -3052,10 +3127,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. The valid values are 1-2147483646. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. The valid values are 1-2147483646. asnLong: $ref: "#/components/schemas/LongAsn" - description: The ASN when allocating a new transit virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The ASN when allocating a new transit virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." mtu: $ref: "#/components/schemas/MTU" description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500 @@ -3074,6 +3149,9 @@ components: tags: $ref: "#/components/schemas/TagList" description: The tags associated with the transitive virtual interface. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. AllocateTransitVirtualInterfaceResult: type: object properties: @@ -3315,8 +3393,6 @@ components: - deleting - deleted - unknown - Count: - type: integer LagName: type: string Lag: @@ -3386,6 +3462,9 @@ components: macSecKeys: $ref: "#/components/schemas/MacSecKeyList" description: The MAC Security (MACsec) security keys associated with the LAG. + rateLimiterStatus: + $ref: "#/components/schemas/RateLimiterStatus" + description: The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed. LagState: type: string enum: @@ -3414,10 +3493,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. The valid values are 1-2147483646. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. The valid values are 1-2147483646. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." mtu: $ref: "#/components/schemas/MTU" description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500. @@ -3445,6 +3524,9 @@ components: enableSiteLink: $ref: "#/components/schemas/EnableSiteLink" description: Indicates whether to enable or disable SiteLink. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. required: - virtualInterfaceName - vlan @@ -3462,10 +3544,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." authKey: $ref: "#/components/schemas/BGPAuthKey" description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. @@ -3484,6 +3566,9 @@ components: tags: $ref: "#/components/schemas/TagList" description: The tags associated with the public virtual interface. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. required: - virtualInterfaceName - vlan @@ -3499,10 +3584,10 @@ components: description: The ID of the VLAN. asn: $ref: "#/components/schemas/ASN" - description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. If you enter a 4-byte ASN for the asn parameter, the API returns an error. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. asnLong: $ref: "#/components/schemas/LongAsn" - description: The long ASN for a new transit virtual interface.The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong. + description: "The long ASN for a new transit virtual interface.The valid range is from 1 to 4294967294 for BGP configuration. Note the following limitations when using asnLong: You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte. When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647. If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong." mtu: $ref: "#/components/schemas/MTU" description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500. @@ -3527,6 +3612,9 @@ components: enableSiteLink: $ref: "#/components/schemas/EnableSiteLink" description: Indicates whether to enable or disable SiteLink. + rateLimit: + $ref: "#/components/schemas/RateLimit" + description: The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection. CreateTransitVirtualInterfaceResult: type: object properties: @@ -3926,6 +4014,111 @@ components: macSecKeys: $ref: "#/components/schemas/MacSecKeyList" description: The MAC Security (MACsec) security keys no longer associated with the connection. + RouteFilters: + description: The filters used to limit the routes returned by ListVirtualInterfaceRoutes. + type: object + properties: + routeDirection: + $ref: "#/components/schemas/RouteDirection" + description: The direction of the routes to return. The valid values are accepted (routes received from the customer network) and advertised (routes advertised to the customer network). + addressFamily: + $ref: "#/components/schemas/AddressFamily" + description: The address family of the routes to return. The valid values are ipv4 and ipv6. + cidrs: + $ref: "#/components/schemas/RouteFilterCidrStringList" + description: The CIDRs (prefixes) used to filter the routes. You can specify up to 10 CIDRs. + asPath: + $ref: "#/components/schemas/AsPathList" + description: The autonomous system (AS) numbers used to filter the routes by their AS path. + communities: + $ref: "#/components/schemas/CommunityList" + description: The BGP communities used to filter the routes. + RouteDirection: + type: string + enum: + - accepted + - advertised + RouteFilterCidrStringList: + type: array + items: + $ref: "#/components/schemas/RouteFilterCidrString" + RouteFilterCidrString: + type: string + AsPathList: + type: array + items: + $ref: "#/components/schemas/LongAsn" + CommunityList: + type: array + items: + $ref: "#/components/schemas/CommunityEntry" + CommunityEntry: + type: string + ListVirtualInterfaceRoutesResponse: + type: object + properties: + virtualInterfaceId: + $ref: "#/components/schemas/VirtualInterfaceId" + description: The ID of the virtual interface. + routes: + $ref: "#/components/schemas/RouteList" + description: The routes for the virtual interface. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. + RouteList: + type: array + items: + $ref: "#/components/schemas/Route" + Route: + description: Information about a route for a virtual interface. + type: object + properties: + cidr: + $ref: "#/components/schemas/RouteCidr" + description: The CIDR (prefix) of the route. + routeDirection: + $ref: "#/components/schemas/RouteDirection" + description: The direction of the route. The valid values are accepted (received from the customer network) and advertised (advertised to the customer network). + addressFamily: + $ref: "#/components/schemas/AddressFamily" + description: The address family of the route. The valid values are ipv4 and ipv6. + asPath: + $ref: "#/components/schemas/AsPathSegmentList" + description: The autonomous system (AS) path of the route. + communities: + $ref: "#/components/schemas/CommunityList" + description: The BGP communities associated with the route. + awsLogicalDeviceId: + $ref: "#/components/schemas/AwsLogicalDeviceId" + description: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection. + routeInstalledAt: + $ref: "#/components/schemas/RouteInstalledAt" + description: The time when the route was installed. The value is displayed in UTC format. + RouteCidr: + type: string + AsPathSegmentList: + type: array + items: + $ref: "#/components/schemas/AsPathSegment" + AsPathSegment: + description: A segment of an autonomous system (AS) path. + type: object + properties: + pathType: + $ref: "#/components/schemas/AsPathType" + description: The type of the AS path segment. The valid values are seq (an ordered AS_SEQUENCE) and set (an unordered AS_SET). + path: + $ref: "#/components/schemas/AsPathList" + description: The autonomous system (AS) numbers in the segment. + AsPathType: + type: string + enum: + - seq + - set + RouteInstalledAt: + type: string + format: date-time TestId: type: string BGPPeerIdList: @@ -5065,6 +5258,30 @@ components: insert: [] update: [] delete: [] + virtual_interface_routes: + id: aws.directconnect.virtual_interface_routes + name: virtual_interface_routes + title: virtual_interface_routes + methods: + list_virtual_interface_routes: + operation: + $ref: "#/paths/~1ListVirtualInterfaceRoutes/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/virtual_interface_routes/methods/list_virtual_interface_routes" + insert: [] + update: [] + delete: [] virtual_interface_test_histories: id: aws.directconnect.virtual_interface_test_histories name: virtual_interface_test_histories diff --git a/providers/src/aws/v00.00.00000/services/dms.yaml b/providers/src/aws/v00.00.00000/services/dms.yaml index f100b222..655989c8 100644 --- a/providers/src/aws/v00.00.00000/services/dms.yaml +++ b/providers/src/aws/v00.00.00000/services/dms.yaml @@ -130,7 +130,7 @@ paths: /CancelMetadataModelConversion: post: operationId: CancelMetadataModelConversion - description: Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion. + description: "Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion. Required permissions: dms:CancelMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -167,7 +167,7 @@ paths: /CancelMetadataModelCreation: post: operationId: CancelMetadataModelCreation - description: Cancels a single metadata model creation operation that was started with StartMetadataModelCreation. + description: "Cancels a single metadata model creation operation that was started with StartMetadataModelCreation. Required permissions: dms:CancelMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -299,7 +299,7 @@ paths: /CreateDataProvider: post: operationId: CreateDataProvider - description: Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database. + description: "Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database. Required permissions: dms:CreateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -325,7 +325,7 @@ paths: description: A user-friendly description of the data provider. Engine: $ref: "#/components/schemas/String" - description: The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition. + description: "The type of database engine for the data provider. Valid values: aurora, aurora-postgresql, db2, db2-zos, docdb, mariadb, mongodb, mysql, oracle, postgres, redshift, sqlserver, and sybase. A value of aurora represents Amazon Aurora MySQL-Compatible Edition." Virtual: $ref: "#/components/schemas/BooleanOptional" description: Indicates whether the data provider is virtual. @@ -579,7 +579,7 @@ paths: /CreateInstanceProfile: post: operationId: CreateInstanceProfile - description: Creates the instance profile using the specified parameters. + description: "Creates the instance profile using the specified parameters. Required permissions: dms:CreateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -634,7 +634,7 @@ paths: /CreateMigrationProject: post: operationId: CreateMigrationProject - description: Creates the migration project using the specified parameters. You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider. + description: "Creates the migration project using the specified parameters. You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider. Required permissions: dms:CreateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -666,7 +666,7 @@ paths: description: The identifier of the associated instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens. TransformationRules: $ref: "#/components/schemas/String" - description: The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects. + description: A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion. Homogeneous data migrations do not support transformation rules. Description: $ref: "#/components/schemas/String" description: A user-friendly description of the migration project. @@ -1058,7 +1058,7 @@ paths: /DeleteDataProvider: post: operationId: DeleteDataProvider - description: Deletes the specified data provider. All migration projects associated with the data provider must be deleted or modified before you can delete the data provider. + description: "Deletes the specified data provider. Required permissions: dms:DeleteDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the data provider must be deleted or modified before you can delete the data provider." parameters: - name: X-Amz-Target in: header @@ -1219,7 +1219,7 @@ paths: /DeleteInstanceProfile: post: operationId: DeleteInstanceProfile - description: Deletes the specified instance profile. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile. + description: "Deletes the specified instance profile. Required permissions: dms:DeleteInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile." parameters: - name: X-Amz-Target in: header @@ -1252,7 +1252,7 @@ paths: /DeleteMigrationProject: post: operationId: DeleteMigrationProject - description: Deletes the specified migration project. The migration project must be closed before you can delete it. + description: "Deletes the specified migration project. Required permissions: dms:DeleteMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can delete it." parameters: - name: X-Amz-Target in: header @@ -1603,7 +1603,7 @@ paths: /DescribeConversionConfiguration: post: operationId: DescribeConversionConfiguration - description: Returns configuration parameters for a schema conversion project. + description: "Returns configuration parameters for a schema conversion project. Required permissions: dms:DescribeConversionConfiguration. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -1679,7 +1679,7 @@ paths: /DescribeDataProviders: post: operationId: DescribeDataProviders - description: Returns a paginated list of data providers for your account in the current region. + description: "Returns a paginated list of data providers for your account in the current region. Required permissions: dms:ListDataProviders. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -1699,7 +1699,7 @@ paths: properties: Filters: $ref: "#/components/schemas/FilterList" - description: "Filters applied to the data providers described in the form of key-value pairs. Valid filter names and values: data-provider-identifier, data provider arn or name" + description: "The filters to apply to the data providers. The following filter names are supported: data-provider-identifier – The data provider name or ARN." MaxRecords: $ref: "#/components/schemas/IntegerOptional" description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results. @@ -1992,7 +1992,7 @@ paths: /DescribeExtensionPackAssociations: post: operationId: DescribeExtensionPackAssociations - description: Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database. + description: "Returns a paginated list of extension pack installation requests for a migration project, initiated by StartExtensionPackAssociation. Required permissions: dms:ListExtensionPacks. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2012,10 +2012,10 @@ paths: properties: MigrationProjectIdentifier: $ref: "#/components/schemas/MigrationProjectIdentifier" - description: The name or Amazon Resource Name (ARN) for the migration project. + description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the extension pack associations described in the form of key-value pairs. + description: "The filters to apply to the extension pack installation requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. @@ -2216,7 +2216,7 @@ paths: /DescribeInstanceProfiles: post: operationId: DescribeInstanceProfiles - description: Returns a paginated list of instance profiles for your account in the current region. + description: "Returns a paginated list of instance profiles for your account in the current region. Required permissions: dms:ListInstanceProfiles. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2236,7 +2236,7 @@ paths: properties: Filters: $ref: "#/components/schemas/FilterList" - description: "Filters applied to the instance profiles described in the form of key-value pairs. Valid filter names and values: instance-profile-identifier, instance profile arn or name" + description: "The filters to apply to the instance profiles. The following filter names are supported: instance-profile-identifier – The instance profile name or ARN." MaxRecords: $ref: "#/components/schemas/IntegerOptional" description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results. @@ -2253,7 +2253,7 @@ paths: /DescribeMetadataModel: post: operationId: DescribeMetadataModel - description: Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable. + description: "Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable. Required permissions: dms:DescribeMetadataModel. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2273,7 +2273,7 @@ paths: properties: SelectionRules: $ref: "#/components/schemas/String" - description: 'The JSON string that specifies which metadata model to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.' + description: "A JSON string that identifies the metadata model to retrieve. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider. Supports only explicit rule actions. Exactly one rule is allowed." MigrationProjectIdentifier: $ref: "#/components/schemas/MigrationProjectIdentifier" description: The migration project name or Amazon Resource Name (ARN). @@ -2294,7 +2294,7 @@ paths: /DescribeMetadataModelAssessments: post: operationId: DescribeMetadataModelAssessments - description: Returns a paginated list of metadata model assessments for your account in the current region. + description: "Returns a paginated list of metadata model assessment requests for a migration project, initiated by StartMetadataModelAssessment. Required permissions: dms:ListMetadataModelAssessments. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2314,10 +2314,10 @@ paths: properties: MigrationProjectIdentifier: $ref: "#/components/schemas/MigrationProjectIdentifier" - description: The name or Amazon Resource Name (ARN) of the migration project. + description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model assessments described in the form of key-value pairs. + description: "The filters to apply to the metadata model assessment requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. @@ -2336,7 +2336,7 @@ paths: /DescribeMetadataModelChildren: post: operationId: DescribeMetadataModelChildren - description: Gets a list of child metadata models for the specified metadata model in the database hierarchy. + description: "Gets a list of child metadata models for the specified metadata model in the database hierarchy. Required permissions: dms:DescribeMetadataModelChildren. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2356,7 +2356,7 @@ paths: properties: SelectionRules: $ref: "#/components/schemas/String" - description: "The JSON string that specifies which metadata model's children to retrieve. Only one selection rule with \"rule-action\": \"explicit\" can be provided. For more information, see Selection Rules in the DMS User Guide." + description: "A JSON string that identifies the metadata model whose children to retrieve. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider. Supports only explicit rule actions. Exactly one rule is allowed." MigrationProjectIdentifier: $ref: "#/components/schemas/MigrationProjectIdentifier" description: The migration project name or Amazon Resource Name (ARN). @@ -2383,7 +2383,7 @@ paths: /DescribeMetadataModelConversions: post: operationId: DescribeMetadataModelConversions - description: Returns a paginated list of metadata model conversions for a migration project. + description: "Returns a paginated list of metadata model conversion requests for a migration project, initiated by StartMetadataModelConversion. To cancel a queued or in-progress request, call CancelMetadataModelConversion. Required permissions: dms:ListMetadataModelConversions. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2406,7 +2406,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model conversions described in the form of key-value pairs. + description: "The filters to apply to the metadata model conversion requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED, CANCELING, CANCELED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. @@ -2425,7 +2425,7 @@ paths: /DescribeMetadataModelCreations: post: operationId: DescribeMetadataModelCreations - description: Returns a paginated list of metadata model creation requests for a migration project. + description: "Returns a paginated list of metadata model creation requests for a migration project, initiated by StartMetadataModelCreation. To cancel a queued or in-progress request, call CancelMetadataModelCreation. Required permissions: dms:DescribeMetadataModelCreations. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2445,13 +2445,13 @@ paths: properties: Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model creation requests described in the form of key-value pairs. The supported filters are request-id and status. + description: "The filters to apply to the metadata model creation requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED, CANCELING, CANCELED." Marker: $ref: "#/components/schemas/String" - description: Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned by a previous response, there are more metadata model creation requests available. + description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. MaxRecords: $ref: "#/components/schemas/IntegerOptional" - description: The maximum number of metadata model creation requests to include in the response. If more requests exist than the specified MaxRecords value, a pagination token is provided in the response so that you can retrieve the remaining results. + description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results. MigrationProjectIdentifier: $ref: "#/components/schemas/MigrationProjectIdentifier" description: The migration project name or Amazon Resource Name (ARN). @@ -2467,7 +2467,7 @@ paths: /DescribeMetadataModelExportsAsScript: post: operationId: DescribeMetadataModelExportsAsScript - description: Returns a paginated list of metadata model exports. + description: "Returns a paginated list of metadata model export requests for a migration project, initiated by StartMetadataModelExportAsScript. Required permissions: dms:ListMetadataModelExports. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2490,7 +2490,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model exports described in the form of key-value pairs. + description: "The filters to apply to the metadata model export requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. @@ -2509,7 +2509,7 @@ paths: /DescribeMetadataModelExportsToTarget: post: operationId: DescribeMetadataModelExportsToTarget - description: Returns a paginated list of metadata model exports. + description: "Returns a paginated list of metadata model export requests for a migration project, initiated by StartMetadataModelExportToTarget. Required permissions: dms:ListMetadataModelExports. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2532,7 +2532,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model exports described in the form of key-value pairs. + description: "The filters to apply to the metadata model export requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. @@ -2551,7 +2551,7 @@ paths: /DescribeMetadataModelImports: post: operationId: DescribeMetadataModelImports - description: Returns a paginated list of metadata model imports. + description: "Returns a paginated list of metadata model import requests for a migration project, initiated by StartMetadataModelImport. Required permissions: dms:DescribeMetadataModelImports. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2574,13 +2574,13 @@ paths: description: The migration project name or Amazon Resource Name (ARN). Filters: $ref: "#/components/schemas/FilterList" - description: Filters applied to the metadata model imports described in the form of key-value pairs. + description: "The filters to apply to the metadata model import requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED." Marker: $ref: "#/components/schemas/String" description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. MaxRecords: $ref: "#/components/schemas/IntegerOptional" - description: A paginated list of metadata model imports. + description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results. required: - MigrationProjectIdentifier responses: @@ -2593,7 +2593,7 @@ paths: /DescribeMigrationProjects: post: operationId: DescribeMigrationProjects - description: Returns a paginated list of migration projects for your account in the current region. + description: "Returns a paginated list of migration projects for your account in the current region. Required permissions: dms:ListMigrationProjects. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -2613,7 +2613,7 @@ paths: properties: Filters: $ref: "#/components/schemas/FilterList" - description: "Filters applied to the migration projects described in the form of key-value pairs. Valid filter names and values: instance-profile-identifier, instance profile arn or name data-provider-identifier, data provider arn or name migration-project-identifier, migration project arn or name" + description: "The filters to apply to the migration projects. The following filter names are supported: migration-project-identifier – The migration project name or ARN. instance-profile-identifier – The instance profile name or ARN. data-provider-identifier – The source or target data provider name or ARN. source-data-provider-identifier – The source data provider name or ARN. target-data-provider-identifier – The target data provider name or ARN." MaxRecords: $ref: "#/components/schemas/IntegerOptional" description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results. @@ -3271,7 +3271,7 @@ paths: /ExportMetadataModelAssessment: post: operationId: ExportMetadataModelAssessment - description: Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file. + description: "Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file. Required permissions: dms:ExportMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -3294,7 +3294,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to assess. + description: "A JSON string that identifies the metadata models to export a conversion assessment report for. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports only explicit rule actions." FileName: $ref: "#/components/schemas/String" description: The name of the assessment file to create in your Amazon S3 bucket. @@ -3314,7 +3314,7 @@ paths: /GetTargetSelectionRules: post: operationId: GetTargetSelectionRules - description: Converts source selection rules into their target counterparts for schema conversion operations. + description: "Converts source selection rules into their target counterparts for schema conversion operations. Required permissions: dms:GetTargetSelectionRules. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -3337,7 +3337,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: The JSON string representing the source selection rules for conversion. Selection rules must contain only supported metadata model types. For more information, see Selection Rules in the DMS User Guide. + description: "A JSON string that contains the source selection rules to convert into their target counterparts. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports only explicit rule actions. Does not support category-name in the object locator. Up to 10 rules are allowed." required: - MigrationProjectIdentifier - SelectionRules @@ -3430,7 +3430,7 @@ paths: /ModifyConversionConfiguration: post: operationId: ModifyConversionConfiguration - description: Modifies the specified schema conversion configuration using the provided parameters. + description: "Modifies the specified schema conversion configuration using the provided parameters. Required permissions: dms:UpdateConversionConfiguration. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -3453,7 +3453,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). ConversionConfiguration: $ref: "#/components/schemas/String" - description: The new conversion configuration. + description: "A JSON string that contains the schema conversion settings to update. For the format and available settings, see Specifying schema conversion settings for migration projects. Usage: Include only the sections and keys to change. The operation merges supplied values with the existing configuration." required: - MigrationProjectIdentifier - ConversionConfiguration @@ -3524,7 +3524,7 @@ paths: /ModifyDataProvider: post: operationId: ModifyDataProvider - description: Modifies the specified data provider using the provided settings. You must remove the data provider from all migration projects before you can modify it. + description: "Modifies the specified data provider using the provided settings. Required permissions: dms:UpdateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. You must remove the data provider from all migration projects before you can modify it." parameters: - name: X-Amz-Target in: header @@ -3553,7 +3553,7 @@ paths: description: A user-friendly description of the data provider. Engine: $ref: "#/components/schemas/String" - description: The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition. + description: "The type of database engine for the data provider. Valid values: aurora, aurora-postgresql, db2, db2-zos, docdb, mariadb, mongodb, mysql, oracle, postgres, redshift, sqlserver, and sybase. A value of aurora represents Amazon Aurora MySQL-Compatible Edition." Virtual: $ref: "#/components/schemas/BooleanOptional" description: Indicates whether the data provider is virtual. @@ -3751,7 +3751,7 @@ paths: /ModifyInstanceProfile: post: operationId: ModifyInstanceProfile - description: Modifies the specified instance profile using the provided parameters. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile. + description: "Modifies the specified instance profile using the provided parameters. Required permissions: dms:UpdateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile." parameters: - name: X-Amz-Target in: header @@ -3808,7 +3808,7 @@ paths: /ModifyMigrationProject: post: operationId: ModifyMigrationProject - description: Modifies the specified migration project using the provided parameters. The migration project must be closed before you can modify it. + description: "Modifies the specified migration project using the provided parameters. Required permissions: dms:UpdateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can modify it." parameters: - name: X-Amz-Target in: header @@ -3843,7 +3843,7 @@ paths: description: The name or Amazon Resource Name (ARN) for the instance profile. TransformationRules: $ref: "#/components/schemas/String" - description: The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects. + description: A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion. Homogeneous data migrations do not support transformation rules. Description: $ref: "#/components/schemas/String" description: A user-friendly description of the migration project. @@ -4373,7 +4373,7 @@ paths: /StartExtensionPackAssociation: post: operationId: StartExtensionPackAssociation - description: Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database. + description: "Queues the installation of the extension pack on your target database. If other requests created by Start* operations are already in the migration project's queue, the installation begins after they complete. This operation requires a non-virtual target data provider. If the extension pack already exists, the operation reinstalls it. To ensure compatibility, reconvert your database objects if the version has changed since your last conversion. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the request, call DescribeExtensionPackAssociations using the returned RequestIdentifier as a filter. Required permissions: dms:AssociateExtensionPack. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4406,7 +4406,7 @@ paths: /StartMetadataModelAssessment: post: operationId: StartMetadataModelAssessment - description: Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance. + description: "Queues an assessment of the selected source metadata models (database objects such as tables, views, and procedures) to evaluate conversion complexity to the target database format. If other requests created by Start* operations are already in the migration project's queue, the assessment begins after they complete. The assessment request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. To check the status of the assessment request, call DescribeMetadataModelAssessments using the returned RequestIdentifier as a filter. To export the conversion assessment report after the request completes successfully, call ExportMetadataModelAssessment. Required permissions: dms:StartMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4429,7 +4429,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to assess. + description: "A JSON string that identifies the metadata models to assess. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports explicit, include, and exclude rule actions." required: - MigrationProjectIdentifier - SelectionRules @@ -4443,7 +4443,7 @@ paths: /StartMetadataModelConversion: post: operationId: StartMetadataModelConversion - description: Converts your source database objects to a format compatible with the target database. + description: "Queues a conversion of the selected source metadata models (database objects such as tables, views, and procedures) to the target database format. If other requests created by Start* operations are already in the migration project's queue, the conversion begins after they complete. The conversion request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. If converted objects already exist in the target metadata tree, the conversion overwrites them, including any manual edits. To check the status of the conversion request, call DescribeMetadataModelConversions using the returned RequestIdentifier as a filter. To cancel a queued or in-progress request, call CancelMetadataModelConversion with the returned RequestIdentifier. After the conversion completes successfully: To export a post-conversion assessment report, call ExportMetadataModelAssessment. To retrieve converted code, use any of the following options: DescribeMetadataModel and DescribeMetadataModelChildren – navigate the target metadata tree and retrieve converted definitions. StartMetadataModelExportAsScript – export as data definition language (DDL) scripts to your Amazon S3 bucket. StartMetadataModelExportToTarget – apply directly to your target database. Required permissions: dms:StartMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4466,7 +4466,7 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to convert. + description: "A JSON string that identifies the metadata models to convert. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports explicit, include, and exclude rule actions." required: - MigrationProjectIdentifier - SelectionRules @@ -4480,7 +4480,7 @@ paths: /StartMetadataModelCreation: post: operationId: StartMetadataModelCreation - description: "Creates source metadata model of the given type with the specified properties for schema conversion operations. This action supports only these directions: from SQL Server to Aurora PostgreSQL, or from SQL Server to RDS for PostgreSQL." + description: "Queues the creation of a metadata model in the source metadata tree. If other requests created by Start* operations are already in the migration project's queue, the creation begins after they complete. This operation supports only Microsoft SQL Server to Aurora PostgreSQL and Microsoft SQL Server to Amazon RDS for PostgreSQL conversion paths. To check the status of the creation request, call DescribeMetadataModelCreations using the returned RequestIdentifier as a filter. To cancel a queued or in-progress request, call CancelMetadataModelCreation with the returned RequestIdentifier. Calling StartMetadataModelImport with Refresh deletes metadata models created by this operation. After the creation completes successfully: To evaluate conversion complexity, call StartMetadataModelAssessment. To convert to the target database format, call StartMetadataModelConversion. Required permissions: dms:StartMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4503,13 +4503,13 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: The JSON string that specifies the location where the metadata model will be created. Selection rules must specify a single schema. For more information, see Selection Rules in the DMS User Guide. + description: "A JSON string that identifies the source schema for the metadata model. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports only explicit rule actions. Exactly one rule is allowed." MetadataModelName: $ref: "#/components/schemas/String" - description: The name of the metadata model. + description: The name for the metadata model to use in subsequent operations. Properties: $ref: "#/components/schemas/MetadataModelProperties" - description: The properties of metadata model in JSON format. This object is a Union. Only one member of this object can be specified or returned. + description: The properties of the metadata model. required: - MigrationProjectIdentifier - SelectionRules @@ -4525,7 +4525,7 @@ paths: /StartMetadataModelExportAsScript: post: operationId: StartMetadataModelExportAsScript - description: Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket. + description: "Queues an export of metadata models (database objects such as tables, views, and procedures) as a data definition language (DDL) script. The script is stored as a ZIP archive in the Amazon S3 bucket associated with the migration project. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. When exporting from the target metadata tree, the export applies only to metadata models created by conversion. Metadata models imported from the database are skipped. To check the status of the export request, call DescribeMetadataModelExportsAsScript using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportAsScripts. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4548,13 +4548,13 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to export. + description: "A JSON string that identifies the metadata models to export as a SQL script. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider. Supports explicit, include, and exclude rule actions." Origin: $ref: "#/components/schemas/OriginTypeValue" - description: Whether to export the metadata model from the source or the target. + description: Specifies the metadata tree to export from. FileName: $ref: "#/components/schemas/String" - description: The name of the model file to create in the Amazon S3 bucket. + description: The name for the exported file. When you omit this parameter, the service generates a name from the data provider engine name and an export timestamp. required: - MigrationProjectIdentifier - SelectionRules @@ -4569,7 +4569,7 @@ paths: /StartMetadataModelExportToTarget: post: operationId: StartMetadataModelExportToTarget - description: Applies converted database objects to your target database. + description: "Queues an export of the selected converted metadata models (database objects such as tables, views, and procedures) to your target database. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. This operation requires a non-virtual target data provider. The export applies only metadata models created by conversion. Metadata models imported from the database are skipped. If objects with the same name already exist on the target database, the export overwrites them. The operation installs the extension pack on the target database. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the export request, call DescribeMetadataModelExportsToTarget using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportToTarget. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4592,10 +4592,10 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to export. + description: "A JSON string that identifies the metadata models to export to the target database. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only target selection rules, where server-name in the object locator matches the target data provider. Supports explicit, include, and exclude rule actions." OverwriteExtensionPack: $ref: "#/components/schemas/BooleanOptional" - description: Whether to overwrite the migration project extension pack. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database. + description: Specifies whether to overwrite the extension pack if one already exists on the target database. The default value is true. required: - MigrationProjectIdentifier - SelectionRules @@ -4609,7 +4609,7 @@ paths: /StartMetadataModelImport: post: operationId: StartMetadataModelImport - description: Loads the metadata for all the dependent database objects of the parent object. This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance. + description: "Queues an import of metadata models (database objects such as tables, views, and procedures) from your data provider into the metadata tree. If other requests created by Start* operations are already in the migration project's queue, the import begins after they complete. To check the status of the import request, call DescribeMetadataModelImports using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelImport. For more information, see Actions, resources, and condition keys for Database Migration Service." parameters: - name: X-Amz-Target in: header @@ -4632,13 +4632,13 @@ paths: description: The migration project name or Amazon Resource Name (ARN). SelectionRules: $ref: "#/components/schemas/String" - description: A value that specifies the database objects to import. + description: "A JSON string that identifies the metadata models to import from the data provider. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider. Supports explicit, include, and exclude rule actions." Origin: $ref: "#/components/schemas/OriginTypeValue" - description: Whether to load metadata to the source or target database. + description: Specifies the metadata tree to import into. You cannot import from a virtual target data provider. Refresh: $ref: "#/components/schemas/Boolean" - description: If true, DMS loads metadata for the specified objects from the source database. + description: Specifies whether to refresh the selected metadata models from the data provider. When true, the import reloads the selected metadata models with current definitions and removes their existing subtree. When false (default), the import loads the full subtree that has not yet been loaded into the metadata tree. required: - MigrationProjectIdentifier - SelectionRules @@ -5213,13 +5213,14 @@ components: properties: Request: $ref: "#/components/schemas/SchemaConversionRequest" + description: The metadata model conversion request. DMS never populates the ExportSqlDetails field for this operation. SchemaConversionRequest: description: Provides information about a schema conversion action. type: object properties: Status: $ref: "#/components/schemas/String" - description: The schema conversion action status. + description: "The schema conversion operation status. Possible values: RECEIVED – The operation is received but not yet queued for processing. IN_PROGRESS – The operation is queued or actively running. SUCCESS – The operation completed successfully. FAILED – The operation did not complete. CANCELING – The operation is being canceled. The operation might still succeed or fail before cancellation takes effect. CANCELED – The operation was canceled before completion." RequestIdentifier: $ref: "#/components/schemas/String" description: The identifier for the schema conversion action. @@ -5230,6 +5231,7 @@ components: $ref: "#/components/schemas/ErrorDetails" ExportSqlDetails: $ref: "#/components/schemas/ExportSqlDetails" + description: The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts. DMS populates this field only for the DescribeMetadataModelExportsAsScript operation. Progress: $ref: "#/components/schemas/Progress" ErrorDetails: @@ -5247,15 +5249,15 @@ components: $ref: "#/components/schemas/String" description: The error message. ExportSqlDetails: - description: Provides information about a metadata model assessment exported to SQL. + description: The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts. type: object properties: S3ObjectKey: $ref: "#/components/schemas/String" - description: The Amazon S3 object key for the object containing the exported metadata model assessment. + description: The Amazon S3 URI of the object that contains the ZIP archive with exported DDL scripts. ObjectURL: $ref: "#/components/schemas/String" - description: The URL for the object containing the exported metadata model assessment. + description: The URL of the Amazon S3 object that contains the ZIP archive with exported DDL scripts. Progress: description: Provides information about the progress of the schema conversion operation. type: object @@ -5296,6 +5298,7 @@ components: properties: Request: $ref: "#/components/schemas/SchemaConversionRequest" + description: The metadata model creation request. DMS never populates the ExportSqlDetails field for this operation. CancelReplicationTaskAssessmentRunResponse: type: object properties: @@ -5899,7 +5902,7 @@ components: description: A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter. Engine: $ref: "#/components/schemas/String" - description: The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition. + description: "The type of database engine for the data provider. Valid values: aurora, aurora-postgresql, db2, db2-zos, docdb, mariadb, mongodb, mysql, oracle, postgres, redshift, sqlserver, and sybase. A value of aurora represents Amazon Aurora MySQL-Compatible Edition." Virtual: $ref: "#/components/schemas/BooleanOptional" description: Indicates whether the data provider is virtual. @@ -6139,7 +6142,7 @@ components: description: Specifies either document or table mode. Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode. ExtractDocId: $ref: "#/components/schemas/String" - description: Specifies the document ID. Use this setting when NestingLevel is set to "none". Default value is "false". + description: Specifies whether the document ID is added to the target table. Use this setting when NestingLevel is set to "none". Set ExtractDocId to "true" when using multi-document transactions with CDC. Default value is "false". DocsToInvestigate: $ref: "#/components/schemas/String" description: Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one". Must be a positive value greater than 0. Default value is 1000. @@ -6698,7 +6701,7 @@ components: description: "Specifies the number of seconds that the system waits before resending a query. Example: retryInterval=6;" SecurityDbEncryption: $ref: "#/components/schemas/SecretString" - description: For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide. + description: For an Oracle source endpoint, the transparent data encryption (TDE) password required by DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryption setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide. SecurityDbEncryptionName: $ref: "#/components/schemas/String" description: For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide. @@ -6933,7 +6936,7 @@ components: description: Specifies either document or table mode. Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode. ExtractDocId: $ref: "#/components/schemas/BooleanOptional" - description: Specifies the document ID. Use this setting when NestingLevel is set to "none". Default value is "false". + description: Specifies whether the document ID is added to the target table. Use this setting when NestingLevel is set to "none". Set ExtractDocId to true when using multi-document transactions with CDC. Default value is false. DocsToInvestigate: $ref: "#/components/schemas/IntegerOptional" description: Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one". Must be a positive value greater than 0. Default value is 1000. @@ -7361,7 +7364,7 @@ components: description: The name of the associated instance profile. TransformationRules: $ref: "#/components/schemas/String" - description: The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects. + description: The transformation rules for the migration project in JSON format. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion. Homogeneous data migrations do not support transformation rules. Description: $ref: "#/components/schemas/String" description: A user-friendly description of the migration project. @@ -8017,7 +8020,7 @@ components: description: The name or Amazon Resource Name (ARN) for the schema conversion project. ConversionConfiguration: $ref: "#/components/schemas/String" - description: The configuration parameters for the schema conversion project. + description: A JSON string that contains the schema conversion settings for the migration project. For the format and available settings, see Specifying schema conversion settings for migration projects. Marker: type: string maxLength: 1024 @@ -8274,7 +8277,7 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of extension pack associations for the specified migration project. + description: A paginated list of extension pack installation requests. DMS never populates the ExportSqlDetails field for this operation. SchemaConversionRequestList: type: array items: @@ -8642,7 +8645,7 @@ components: description: The name of the metadata model. SelectionRules: $ref: "#/components/schemas/String" - description: The JSON string representing metadata model location. + description: "A JSON string that identifies this metadata model in the metadata tree. For the selection rule format, see Selection rules in DMS Schema Conversion. Usage: You can pass this value as the SelectionRules parameter to any operation that accepts selection rules, such as DescribeMetadataModel, StartMetadataModelConversion, and others." DescribeMetadataModelAssessmentsResponse: type: object properties: @@ -8651,7 +8654,7 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of metadata model assessments for the specified migration project. + description: A paginated list of metadata model assessment requests. DMS never populates the ExportSqlDetails field for this operation. DescribeMetadataModelChildrenResponse: type: object properties: @@ -8669,16 +8672,16 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of metadata model conversions. + description: A paginated list of metadata model conversion requests. DMS never populates the ExportSqlDetails field for this operation. DescribeMetadataModelCreationsResponse: type: object properties: Marker: $ref: "#/components/schemas/String" - description: Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned, there are more metadata model creation requests available. + description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A list of metadata model creation requests. The ExportSqlDetails field will never be populated for the DescribeMetadataModelCreations operation. + description: A paginated list of metadata model creation requests. DMS never populates the ExportSqlDetails field for this operation. DescribeMetadataModelExportsAsScriptResponse: type: object properties: @@ -8687,7 +8690,7 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of metadata model exports. + description: A paginated list of metadata model export requests. DescribeMetadataModelExportsToTargetResponse: type: object properties: @@ -8696,7 +8699,7 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of metadata model exports. + description: A paginated list of metadata model export requests. DMS never populates the ExportSqlDetails field for this operation. DescribeMetadataModelImportsResponse: type: object properties: @@ -8705,7 +8708,7 @@ components: description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged. Requests: $ref: "#/components/schemas/SchemaConversionRequestList" - description: A paginated list of metadata model imports. + description: A paginated list of metadata model import requests. DMS never populates the ExportSqlDetails field for this operation. DescribeMigrationProjectsResponse: type: object properties: @@ -9635,28 +9638,28 @@ components: properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the request operation. + description: The identifier for the installation request. StartMetadataModelAssessmentResponse: type: object properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the assessment operation. + description: The identifier for the assessment request. StartMetadataModelConversionResponse: type: object properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the conversion operation. + description: The identifier for the conversion request. MetadataModelProperties: - description: The properties of metadata model in JSON format. This object is a Union. Only one member of this object can be specified or returned. + description: The properties of the metadata model. type: object properties: StatementProperties: $ref: "#/components/schemas/StatementProperties" - description: The properties of the statement. + description: The properties of the SQL statement. StatementProperties: - description: The properties of the statement for metadata model creation. + description: The properties of the SQL statement. type: object properties: Definition: @@ -9669,25 +9672,25 @@ components: properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the metadata model creation operation. + description: The identifier for the creation request. StartMetadataModelExportAsScriptResponse: type: object properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the export operation. + description: The identifier for the export request. StartMetadataModelExportToTargetResponse: type: object properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the export operation. + description: The identifier for the export request. StartMetadataModelImportResponse: type: object properties: RequestIdentifier: $ref: "#/components/schemas/String" - description: The identifier for the import operation. + description: The identifier for the import request. StartReplicationResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/drs.yaml b/providers/src/aws/v00.00.00000/services/drs.yaml index 2f5256d0..c94ab988 100644 --- a/providers/src/aws/v00.00.00000/services/drs.yaml +++ b/providers/src/aws/v00.00.00000/services/drs.yaml @@ -42,6 +42,29 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateSourceNetworkStackResponse" + /CancelRecoveryPlanExecution: + post: + operationId: CancelRecoveryPlanExecution + description: Cancels an in-progress Recovery Plan execution. Remaining steps are skipped. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanExecutionArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelRecoveryPlanExecutionResponse" /CreateExtendedSourceServer: post: operationId: CreateExtendedSourceServer @@ -97,6 +120,8 @@ paths: $ref: "#/components/schemas/Boolean" launchIntoSourceInstance: $ref: "#/components/schemas/Boolean" + recoveryMode: + $ref: "#/components/schemas/RecoveryMode" responses: "201": description: Success @@ -104,6 +129,68 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateLaunchConfigurationTemplateResponse" + /CreateRecoveryPlan: + post: + operationId: CreateRecoveryPlan + description: Creates a Recovery Plan to orchestrate multi-server disaster recovery. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/RecoveryPlanName" + description: + $ref: "#/components/schemas/RecoveryPlanDescription" + clientToken: + $ref: "#/components/schemas/ClientIdempotencyToken" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - name + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateRecoveryPlanResponse" + /CreateRecoveryPlanStep: + post: + operationId: CreateRecoveryPlanStep + description: Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps). + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + stepName: + $ref: "#/components/schemas/RecoveryPlanStepName" + stepOrder: + $ref: "#/components/schemas/RecoveryPlanStepOrder" + configuration: + $ref: "#/components/schemas/RecoveryPlanStepConfiguration" + clientToken: + $ref: "#/components/schemas/ClientIdempotencyToken" + required: + - recoveryPlanArn + - stepName + - configuration + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateRecoveryPlanStepResponse" /CreateReplicationConfigurationTemplate: post: operationId: CreateReplicationConfigurationTemplate @@ -284,6 +371,75 @@ paths: responses: "200": description: Success + /DeleteRecoveryPlan: + post: + operationId: DeleteRecoveryPlan + description: Deletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status (CREATED, IN_PROGRESS). + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRecoveryPlanResponse" + /DeleteRecoveryPlanExecution: + post: + operationId: DeleteRecoveryPlanExecution + description: Deletes a Recovery Plan execution record. Must be in a terminal status. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanExecutionArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRecoveryPlanExecutionResponse" + /DeleteRecoveryPlanStep: + post: + operationId: DeleteRecoveryPlanStep + description: Deletes a step from a Recovery Plan. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanStepArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRecoveryPlanStepResponse" /DeleteReplicationConfigurationTemplate: post: operationId: DeleteReplicationConfigurationTemplate @@ -672,6 +828,98 @@ paths: application/json: schema: $ref: "#/components/schemas/LaunchConfiguration" + /GetRecoveryPlan: + post: + operationId: GetRecoveryPlan + description: Gets a Recovery Plan by ARN. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRecoveryPlanResponse" + /GetRecoveryPlanExecution: + post: + operationId: GetRecoveryPlanExecution + description: Gets the details of a Recovery Plan execution. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanExecutionArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRecoveryPlanExecutionResponse" + /GetRecoveryPlanExecutionStep: + post: + operationId: GetRecoveryPlanExecutionStep + description: Gets the details of a step within a Recovery Plan execution. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionStepArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanExecutionStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRecoveryPlanExecutionStepResponse" + /GetRecoveryPlanStep: + post: + operationId: GetRecoveryPlanStep + description: Gets a Recovery Plan step by ARN. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanStepArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRecoveryPlanStepResponse" /GetReplicationConfiguration: post: operationId: GetReplicationConfiguration @@ -763,6 +1011,112 @@ paths: application/json: schema: $ref: "#/components/schemas/ListLaunchActionsResponse" + /ListRecoveryPlanExecutionSteps: + post: + operationId: ListRecoveryPlanExecutionSteps + description: Lists all steps within a Recovery Plan execution. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + filter: + $ref: "#/components/schemas/ListRecoveryPlanExecutionStepsFilter" + maxResults: + $ref: "#/components/schemas/MaxResultsType" + nextToken: + $ref: "#/components/schemas/PaginationToken" + required: + - recoveryPlanExecutionArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecoveryPlanExecutionStepsResponse" + /ListRecoveryPlanExecutions: + post: + operationId: ListRecoveryPlanExecutions + description: Lists executions of Recovery Plans, optionally filtered by plan or status. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStatus" + maxResults: + $ref: "#/components/schemas/MaxResultsType" + nextToken: + $ref: "#/components/schemas/PaginationToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecoveryPlanExecutionsResponse" + /ListRecoveryPlanSteps: + post: + operationId: ListRecoveryPlanSteps + description: Lists all steps in a Recovery Plan. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + maxResults: + $ref: "#/components/schemas/MaxResultsType" + nextToken: + $ref: "#/components/schemas/PaginationToken" + required: + - recoveryPlanArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecoveryPlanStepsResponse" + /ListRecoveryPlans: + post: + operationId: ListRecoveryPlans + description: Lists all Recovery Plans in the account. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/MaxResultsType" + nextToken: + $ref: "#/components/schemas/PaginationToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecoveryPlansResponse" /ListStagingAccounts: get: operationId: ListStagingAccounts @@ -900,10 +1254,10 @@ paths: application/json: schema: $ref: "#/components/schemas/PutLaunchActionResponse" - /RetryDataReplication: + /ReorderRecoveryPlanSteps: post: - operationId: RetryDataReplication - description: "WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state." + operationId: ReorderRecoveryPlanSteps + description: Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs. parameters: [] requestBody: required: true @@ -912,21 +1266,70 @@ paths: schema: type: object properties: - sourceServerID: - $ref: "#/components/schemas/SourceServerID" + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + orderedStepArns: + $ref: "#/components/schemas/RecoveryPlanStepArnList" required: - - sourceServerID + - recoveryPlanArn + - orderedStepArns responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/SourceServer" - /ReverseReplication: + $ref: "#/components/schemas/ReorderRecoveryPlanStepsResponse" + /RetryDataReplication: post: - operationId: ReverseReplication - description: Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them. + operationId: RetryDataReplication + description: "WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sourceServerID: + $ref: "#/components/schemas/SourceServerID" + required: + - sourceServerID + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SourceServer" + /RetryRecoveryPlanExecutionStep: + post: + operationId: RetryRecoveryPlanExecutionStep + description: Retries a failed SERVER type execution step. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionStepArn: + $ref: "#/components/schemas/StrictDRSARN" + required: + - recoveryPlanExecutionStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RetryRecoveryPlanExecutionStepResponse" + /ReverseReplication: + post: + operationId: ReverseReplication + description: Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them. parameters: [] requestBody: required: true @@ -998,6 +1401,38 @@ paths: application/json: schema: $ref: "#/components/schemas/StartRecoveryResponse" + /StartRecoveryPlanExecution: + post: + operationId: StartRecoveryPlanExecution + description: Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + mode: + $ref: "#/components/schemas/RecoveryPlanExecutionMode" + clientToken: + $ref: "#/components/schemas/ClientIdempotencyToken" + sourceServers: + $ref: "#/components/schemas/RecoveryPlanExecutionSourceServerList" + tags: + $ref: "#/components/schemas/TagsMap" + required: + - recoveryPlanArn + - mode + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartRecoveryPlanExecutionResponse" /StartReplication: post: operationId: StartReplication @@ -1216,6 +1651,8 @@ paths: $ref: "#/components/schemas/Boolean" launchIntoInstanceProperties: $ref: "#/components/schemas/LaunchIntoInstanceProperties" + recoveryMode: + $ref: "#/components/schemas/RecoveryMode" required: - sourceServerID responses: @@ -1255,6 +1692,8 @@ paths: $ref: "#/components/schemas/Boolean" launchIntoSourceInstance: $ref: "#/components/schemas/Boolean" + recoveryMode: + $ref: "#/components/schemas/RecoveryMode" required: - launchConfigurationTemplateID responses: @@ -1264,6 +1703,89 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateLaunchConfigurationTemplateResponse" + /UpdateRecoveryPlan: + post: + operationId: UpdateRecoveryPlan + description: Updates a Recovery Plan's name or description. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + name: + $ref: "#/components/schemas/RecoveryPlanName" + description: + $ref: "#/components/schemas/RecoveryPlanDescription" + required: + - recoveryPlanArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRecoveryPlanResponse" + /UpdateRecoveryPlanExecutionStep: + post: + operationId: UpdateRecoveryPlanExecutionStep + description: "Updates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step that is in NOT_STARTED status." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanExecutionStepArn: + $ref: "#/components/schemas/StrictDRSARN" + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStepStatus" + servers: + $ref: "#/components/schemas/RecoveryPlanServers" + waitDurationMinutes: + $ref: "#/components/schemas/WaitDurationMinutes" + required: + - recoveryPlanExecutionStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRecoveryPlanExecutionStepResponse" + /UpdateRecoveryPlanStep: + post: + operationId: UpdateRecoveryPlanStep + description: Updates a Recovery Plan step's name or configuration. Step type is immutable. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recoveryPlanStepArn: + $ref: "#/components/schemas/StrictDRSARN" + stepName: + $ref: "#/components/schemas/RecoveryPlanStepName" + configuration: + $ref: "#/components/schemas/RecoveryPlanStepConfiguration" + required: + - recoveryPlanStepArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRecoveryPlanStepResponse" /UpdateReplicationConfiguration: post: operationId: UpdateReplicationConfiguration @@ -1699,6 +2221,86 @@ components: sourceNetworkID: $ref: "#/components/schemas/SourceNetworkID" description: Source Network ID. + StrictDRSARN: + description: "Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, \", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx)." + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+ + CancelRecoveryPlanExecutionResponse: + type: object + properties: + recoveryPlanExecution: + $ref: "#/components/schemas/RecoveryPlanExecution" + description: The cancelled Recovery Plan execution. + required: + - recoveryPlanExecution + RecoveryPlanExecution: + description: A Recovery Plan execution. + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan execution. + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan being executed. + mode: + $ref: "#/components/schemas/RecoveryPlanExecutionMode" + description: The execution mode. + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStatus" + description: The execution status. + startedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the execution started. + completedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the execution completed. + errorDetail: + $ref: "#/components/schemas/ErrorDetail" + description: Error details if the execution failed. + tags: + type: object + properties: {} + description: The tags associated with the Recovery Plan execution. + required: + - recoveryPlanExecutionArn + - recoveryPlanArn + - mode + - status + - startedAt + RecoveryPlanExecutionMode: + description: Execution mode. DRILL for testing, RECOVERY for actual disaster recovery. + type: string + enum: + - DRILL + - RECOVERY + RecoveryPlanExecutionStatus: + description: The status of a Recovery Plan execution. + type: string + enum: + - CREATED + - IN_PROGRESS + - COMPLETED + - FAILED + - CANCELLING + - CANCELLED + ErrorDetail: + description: Error details for a failed operation. + type: object + properties: + message: + $ref: "#/components/schemas/String" + description: The error message. + code: + $ref: "#/components/schemas/String" + description: The error code. + required: + - message + - code + String: + type: string SourceServerARN: type: string minLength: 20 @@ -1937,7 +2539,7 @@ components: type: string minLength: 0 maxLength: 255 - pattern: (us(-gov)?|ap|ca|cn|eu|eusc|sa|af|me|il)-([a-z]{2}-)?(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z] + pattern: (us(-gov)?|ap|ca|cn|eu|eusc|sa|af|me|mx|il)-([a-z]{2}-)?(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z] OutpostARN: type: string minLength: 20 @@ -2149,7 +2751,7 @@ components: type: string minLength: 0 maxLength: 255 - pattern: (us(-gov)?|ap|ca|cn|eu|eusc|sa|af|me|il)-([a-z]{2}-)?(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9] + pattern: (us(-gov)?|ap|ca|cn|eu|eusc|sa|af|me|mx|il)-([a-z]{2}-)?(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9] ReplicationDirection: description: Replication direction designates if this is a failover replication, or a failback replication. When a DRS agent is installed on an instance, the replication direction is failover. In cases where a recovery launch was made in the recovery location and a new recovery instance was created, and then a failback replication was initiated from that recovery instance back to the origin location, then the replication direction will be failback. type: string @@ -2177,6 +2779,12 @@ components: osByol: $ref: "#/components/schemas/Boolean" description: Whether to enable "Bring your own license" or not. + RecoveryMode: + description: Recovery mode to use during launch. FAST skips conversion to reduce recovery time. OPTIMAL runs full conversion for maximum compatibility. + type: string + enum: + - FAST + - OPTIMAL CreateLaunchConfigurationTemplateResponse: type: object properties: @@ -2221,11 +2829,170 @@ components: launchIntoSourceInstance: $ref: "#/components/schemas/Boolean" description: DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance. + recoveryMode: + $ref: "#/components/schemas/RecoveryMode" + description: Recovery mode. LaunchConfigurationTemplateID: type: string minLength: 21 maxLength: 21 pattern: lct-[0-9a-zA-Z]{17} + RecoveryPlanName: + description: The name of a Recovery Plan. + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9][a-zA-Z0-9 _-]*" + RecoveryPlanDescription: + description: The description of a Recovery Plan. + type: string + minLength: 0 + maxLength: 1024 + ClientIdempotencyToken: + type: string + minLength: 0 + maxLength: 64 + CreateRecoveryPlanResponse: + type: object + properties: + recoveryPlan: + $ref: "#/components/schemas/RecoveryPlan" + required: + - recoveryPlan + RecoveryPlan: + description: A Recovery Plan resource. + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan. + name: + $ref: "#/components/schemas/RecoveryPlanName" + description: + $ref: "#/components/schemas/RecoveryPlanDescription" + status: + $ref: "#/components/schemas/RecoveryPlanStatus" + description: The status of the Recovery Plan. + createdAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the Recovery Plan was created. + updatedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the Recovery Plan was last updated. + tags: + type: object + properties: {} + description: The tags associated with the Recovery Plan. + required: + - recoveryPlanArn + - name + - status + - createdAt + - updatedAt + RecoveryPlanStatus: + description: Recovery Plan status. ACTIVE means executable. INVALID means the plan has no SERVER type steps and cannot be executed. + type: string + enum: + - ACTIVE + - INVALID + RecoveryPlanStepName: + description: The name of a Recovery Plan Step. + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9][a-zA-Z0-9 _-]*" + RecoveryPlanStepOrder: + description: The order of a step within a Recovery Plan (1-based). + type: integer + minimum: 1 + maximum: 20 + RecoveryPlanStepConfiguration: + description: Type-specific configuration for a recovery plan step. Exactly one member must be set. + type: object + properties: + serverStepConfiguration: + $ref: "#/components/schemas/ServerStepConfiguration" + description: Configuration for a SERVER type step. + waitStepConfiguration: + $ref: "#/components/schemas/WaitStepConfiguration" + description: Configuration for a WAIT type step. + ServerStepConfiguration: + description: Configuration for a SERVER type step. + type: object + properties: + servers: + $ref: "#/components/schemas/RecoveryPlanServers" + description: The list of servers to recover in this step. + required: + - servers + RecoveryPlanServers: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanServer" + RecoveryPlanServer: + description: A server associated with a Recovery Plan Step. + type: object + properties: + serverArn: + $ref: "#/components/schemas/SourceServerARN" + description: The ARN of the source server. + impactLevel: + $ref: "#/components/schemas/RecoveryPlanServerImpactLevel" + description: Defaults to CRITICAL if not specified. + required: + - serverArn + RecoveryPlanServerImpactLevel: + description: The impact level of a server within a Recovery Plan step. CRITICAL means the step fails if this server fails. OPTIONAL means the step continues even if this server fails. + type: string + enum: + - CRITICAL + - OPTIONAL + WaitStepConfiguration: + description: Configuration for a WAIT type step. + type: object + properties: + waitDurationMinutes: + $ref: "#/components/schemas/WaitDurationMinutes" + required: + - waitDurationMinutes + WaitDurationMinutes: + description: The wait duration in minutes for a Wait type step. + type: integer + minimum: 1 + maximum: 120 + CreateRecoveryPlanStepResponse: + type: object + properties: + recoveryPlanStep: + $ref: "#/components/schemas/RecoveryPlanStep" + required: + - recoveryPlanStep + RecoveryPlanStep: + description: A Recovery Plan Step resource. + type: object + properties: + recoveryPlanStepArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan step. + stepOrder: + $ref: "#/components/schemas/RecoveryPlanStepOrder" + stepName: + $ref: "#/components/schemas/RecoveryPlanStepName" + configuration: + $ref: "#/components/schemas/RecoveryPlanStepConfiguration" + createdAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the step was created. + updatedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the step was last updated. + required: + - recoveryPlanStepArn + - stepOrder + - stepName + - configuration + - createdAt + - updatedAt SubnetID: type: string minLength: 0 @@ -2386,6 +3153,30 @@ components: type: object DeleteLaunchConfigurationTemplateResponse: type: object + DeleteRecoveryPlanResponse: + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the deleted Recovery Plan. + required: + - recoveryPlanArn + DeleteRecoveryPlanExecutionResponse: + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the deleted Recovery Plan execution. + required: + - recoveryPlanExecutionArn + DeleteRecoveryPlanStepResponse: + type: object + properties: + recoveryPlanStepArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the deleted Recovery Plan step. + required: + - recoveryPlanStepArn DeleteReplicationConfigurationTemplateResponse: type: object DeleteSourceNetworkResponse: @@ -3210,6 +4001,9 @@ components: launchIntoInstanceProperties: $ref: "#/components/schemas/LaunchIntoInstanceProperties" description: Launch into existing instance properties. + recoveryMode: + $ref: "#/components/schemas/RecoveryMode" + description: Recovery mode. SmallBoundedString: type: string minLength: 0 @@ -3221,6 +4015,121 @@ components: launchIntoEC2InstanceID: $ref: "#/components/schemas/EC2InstanceID" description: Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback. + GetRecoveryPlanResponse: + type: object + properties: + recoveryPlan: + $ref: "#/components/schemas/RecoveryPlan" + required: + - recoveryPlan + GetRecoveryPlanExecutionResponse: + type: object + properties: + recoveryPlanExecution: + $ref: "#/components/schemas/RecoveryPlanExecution" + description: The Recovery Plan execution details. + required: + - recoveryPlanExecution + GetRecoveryPlanExecutionStepResponse: + type: object + properties: + recoveryPlanExecutionStep: + $ref: "#/components/schemas/RecoveryPlanExecutionStep" + required: + - recoveryPlanExecutionStep + RecoveryPlanExecutionStep: + description: A Recovery Plan Execution Step resource. + type: object + properties: + recoveryPlanExecutionStepArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the execution step. + stepIndex: + $ref: "#/components/schemas/RecoveryPlanStepOrder" + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStepStatus" + description: The status of the execution step. + stepName: + $ref: "#/components/schemas/RecoveryPlanStepName" + configuration: + $ref: "#/components/schemas/RecoveryPlanExecutionStepConfiguration" + errorDetail: + $ref: "#/components/schemas/ErrorDetail" + description: Error details if the step failed. + attempt: + $ref: "#/components/schemas/StrictlyPositiveInteger" + description: The number of times this step has been attempted. + createdAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the execution step was created. + updatedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the execution step was last updated. + required: + - recoveryPlanExecutionStepArn + - stepIndex + - status + - stepName + - configuration + - attempt + - createdAt + - updatedAt + RecoveryPlanExecutionStepStatus: + description: The status of a step within a Recovery Plan execution. + type: string + enum: + - NOT_STARTED + - EXECUTING + - WAITING + - COMPLETED + - FAILED + - TIMED_OUT + - SKIPPED + RecoveryPlanExecutionStepConfiguration: + description: Type-specific configuration for an execution step response. Mirrors RecoveryPlanStepConfiguration but uses execution-enriched server shapes. + type: object + properties: + executionServerStepConfiguration: + $ref: "#/components/schemas/ExecutionServerStepConfiguration" + description: Configuration for a SERVER type step (with execution state like jobID). + waitStepConfiguration: + $ref: "#/components/schemas/WaitStepConfiguration" + description: Configuration for a WAIT type step. + ExecutionServerStepConfiguration: + description: Configuration for a SERVER type execution step. + type: object + properties: + servers: + $ref: "#/components/schemas/RecoveryPlanExecutionServers" + description: The list of servers in this execution step. + required: + - servers + RecoveryPlanExecutionServers: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanExecutionServer" + RecoveryPlanExecutionServer: + description: A server within a recovery plan execution step, enriched with execution state. + type: object + properties: + serverArn: + $ref: "#/components/schemas/SourceServerARN" + description: The ARN of the source server. + impactLevel: + $ref: "#/components/schemas/RecoveryPlanServerImpactLevel" + description: Defaults to CRITICAL if not specified. + jobID: + $ref: "#/components/schemas/JobID" + description: The DRS recovery job ID. Populated when recovery is initiated for this server. + required: + - serverArn + GetRecoveryPlanStepResponse: + type: object + properties: + recoveryPlanStep: + $ref: "#/components/schemas/RecoveryPlanStep" + required: + - recoveryPlanStep ReplicationConfiguration: type: object properties: @@ -3372,20 +4281,164 @@ components: type: array items: $ref: "#/components/schemas/LaunchAction" - ListStagingAccountsRequestMaxResultsInteger: - type: integer - minimum: 1 - maximum: 50 - ListStagingAccountsResponse: + ListRecoveryPlanExecutionStepsFilter: + description: Filters for listing Recovery Plan execution steps. type: object properties: - accounts: - $ref: "#/components/schemas/Accounts" - description: An array of staging AWS Accounts. + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStepStatus" + description: Filter by execution step status. + ListRecoveryPlanExecutionStepsResponse: + type: object + properties: + recoveryPlanExecutionSteps: + $ref: "#/components/schemas/RecoveryPlanExecutionStepSummaryList" + description: The list of execution steps. nextToken: $ref: "#/components/schemas/PaginationToken" - description: The token of the next staging Account to retrieve. - Accounts: + description: The token for the next page of results. + required: + - recoveryPlanExecutionSteps + RecoveryPlanExecutionStepSummaryList: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanExecutionStepSummary" + RecoveryPlanExecutionStepSummary: + description: Summary information about a Recovery Plan execution step. + type: object + properties: + recoveryPlanExecutionStepArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the execution step. + stepName: + $ref: "#/components/schemas/RecoveryPlanStepName" + stepIndex: + $ref: "#/components/schemas/RecoveryPlanStepOrder" + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStepStatus" + description: The status of the execution step. + configuration: + $ref: "#/components/schemas/RecoveryPlanExecutionStepConfiguration" + errorDetail: + $ref: "#/components/schemas/ErrorDetail" + description: Error details if the step failed. + required: + - recoveryPlanExecutionStepArn + - stepName + - stepIndex + - status + - configuration + ListRecoveryPlanExecutionsResponse: + type: object + properties: + recoveryPlanExecutions: + $ref: "#/components/schemas/RecoveryPlanExecutionSummaryList" + description: The list of Recovery Plan executions. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next page of results. + required: + - recoveryPlanExecutions + RecoveryPlanExecutionSummaryList: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanExecutionSummary" + RecoveryPlanExecutionSummary: + description: Summary information about a Recovery Plan execution. + type: object + properties: + recoveryPlanExecutionArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan execution. + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan. + mode: + $ref: "#/components/schemas/RecoveryPlanExecutionMode" + description: The execution mode. + status: + $ref: "#/components/schemas/RecoveryPlanExecutionStatus" + description: The execution status. + startedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the execution started. + errorDetail: + $ref: "#/components/schemas/ErrorDetail" + description: Error details if the execution failed. + required: + - recoveryPlanExecutionArn + - recoveryPlanArn + - mode + - status + - startedAt + ListRecoveryPlanStepsResponse: + type: object + properties: + recoveryPlanSteps: + $ref: "#/components/schemas/RecoveryPlanStepList" + description: The list of Recovery Plan steps. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next page of results. + required: + - recoveryPlanSteps + RecoveryPlanStepList: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanStep" + ListRecoveryPlansResponse: + type: object + properties: + recoveryPlans: + $ref: "#/components/schemas/RecoveryPlanSummaryList" + description: The list of Recovery Plans. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next page of results. + required: + - recoveryPlans + RecoveryPlanSummaryList: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanSummary" + RecoveryPlanSummary: + description: Summary information about a Recovery Plan. + type: object + properties: + recoveryPlanArn: + $ref: "#/components/schemas/StrictDRSARN" + description: The ARN of the Recovery Plan. + name: + $ref: "#/components/schemas/RecoveryPlanName" + status: + $ref: "#/components/schemas/RecoveryPlanStatus" + description: The status of the Recovery Plan. + createdAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the Recovery Plan was created. + updatedAt: + $ref: "#/components/schemas/ISO8601DatetimeString" + description: The timestamp when the Recovery Plan was last updated. + required: + - recoveryPlanArn + - name + - status + - createdAt + - updatedAt + ListStagingAccountsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListStagingAccountsResponse: + type: object + properties: + accounts: + $ref: "#/components/schemas/Accounts" + description: An array of staging AWS Accounts. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token of the next staging Account to retrieve. + Accounts: type: array items: $ref: "#/components/schemas/Account" @@ -3439,6 +4492,25 @@ components: $ref: "#/components/schemas/LaunchActionDescription" category: $ref: "#/components/schemas/LaunchActionCategory" + RecoveryPlanStepArnList: + type: array + items: + $ref: "#/components/schemas/StrictDRSARN" + ReorderRecoveryPlanStepsResponse: + type: object + properties: + recoveryPlanSteps: + $ref: "#/components/schemas/RecoveryPlanStepList" + description: The steps with updated order. + required: + - recoveryPlanSteps + RetryRecoveryPlanExecutionStepResponse: + type: object + properties: + recoveryPlanExecutionStep: + $ref: "#/components/schemas/RecoveryPlanExecutionStep" + required: + - recoveryPlanExecutionStep ReverseReplicationResponse: type: object properties: @@ -3477,6 +4549,31 @@ components: job: $ref: "#/components/schemas/Job" description: The Recovery Job. + RecoveryPlanExecutionSourceServerList: + type: array + items: + $ref: "#/components/schemas/RecoveryPlanExecutionSourceServer" + RecoveryPlanExecutionSourceServer: + description: A source server with a specific recovery snapshot for plan execution. + type: object + properties: + sourceServerID: + $ref: "#/components/schemas/SourceServerID" + description: The ID of the source server. + recoverySnapshotID: + $ref: "#/components/schemas/RecoverySnapshotID" + description: The ID of the recovery snapshot to use. + required: + - sourceServerID + - recoverySnapshotID + StartRecoveryPlanExecutionResponse: + type: object + properties: + recoveryPlanExecution: + $ref: "#/components/schemas/RecoveryPlanExecution" + description: The started Recovery Plan execution. + required: + - recoveryPlanExecution StartReplicationResponse: type: object properties: @@ -3547,6 +4644,27 @@ components: launchConfigurationTemplate: $ref: "#/components/schemas/LaunchConfigurationTemplate" description: Updated Launch Configuration Template. + UpdateRecoveryPlanResponse: + type: object + properties: + recoveryPlan: + $ref: "#/components/schemas/RecoveryPlan" + required: + - recoveryPlan + UpdateRecoveryPlanExecutionStepResponse: + type: object + properties: + recoveryPlanExecutionStep: + $ref: "#/components/schemas/RecoveryPlanExecutionStep" + required: + - recoveryPlanExecutionStep + UpdateRecoveryPlanStepResponse: + type: object + properties: + recoveryPlanStep: + $ref: "#/components/schemas/RecoveryPlanStep" + required: + - recoveryPlanStep x-stackQL-resources: source_networks: id: aws.drs.source_networks @@ -3658,6 +4776,107 @@ components: - $ref: "#/components/x-stackQL-resources/source_networks/methods/associate_source_network_stack" delete: - $ref: "#/components/x-stackQL-resources/source_networks/methods/delete_source_network" + recovery_plans: + id: aws.drs.recovery_plans + name: recovery_plans + title: recovery_plans + methods: + cancel_recovery_plan_execution: + operation: + $ref: "#/paths/~1CancelRecoveryPlanExecution/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_recovery_plan: + operation: + $ref: "#/paths/~1CreateRecoveryPlan/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_recovery_plan: + operation: + $ref: "#/paths/~1DeleteRecoveryPlan/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_recovery_plan: + operation: + $ref: "#/paths/~1GetRecoveryPlan/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlan + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_recovery_plans: + operation: + $ref: "#/paths/~1ListRecoveryPlans/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlans + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + start_recovery_plan_execution: + operation: + $ref: "#/paths/~1StartRecoveryPlanExecution/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_recovery_plan: + operation: + $ref: "#/paths/~1UpdateRecoveryPlan/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/recovery_plans/methods/get_recovery_plan" + - $ref: "#/components/x-stackQL-resources/recovery_plans/methods/list_recovery_plans" + insert: + - $ref: "#/components/x-stackQL-resources/recovery_plans/methods/create_recovery_plan" + update: + - $ref: "#/components/x-stackQL-resources/recovery_plans/methods/update_recovery_plan" + delete: + - $ref: "#/components/x-stackQL-resources/recovery_plans/methods/delete_recovery_plan" source_servers: id: aws.drs.source_servers name: source_servers @@ -3822,6 +5041,96 @@ components: - $ref: "#/components/x-stackQL-resources/launch_configuration_templates/methods/update_launch_configuration_template" delete: - $ref: "#/components/x-stackQL-resources/launch_configuration_templates/methods/delete_launch_configuration_template" + recovery_plan_steps: + id: aws.drs.recovery_plan_steps + name: recovery_plan_steps + title: recovery_plan_steps + methods: + create_recovery_plan_step: + operation: + $ref: "#/paths/~1CreateRecoveryPlanStep/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_recovery_plan_step: + operation: + $ref: "#/paths/~1DeleteRecoveryPlanStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_recovery_plan_step: + operation: + $ref: "#/paths/~1GetRecoveryPlanStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanStep + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_recovery_plan_steps: + operation: + $ref: "#/paths/~1ListRecoveryPlanSteps/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanSteps + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + reorder_recovery_plan_steps: + operation: + $ref: "#/paths/~1ReorderRecoveryPlanSteps/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_recovery_plan_step: + operation: + $ref: "#/paths/~1UpdateRecoveryPlanStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/recovery_plan_steps/methods/get_recovery_plan_step" + - $ref: "#/components/x-stackQL-resources/recovery_plan_steps/methods/list_recovery_plan_steps" + insert: + - $ref: "#/components/x-stackQL-resources/recovery_plan_steps/methods/create_recovery_plan_step" + update: + - $ref: "#/components/x-stackQL-resources/recovery_plan_steps/methods/update_recovery_plan_step" + delete: + - $ref: "#/components/x-stackQL-resources/recovery_plan_steps/methods/delete_recovery_plan_step" replication_configuration_templates: id: aws.drs.replication_configuration_templates name: replication_configuration_templates @@ -4069,6 +5378,61 @@ components: delete: - $ref: "#/components/x-stackQL-resources/recovery_instances/methods/delete_recovery_instance" - $ref: "#/components/x-stackQL-resources/recovery_instances/methods/terminate_recovery_instances" + recovery_plan_executions: + id: aws.drs.recovery_plan_executions + name: recovery_plan_executions + title: recovery_plan_executions + methods: + delete_recovery_plan_execution: + operation: + $ref: "#/paths/~1DeleteRecoveryPlanExecution/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_recovery_plan_execution: + operation: + $ref: "#/paths/~1GetRecoveryPlanExecution/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanExecution + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_recovery_plan_executions: + operation: + $ref: "#/paths/~1ListRecoveryPlanExecutions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanExecutions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/recovery_plan_executions/methods/get_recovery_plan_execution" + - $ref: "#/components/x-stackQL-resources/recovery_plan_executions/methods/list_recovery_plan_executions" + insert: [] + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/recovery_plan_executions/methods/delete_recovery_plan_execution" job_log_items: id: aws.drs.job_log_items name: job_log_items @@ -4196,6 +5560,72 @@ components: update: - $ref: "#/components/x-stackQL-resources/launch_configurations/methods/update_launch_configuration" delete: [] + recovery_plan_execution_steps: + id: aws.drs.recovery_plan_execution_steps + name: recovery_plan_execution_steps + title: recovery_plan_execution_steps + methods: + get_recovery_plan_execution_step: + operation: + $ref: "#/paths/~1GetRecoveryPlanExecutionStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanExecutionStep + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_recovery_plan_execution_steps: + operation: + $ref: "#/paths/~1ListRecoveryPlanExecutionSteps/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recoveryPlanExecutionSteps + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + retry_recovery_plan_execution_step: + operation: + $ref: "#/paths/~1RetryRecoveryPlanExecutionStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_recovery_plan_execution_step: + operation: + $ref: "#/paths/~1UpdateRecoveryPlanExecutionStep/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/recovery_plan_execution_steps/methods/get_recovery_plan_execution_step" + - $ref: "#/components/x-stackQL-resources/recovery_plan_execution_steps/methods/list_recovery_plan_execution_steps" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/recovery_plan_execution_steps/methods/update_recovery_plan_execution_step" + delete: [] replication_configurations: id: aws.drs.replication_configurations name: replication_configurations diff --git a/providers/src/aws/v00.00.00000/services/dsql.yaml b/providers/src/aws/v00.00.00000/services/dsql.yaml index 33e954fa..ffaa30aa 100644 --- a/providers/src/aws/v00.00.00000/services/dsql.yaml +++ b/providers/src/aws/v00.00.00000/services/dsql.yaml @@ -183,7 +183,7 @@ paths: $ref: "#/components/schemas/GetClusterOutput" post: operationId: UpdateCluster - description: "The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions. Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section. Required permissions dsql:UpdateCluster Permission to update a DSQL cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:PutMultiRegionProperties Permission to configure multi-Region properties for a cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:GetCluster Permission to retrieve cluster information. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:AddPeerCluster Permission to add peer clusters. Resources: Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id Each peer cluster: exact ARN of each specified peer cluster dsql:RemovePeerCluster Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates. Resources: arn:aws:dsql:*:account-id:cluster/* dsql:PutWitnessRegion Permission to set a witness Region. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id Condition Keys: dsql:WitnessRegion (matching the specified witness Region) This permission is checked both in the cluster Region and in the witness Region. The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region. When updating clusters with peer relationships, permissions are checked for both adding and removing peers. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates." + description: "The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions. Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section. Required permissions dsql:UpdateCluster Permission to update a DSQL cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:PutMultiRegionProperties Permission to configure multi-Region properties for a cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:GetCluster Permission to retrieve cluster information. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:AddPeerCluster Permission to add peer clusters. Resources: Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id Each peer cluster: exact ARN of each specified peer cluster dsql:RemovePeerCluster Permission to remove peer clusters. When you list peer clusters in multiRegionProperties.clusters, you need this permission for each current peer cluster that your list omits. Resources: Each removed peer cluster: exact ARN of each removed peer cluster, in its own Region dsql:PutWitnessRegion Permission to set a witness Region. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id Condition Keys: dsql:WitnessRegion (matching the specified witness Region) This permission is checked both in the cluster Region and in the witness Region. The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region. When you list peer clusters in multiRegionProperties.clusters, you need dsql:AddPeerCluster for every peer cluster in your request. You need dsql:RemovePeerCluster only for the peer clusters that the update removes." parameters: - name: identifier in: path @@ -631,7 +631,7 @@ components: type: string minLength: 1 maxLength: 2048 - pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+ + pattern: arn:aws[a-zA-Z\-]*:kinesis:[a-zA-Z0-9\-]*:\d{12}:stream/[a-zA-Z0-9+=,.@_/\-]+ RoleArn: description: The Amazon Resource Name (ARN) of an IAM role. type: string diff --git a/providers/src/aws/v00.00.00000/services/dynamodb.yaml b/providers/src/aws/v00.00.00000/services/dynamodb.yaml index 23627909..0f95ba56 100644 --- a/providers/src/aws/v00.00.00000/services/dynamodb.yaml +++ b/providers/src/aws/v00.00.00000/services/dynamodb.yaml @@ -91,7 +91,7 @@ paths: /BatchWriteItem: post: operationId: BatchWriteItem - description: "The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes." + description: "The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. If BatchWriteItem cannot process any items due to throttling (for example, insufficient provisioned throughput on the tables in the request, or partition-level or account-level limits), it returns a ProvisionedThroughputExceededException or a ThrottlingException. Both indicate that the request was throttled; check the ThrottlingReason field in the returned exception for details. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes." parameters: - name: X-Amz-Target in: header @@ -272,6 +272,9 @@ paths: GlobalTableSettingsReplicationMode: $ref: "#/components/schemas/GlobalTableSettingsReplicationMode" description: Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED_WITH_OVERRIDES. + VectorIndexes: + $ref: "#/components/schemas/VectorIndexList" + description: "One or more vector indexes to be created on the table. Each vector index enables similarity search on a vector attribute. Each element in the list consists of: IndexName - The name of the vector index. Must be unique within the table. VectorAttribute - The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions. Dimensions - The number of dimensions in each vector. DistanceFunction - The distance function used to calculate similarity. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT. Projection - Specifies attributes that are copied (projected) from the table into the vector index. The total number of projected non-key attributes is shared across the vector attribute (counts as 1) and INLINE_FILTER search schema elements (each counts as 1). HASH search schema elements do not count toward this limit. SearchSchema - (Optional) Defines the partition key (HASH) and inline filter (INLINE_FILTER) attributes for the vector index." required: - TableName responses: @@ -1523,7 +1526,7 @@ paths: description: The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter. Item: $ref: "#/components/schemas/PutItemInputAttributeMap" - description: A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the Item map is an AttributeValue object. + description: "A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If the table has vector indexes, the following validations apply to write operations. A violation of any of these constraints results in a ValidationException: The vector attribute must be a list of numbers with dimensions matching the index configuration. Vector values must fit in 32-bit IEEE-754 floating point format (f32). Partition key and inline filter attributes defined in the search schema must have data types matching the index schema definition. Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the Item map is an AttributeValue object." Expected: $ref: "#/components/schemas/ExpectedAttributeMap" description: This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. @@ -1725,6 +1728,9 @@ paths: SSESpecificationOverride: $ref: "#/components/schemas/SSESpecification" description: The new server-side encryption settings for the restored table. + VectorIndexOverride: + $ref: "#/components/schemas/VectorIndexList" + description: The vector indexes for the restored table. If not specified, all vector indexes from the backup are restored. The indexes provided must match existing vector indexes from the backup. You can choose to exclude some or all of the vector indexes at the time of restore. required: - TargetTableName - BackupArn @@ -1776,7 +1782,7 @@ paths: description: The billing mode of the restored table. GlobalSecondaryIndexOverride: $ref: "#/components/schemas/GlobalSecondaryIndexList" - description: List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. + description: List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. The WarmThroughput setting is not supported on global secondary indexes when you use RestoreTableToPointInTime. Although WarmThroughput appears in the shared index definition, including it in a GlobalSecondaryIndexOverride entry causes the request to fail with a validation error. LocalSecondaryIndexOverride: $ref: "#/components/schemas/LocalSecondaryIndexList" description: List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. @@ -1788,6 +1794,9 @@ paths: SSESpecificationOverride: $ref: "#/components/schemas/SSESpecification" description: The new server-side encryption settings for the restored table. + VectorIndexOverride: + $ref: "#/components/schemas/VectorIndexList" + description: The vector indexes for the restored table. If not specified, all vector indexes from the source table are restored. The indexes provided must match existing vector indexes from the source table. You can choose to exclude some or all of the vector indexes at the time of restore. required: - TargetTableName responses: @@ -1874,6 +1883,65 @@ paths: application/json: schema: $ref: "#/components/schemas/ScanOutput" + /SearchVectors: + post: + operationId: SearchVectors + description: "Performs a vector similarity search on a vector index associated with an Amazon DynamoDB table, and returns the most similar items sorted by similarity score based on the distance function configured for the index. Score interpretation depends on the distance function: COSINE - Returns the items with the k smallest scores. Scores range from 0 (identical) to 2 (opposite). Lower scores indicate higher similarity. EUCLIDEAN - Returns the items with the k smallest scores. Scores represent the Euclidean distance between vectors. Lower scores indicate higher similarity. DOT_PRODUCT - Returns the items with the k highest scores. Higher scores indicate higher similarity." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - DynamoDB_20120810.SearchVectors + default: DynamoDB_20120810.SearchVectors + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + TableName: + $ref: "#/components/schemas/TableArn" + description: The name or Amazon Resource Name (ARN) of the table containing the vector index. + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index to search. The index must be in the ACTIVE state. + ReturnConsumedCapacity: + $ref: "#/components/schemas/ReturnConsumedCapacity" + ExpressionAttributeNames: + $ref: "#/components/schemas/ExpressionAttributeNameMap" + description: "One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name." + ExpressionAttributeValues: + $ref: "#/components/schemas/ExpressionAttributeValueMap" + description: "One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value." + ProjectionExpression: + $ref: "#/components/schemas/ProjectionExpression" + description: A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index. Only attributes projected into the vector index can be retrieved. + SearchVector: + $ref: "#/components/schemas/SearchVectorList" + description: The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format. The number of dimensions must match the number of dimensions configured for the vector index. + SearchConditionExpression: + $ref: "#/components/schemas/String" + description: A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements. Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced. + TopK: + $ref: "#/components/schemas/TopKInteger" + description: The number of most similar results to return. + required: + - TableName + - IndexName + - SearchVector + - TopK + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchVectorsOutput" /TagResource: post: operationId: TagResource @@ -2357,6 +2425,9 @@ paths: GlobalTableSettingsReplicationMode: $ref: "#/components/schemas/GlobalTableSettingsReplicationMode" description: "Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values: ENABLED: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table. DISABLED: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table." + VectorIndexUpdates: + $ref: "#/components/schemas/VectorIndexUpdateList" + description: A list of vector indexes to be added to or removed from the table. You can add or remove one vector index for each UpdateTable operation. To add a vector index, specify IndexName, VectorAttribute, Dimensions, DistanceFunction, and Projection. To remove a vector index, specify only the IndexName. required: - TableName responses: @@ -2688,6 +2759,10 @@ components: type: object properties: {} description: The amount of throughput consumed on each global index affected by the operation. + VectorIndexes: + type: object + properties: {} + description: The amount of throughput consumed on each vector index affected by the operation. Each entry contains VectorWriteRequestBytes (for write operations) or VectorSearchRequestBytes (for search operations). TableArn: type: string minLength: 1 @@ -2748,7 +2823,7 @@ components: description: "A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations. Each entry consists of the following subelements: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item. SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate." ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacityMultiple" - description: "The capacity units consumed by the entire BatchWriteItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed." + description: "The capacity units consumed by the entire BatchWriteItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed. If the table has vector indexes, each element also includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index." BackupName: type: string minLength: 3 @@ -3272,6 +3347,82 @@ components: type: boolean ResourcePolicy: type: string + VectorIndexList: + type: array + items: + $ref: "#/components/schemas/VectorIndex" + VectorIndex: + description: Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection. + type: object + properties: + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index. + VectorAttribute: + $ref: "#/components/schemas/VectorAttributeDefinition" + description: The vector attribute configuration for the index. + SearchSchema: + $ref: "#/components/schemas/SearchSchema" + description: The search schema that defines partition key and inline filter attributes for the vector index. + Projection: + $ref: "#/components/schemas/Projection" + description: Specifies attributes that are copied (projected) from the table into the vector index. + Dimensions: + $ref: "#/components/schemas/PositiveLongObject" + description: The number of dimensions in each vector. + DistanceFunction: + $ref: "#/components/schemas/VectorDistanceFunction" + description: "The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT." + required: + - IndexName + - VectorAttribute + - Projection + - Dimensions + - DistanceFunction + VectorAttributeDefinition: + description: The definition of a vector attribute for a vector index. + type: object + properties: + AttributeName: + $ref: "#/components/schemas/VectorAttributeName" + description: The name of the vector attribute. + required: + - AttributeName + VectorAttributeName: + type: string + minLength: 1 + maxLength: 255 + SearchSchema: + type: array + items: + $ref: "#/components/schemas/SearchSchemaElement" + SearchSchemaElement: + description: An element in the search schema of a vector index. + type: object + properties: + AttributeName: + $ref: "#/components/schemas/AttributeName" + description: The name of the attribute. + SearchSchemaElementType: + $ref: "#/components/schemas/SearchSchemaElementType" + description: "The role of the attribute in the search schema. Valid values: HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression. INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression." + required: + - AttributeName + - SearchSchemaElementType + AttributeName: + type: string + maxLength: 65535 + SearchSchemaElementType: + type: string + enum: + - HASH + - INLINE_FILTER + VectorDistanceFunction: + type: string + enum: + - COSINE + - DOT_PRODUCT + - EUCLIDEAN CreateTableOutput: description: Represents the output of a CreateTable operation. type: object @@ -3312,7 +3463,7 @@ components: description: The Amazon Resource Name (ARN) that uniquely identifies the table. TableId: $ref: "#/components/schemas/TableId" - description: Unique identifier for the table for which the backup was created. + description: A unique identifier for the table, in UUID format, generated by DynamoDB when the table is created. BillingModeSummary: $ref: "#/components/schemas/BillingModeSummary" description: Contains the details for the read/write capacity mode. @@ -3367,6 +3518,9 @@ components: MultiRegionConsistency: $ref: "#/components/schemas/MultiRegionConsistency" description: "Indicates one of the following consistency modes for a global table: EVENTUAL: Indicates that the global table is configured for multi-Region eventual consistency (MREC). STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC). If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide." + VectorIndexes: + $ref: "#/components/schemas/VectorIndexDescriptionList" + description: "The vector indexes, if any, on the table. Each element is composed of: IndexName - The name of the vector index. IndexStatus - The current status of the vector index: CREATING, ACTIVE, or DELETING. Backfilling - Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results. VectorAttribute - The attribute that contains vector embeddings. Dimensions - The number of dimensions in each vector. DistanceFunction - The distance function used to calculate similarity (COSINE, EUCLIDEAN, or DOT_PRODUCT). SearchSchema - The partition key and inline filter attributes for the vector index. Projection - Specifies attributes that are copied (projected) from the table into the vector index. IndexArn - The Amazon Resource Name (ARN) that uniquely identifies the index. IndexSizeBytes - The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. ItemCount - The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value." ProvisionedThroughputDescription: description: Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. type: object @@ -3382,10 +3536,10 @@ components: description: The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. ReadCapacityUnits: $ref: "#/components/schemas/NonNegativeLongObject" - description: The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second. + description: The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second. For a table or global secondary index that uses on-demand capacity mode (PAY_PER_REQUEST), this value is 0, because on-demand mode does not use provisioned throughput. WriteCapacityUnits: $ref: "#/components/schemas/NonNegativeLongObject" - description: The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. + description: The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For a table or global secondary index that uses on-demand capacity mode (PAY_PER_REQUEST), this value is 0, because on-demand mode does not use provisioned throughput. NonNegativeLongObject: type: integer format: int64 @@ -3563,6 +3717,47 @@ components: enum: - EVENTUAL - STRONG + VectorIndexDescriptionList: + type: array + items: + $ref: "#/components/schemas/VectorIndexDescription" + VectorIndexDescription: + description: Contains the current state and configuration of a vector index, including its status, size, item count, and the settings specified when the index was created. + type: object + properties: + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index. + SearchSchema: + $ref: "#/components/schemas/SearchSchema" + description: The search schema that defines partition key and inline filter attributes for the vector index. + Projection: + $ref: "#/components/schemas/Projection" + description: Specifies attributes that are copied (projected) from the table into the vector index. + VectorAttribute: + $ref: "#/components/schemas/VectorAttributeDefinition" + description: The vector attribute configuration for the index. + Dimensions: + $ref: "#/components/schemas/PositiveLongObject" + description: The number of dimensions in each vector. + DistanceFunction: + $ref: "#/components/schemas/VectorDistanceFunction" + description: The distance function used to calculate similarity between vectors. + IndexStatus: + $ref: "#/components/schemas/IndexStatus" + description: "The current state of the vector index: CREATING - The index is being created. ACTIVE - The index is ready for use. DELETING - The index is being deleted." + Backfilling: + $ref: "#/components/schemas/Backfilling" + description: Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results. + IndexSizeBytes: + $ref: "#/components/schemas/LongObject" + description: The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + ItemCount: + $ref: "#/components/schemas/LongObject" + description: The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + IndexArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) that uniquely identifies the vector index. DeleteBackupOutput: type: object properties: @@ -3647,6 +3842,9 @@ components: SSEDescription: $ref: "#/components/schemas/SSEDescription" description: The description of the server-side encryption status on the table when the backup was created. + VectorIndexes: + $ref: "#/components/schemas/VectorIndexes" + description: The vector index properties for the table at the time the backup was created, including the index name, vector attribute, dimensions, distance function, search schema, and projection. LocalSecondaryIndexes: type: array items: @@ -3707,6 +3905,32 @@ components: type: string minLength: 1 maxLength: 255 + VectorIndexes: + type: array + items: + $ref: "#/components/schemas/VectorIndexInfo" + VectorIndexInfo: + description: Contains the configuration of a vector index as it existed at the time a backup was created. + type: object + properties: + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index. + VectorAttribute: + $ref: "#/components/schemas/VectorAttributeDefinition" + description: The vector attribute configuration for the index. + SearchSchema: + $ref: "#/components/schemas/SearchSchema" + description: The search schema that defines partition key and inline filter attributes for the vector index. + Projection: + $ref: "#/components/schemas/Projection" + description: Specifies attributes that are copied (projected) from the table into the vector index. + Dimensions: + $ref: "#/components/schemas/PositiveLongObject" + description: The number of dimensions in each vector. + DistanceFunction: + $ref: "#/components/schemas/VectorDistanceFunction" + description: The distance function used to calculate similarity between vectors. Key: type: object properties: {} @@ -3744,7 +3968,7 @@ components: description: A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request. ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacity" - description: The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide. + description: The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide. If the table has vector indexes, the response includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index. ItemCollectionMetrics: $ref: "#/components/schemas/ItemCollectionMetrics" description: "Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate." @@ -4076,7 +4300,7 @@ components: description: Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used. ExportViewType: $ref: "#/components/schemas/ExportViewType" - description: The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES. + description: The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES. NEW_AND_OLD_IMAGES exports both the new and old images of each changed item, while NEW_IMAGES exports only the new (latest) image. The view type you choose determines the structure of each item in the output for insert, update, and delete operations. For details and examples of how each view type shapes the export output, see DynamoDB table export output format in the Amazon DynamoDB Developer Guide. ExportFromTime: type: string format: date-time @@ -4402,6 +4626,9 @@ components: GlobalSecondaryIndexes: $ref: "#/components/schemas/GlobalSecondaryIndexList" description: The Global Secondary Indexes (GSI) of the table to be created as part of the import operation. + VectorIndexes: + $ref: "#/components/schemas/VectorIndexList" + description: The vector indexes of the table to be created as part of the import operation. required: - TableName - AttributeDefinitions @@ -4654,9 +4881,6 @@ components: type: array items: $ref: "#/components/schemas/AttributeName" - AttributeName: - type: string - maxLength: 65535 ProjectionExpression: type: string GetItemOutput: @@ -4889,7 +5113,7 @@ components: description: The time at which this import task began. EndTime: $ref: "#/components/schemas/ImportEndTime" - description: The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?) + description: The time at which this import task ended. ListTablesInputLimit: type: integer minimum: 1 @@ -4929,7 +5153,7 @@ components: description: The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value. ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacity" - description: The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide. + description: The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide. If the table has vector indexes, the response includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index. ItemCollectionMetrics: $ref: "#/components/schemas/ItemCollectionMetrics" description: "Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate." @@ -5018,6 +5242,50 @@ components: ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacity" description: The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide. + SearchVectorList: + type: array + items: + $ref: "#/components/schemas/AttributeValue" + TopKInteger: + type: integer + minimum: 1 + SearchVectorsOutput: + type: object + properties: + ConsumedCapacity: + $ref: "#/components/schemas/VectorCapacity" + description: The capacity units consumed by the SearchVectors operation. Contains VectorSearchRequestBytes, which represents the vector search capacity consumed. + SearchResults: + $ref: "#/components/schemas/SearchResultList" + description: A list of items returned by the vector similarity search, sorted by similarity with the most similar item first. Each item contains the projected attributes and a similarity score. + VectorCapacity: + description: The consumed capacity for vector index operations, including vector search request bytes and vector write request bytes. + type: object + properties: + VectorSearchRequestBytes: + $ref: "#/components/schemas/ConsumedCapacityUnits" + description: The number of vector search request bytes consumed by a SearchVectors operation. + VectorWriteRequestBytes: + $ref: "#/components/schemas/ConsumedCapacityUnits" + description: The number of vector write request bytes consumed when writing to a vector index. Reported for write operations that modify attributes indexed by a vector index. + SearchResultList: + type: array + items: + $ref: "#/components/schemas/SearchResultItem" + SearchResultItem: + description: A single result from a SearchVectors operation. + type: object + properties: + Item: + type: object + properties: {} + description: A map of attribute names to AttributeValue objects, representing the projected attributes of the item returned by the vector search. + Score: + $ref: "#/components/schemas/ScoreNumber" + description: The similarity score for this item relative to the search vector. The interpretation depends on the distance function configured for the vector index. + ScoreNumber: + type: number + format: double TransactGetItemList: type: array items: @@ -5205,7 +5473,7 @@ components: properties: ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacityMultiple" - description: The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter. + description: The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter. If the table has vector indexes, each element also includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index. ItemCollectionMetrics: type: object properties: {} @@ -5429,7 +5697,7 @@ components: description: A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter. The Attributes map is only present if the update was successful and ReturnValues was specified as something other than NONE in the request. Each element represents one attribute. ConsumedCapacity: $ref: "#/components/schemas/ConsumedCapacity" - description: The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide. + description: The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide. If the table has vector indexes, the response includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index. ItemCollectionMetrics: $ref: "#/components/schemas/ItemCollectionMetrics" description: "Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate." @@ -5650,6 +5918,57 @@ components: description: The witness Region name to be removed from the MRSC global table. required: - RegionName + VectorIndexUpdateList: + type: array + items: + $ref: "#/components/schemas/VectorIndexUpdate" + VectorIndexUpdate: + description: A vector index to be added to or removed from a table. + type: object + properties: + Create: + $ref: "#/components/schemas/CreateVectorIndexAction" + description: The configuration for creating a new vector index on the table. + Delete: + $ref: "#/components/schemas/DeleteVectorIndexAction" + description: The configuration for deleting an existing vector index from the table. + CreateVectorIndexAction: + description: A new vector index to be added to a table. + type: object + properties: + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index. Must be unique within the table. + VectorAttribute: + $ref: "#/components/schemas/VectorAttributeDefinition" + description: The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions. + SearchSchema: + $ref: "#/components/schemas/SearchSchema" + description: The partition key and inline filter attribute definitions for the vector index. + Projection: + $ref: "#/components/schemas/Projection" + description: Specifies attributes that are copied (projected) from the table into the vector index. + Dimensions: + $ref: "#/components/schemas/PositiveLongObject" + description: The number of dimensions in each vector. + DistanceFunction: + $ref: "#/components/schemas/VectorDistanceFunction" + description: "The distance function used to calculate similarity. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT." + required: + - IndexName + - VectorAttribute + - Projection + - Dimensions + - DistanceFunction + DeleteVectorIndexAction: + description: A vector index to be removed from a table. + type: object + properties: + IndexName: + $ref: "#/components/schemas/IndexName" + description: The name of the vector index to delete. + required: + - IndexName UpdateTableOutput: description: Represents the output of an UpdateTable operation. type: object @@ -6660,3 +6979,27 @@ components: - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" delete: [] + vectors: + id: aws.dynamodb.vectors + name: vectors + title: vectors + methods: + search_vectors: + operation: + $ref: "#/paths/~1SearchVectors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/vectors/methods/search_vectors" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/ec2.yaml b/providers/src/aws/v00.00.00000/services/ec2.yaml index f65847db..57e7c595 100644 --- a/providers/src/aws/v00.00.00000/services/ec2.yaml +++ b/providers/src/aws/v00.00.00000/services/ec2.yaml @@ -677,6 +677,12 @@ paths: description: The ID of the Availability Zone. schema: $ref: "#/components/schemas/AvailabilityZoneId" + - name: CpuOptions + in: query + required: false + description: The CPU configuration options to apply to the Dedicated Host. + schema: + $ref: "#/components/schemas/HostCpuOptionsRequest" - name: AutoPlacement in: query required: false @@ -797,6 +803,12 @@ paths: description: Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. schema: $ref: "#/components/schemas/IpamPoolAllocationDisallowedCidrs" + - name: TagSpecification + in: query + required: false + description: The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. If you specify tags, the request is authorized against the allocation resource in addition to the pool resource. + schema: + $ref: "#/components/schemas/TagSpecificationList" responses: "200": description: Success @@ -1156,6 +1168,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/AssociateAddressRequest" + /?Action=AssociateApplicationStatusCheck&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_AssociateApplicationStatusCheck + description: "Associates an application status check with instances or tags. Once you create an association, health monitoring automatically begins for the specified instances or for instances that match the specified tags. The following rules apply: You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error. The application status check must already exist and belong to your account. Tag keys must not be blank. Maximum 50 tag associations per application status check. Use DisassociateApplicationStatusCheck to remove associations. When you associate tags, the application status check automatically monitors all current and future instances that have the specified tags." + parameters: + - name: ApplicationStatusCheckId + in: query + required: true + description: The ID of the application status check to associate. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckId" + - name: TargetTagAssociation + in: query + required: false + description: The tags to associate the application status check with. Each tag is a key-value pair. When you associate tags, the application status check automatically monitors all instances that have the specified tags. + schema: + $ref: "#/components/schemas/CustomKeyValuePairRequestSet" + - name: InstanceId + in: query + required: false + description: The IDs of the instances to associate with the application status check. + schema: + $ref: "#/components/schemas/InstanceIdList" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AssociateApplicationStatusCheckOutputDisplay" + post: + operationId: POST_AssociateApplicationStatusCheck + description: "Associates an application status check with instances or tags. Once you create an association, health monitoring automatically begins for the specified instances or for instances that match the specified tags. The following rules apply: You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error. The application status check must already exist and belong to your account. Tag keys must not be blank. Maximum 50 tag associations per application status check. Use DisassociateApplicationStatusCheck to remove associations. When you associate tags, the application status check automatically monitors all current and future instances that have the specified tags." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AssociateApplicationStatusCheckOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/AssociateApplicationStatusCheckRequest" /?Action=AssociateCapacityReservationBillingOwner&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -2306,6 +2384,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/AttachClassicLinkVpcRequest" + /?Action=AttachImageWatermark&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_AttachImageWatermark + description: Attaches a watermark to a non-public AMI. The watermark is a structured identifier that automatically propagates to all derivative images created through CreateImage, and CopyImage. Only the AMI owner can attach watermarks. Watermarks cannot be added to public AMIs. + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + $ref: "#/components/schemas/ImageId" + - name: WatermarkName + in: query + required: true + description: "The name for the watermark. Combined with the caller's account ID to form the WatermarkKey (accountId:watermarkName). Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)" + schema: + $ref: "#/components/schemas/ImageWatermarkNameRequest" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AttachImageWatermarkOutputDisplay" + post: + operationId: POST_AttachImageWatermark + description: Attaches a watermark to a non-public AMI. The watermark is a structured identifier that automatically propagates to all derivative images created through CreateImage, and CopyImage. Only the AMI owner can attach watermarks. Watermarks cannot be added to public AMIs. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AttachImageWatermarkOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/AttachImageWatermarkRequest" /?Action=AttachInternetGateway&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -2886,6 +3018,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/AuthorizeSecurityGroupIngressRequest" + /?Action=BatchModifyIpamRoutingPolicyRegistrations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_BatchModifyIpamRoutingPolicyRegistrations + description: Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: DeltaJson + in: query + required: true + description: The batch modifications to apply, in JSON format. + schema: + $ref: "#/components/schemas/String" + - name: Force + in: query + required: false + description: "Forces the batch modification even if individual changes conflict with announced routes. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsOutputDisplay" + post: + operationId: POST_BatchModifyIpamRoutingPolicyRegistrations + description: Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsRequest" /?Action=BundleInstance&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -2897,7 +3095,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_BundleInstance - description: Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. This action is no longer supported. To create an AMI, use CreateImage. For more information, see Create an Amazon EBS-backed AMI in the Amazon EC2 User Guide. + description: Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. BundleInstance is no longer supported. To create an AMI, use CreateImage instead. For more information about creating an Amazon EBS-backed AMI, see Create an Amazon EBS-backed AMI in the Amazon EC2 User Guide. parameters: - name: InstanceId in: query @@ -2926,7 +3124,7 @@ paths: $ref: "#/components/schemas/BundleInstanceOutputDisplay" post: operationId: POST_BundleInstance - description: Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. This action is no longer supported. To create an AMI, use CreateImage. For more information, see Create an Amazon EBS-backed AMI in the Amazon EC2 User Guide. + description: Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. BundleInstance is no longer supported. To create an AMI, use CreateImage instead. For more information about creating an Amazon EBS-backed AMI, see Create an Amazon EBS-backed AMI in the Amazon EC2 User Guide. responses: "200": description: Success @@ -2951,7 +3149,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CancelBundleTask - description: Cancels a bundling operation for an instance store-backed Windows instance. + description: Cancels a bundling operation for an instance store-backed Windows instance. CancelBundleTask is no longer supported because BundleInstance, the operation it cancels, is no longer supported. parameters: - name: BundleId in: query @@ -2974,7 +3172,7 @@ paths: $ref: "#/components/schemas/CancelBundleTaskOutputDisplay" post: operationId: POST_CancelBundleTask - description: Cancels a bundling operation for an instance store-backed Windows instance. + description: Cancels a bundling operation for an instance store-backed Windows instance. CancelBundleTask is no longer supported because BundleInstance, the operation it cancels, is no longer supported. responses: "200": description: Success @@ -2999,7 +3197,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CancelCapacityReservation - description: "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. You can cancel a Capacity Reservation that is in the following states: assessing active and there is no commitment duration or the commitment duration has elapsed. You can't cancel a future-dated Capacity Reservation during the commitment duration. You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. If a future-dated Capacity Reservation enters the delayed state, the commitment duration is waived, and you can cancel it as soon as it enters the active state. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity." + description: "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. You can cancel a Capacity Reservation that is in the following states: assessing scheduled — requires a cancellation quote. Use CreateCapacityReservationCancellationQuote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The cancellation charge depends on how close the reservation is to its start date. active and there is no commitment duration or the commitment duration has elapsed. active during the commitment duration — requires a cancellation quote. Use CreateCapacityReservationCancellationQuote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The Capacity Reservation transitions to cancelling while charges are applied. delayed — the commitment duration is waived, so no cancellation charge applies. You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity." parameters: - name: CapacityReservationId in: query @@ -3013,6 +3211,18 @@ paths: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. schema: $ref: "#/components/schemas/Boolean" + - name: ApplyCancellationCharges + in: query + required: false + description: Specifies the cancellation charge type to apply when cancelling a future-dated Capacity Reservation during its commitment duration. Possible values include commitment-wind-down, which continues billing for the remaining commitment duration without delivering capacity. + schema: + $ref: "#/components/schemas/ApplyCancellationCharges" + - name: QuoteId + in: query + required: false + description: The ID of the cancellation quote to use for the cancellation. You can generate a cancellation quote by using the CreateCapacityReservationCancellationQuote action. The cancellation quote must be in an active state. + schema: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteId" responses: "200": description: Success @@ -3022,7 +3232,7 @@ paths: $ref: "#/components/schemas/CancelCapacityReservationOutputDisplay" post: operationId: POST_CancelCapacityReservation - description: "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. You can cancel a Capacity Reservation that is in the following states: assessing active and there is no commitment duration or the commitment duration has elapsed. You can't cancel a future-dated Capacity Reservation during the commitment duration. You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. If a future-dated Capacity Reservation enters the delayed state, the commitment duration is waived, and you can cancel it as soon as it enters the active state. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity." + description: "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. You can cancel a Capacity Reservation that is in the following states: assessing scheduled — requires a cancellation quote. Use CreateCapacityReservationCancellationQuote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The cancellation charge depends on how close the reservation is to its start date. active and there is no commitment duration or the commitment duration has elapsed. active during the commitment duration — requires a cancellation quote. Use CreateCapacityReservationCancellationQuote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The Capacity Reservation transitions to cancelling while charges are applied. delayed — the commitment duration is waived, so no cancellation charge applies. You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity." responses: "200": description: Success @@ -3902,6 +4112,144 @@ paths: text/xml: schema: $ref: "#/components/schemas/CopyVolumesRequest" + /?Action=CreateApplicationStatusCheck&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateApplicationStatusCheck + description: "Creates an application status check for monitoring the health of applications running on your instances. You can configure the protocol, port, path, and thresholds for the health check. The following rules apply: You can create a maximum of 50 application status checks per account. Health checks do not start until you associate the check with instances or tags using AssociateApplicationStatusCheck. The Timeout value must be less than the Interval value. The Path must start with a forward slash (/). Default: /. If you do not specify Aggregation, it defaults to included, which means the check contributes to the instance-level application status. Default values: Interval is 60 seconds, Timeout is 6 seconds, FailureThreshold is 2, SuccessThreshold is 2, StatusCodeMatcher is 200, InitializationGracePeriodSeconds is 300 seconds. You can tag the application status check during creation. For more information, see Tag your Amazon EC2 resources." + parameters: + - name: HealthCheckPath + in: query + required: false + description: The health check paths to use for the application status check. Health check paths define the network path from a source subnet to one or more destination subnets for cross-Availability Zone or Availability Zone to Local Zone health checking. If omitted, health checks are performed in the same subnet as the instance. + schema: + $ref: "#/components/schemas/HealthCheckPathRequestList" + - name: Aggregation + in: query + required: false + description: "The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded." + schema: + $ref: "#/components/schemas/AggregationStatusEnum" + - name: Protocol + in: query + required: false + description: "The protocol to use for the health check. Valid values: http | https." + schema: + $ref: "#/components/schemas/NetworkProtocolEnum" + - name: Port + in: query + required: false + description: "The port to use for the health check. Valid values: 1 to 65535." + schema: + $ref: "#/components/schemas/PortNumber" + - name: Path + in: query + required: false + description: The URL path to use for the health check HTTP request (for example, /health or /status). + schema: + $ref: "#/components/schemas/String" + - name: DeviceIndex + in: query + required: false + description: The index of the network device to use for the health check. The value must be greater than or equal to 0. + schema: + $ref: "#/components/schemas/Integer" + - name: IpVersion + in: query + required: false + description: "The IP version to use for the health check. Valid values: ipv4 and ipv6." + schema: + $ref: "#/components/schemas/IpVersionEnum" + - name: IpScope + in: query + required: false + description: "The IP scope to use for the health check. Valid value: private." + schema: + $ref: "#/components/schemas/IpScopeEnum" + - name: Interval + in: query + required: false + description: "The interval, in seconds, between health checks. Valid value: 60." + schema: + $ref: "#/components/schemas/Integer" + - name: Timeout + in: query + required: false + description: "The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval." + schema: + $ref: "#/components/schemas/Integer" + - name: FailureThreshold + in: query + required: false + description: The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0. + schema: + $ref: "#/components/schemas/Integer" + - name: SuccessThreshold + in: query + required: false + description: The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0. + schema: + $ref: "#/components/schemas/Integer" + - name: StatusCodeMatcher + in: query + required: false + description: "The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters. Default: 200." + schema: + $ref: "#/components/schemas/String" + - name: InitializationGracePeriodSeconds + in: query + required: false + description: "The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600." + schema: + $ref: "#/components/schemas/InitializationGracePeriodSeconds" + - name: TagSpecification + in: query + required: false + description: The tags to apply to the application status check. + schema: + $ref: "#/components/schemas/TagSpecificationList" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateApplicationStatusCheckOutputDisplay" + post: + operationId: POST_CreateApplicationStatusCheck + description: "Creates an application status check for monitoring the health of applications running on your instances. You can configure the protocol, port, path, and thresholds for the health check. The following rules apply: You can create a maximum of 50 application status checks per account. Health checks do not start until you associate the check with instances or tags using AssociateApplicationStatusCheck. The Timeout value must be less than the Interval value. The Path must start with a forward slash (/). Default: /. If you do not specify Aggregation, it defaults to included, which means the check contributes to the instance-level application status. Default values: Interval is 60 seconds, Timeout is 6 seconds, FailureThreshold is 2, SuccessThreshold is 2, StatusCodeMatcher is 200, InitializationGracePeriodSeconds is 300 seconds. You can tag the application status check during creation. For more information, see Tag your Amazon EC2 resources." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateApplicationStatusCheckOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateApplicationStatusCheckRequest" /?Action=CreateCapacityManagerDataExport&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -4196,6 +4544,66 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateCapacityReservationBySplittingRequest" + /?Action=CreateCapacityReservationCancellationQuote&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateCapacityReservationCancellationQuote + description: Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours. + parameters: + - name: CapacityReservationId + in: query + required: true + description: The ID of the Capacity Reservation. + schema: + $ref: "#/components/schemas/CapacityReservationId" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. + schema: + $ref: "#/components/schemas/String" + - name: TagSpecification + in: query + required: false + description: The tags to apply to the cancellation quote. + schema: + $ref: "#/components/schemas/TagSpecificationList" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateCapacityReservationCancellationQuoteOutputDisplay" + post: + operationId: POST_CreateCapacityReservationCancellationQuote + description: Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateCapacityReservationCancellationQuoteOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateCapacityReservationCancellationQuoteRequest" /?Action=CreateCapacityReservationFleet&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -4223,7 +4631,7 @@ paths: $ref: "#/components/schemas/String" - name: InstanceTypeSpecification in: query - required: true + required: false description: Information about the instance types for which to reserve the capacity. schema: $ref: "#/components/schemas/ReservationFleetInstanceSpecificationList" @@ -5166,7 +5574,7 @@ paths: - name: TagSpecification in: query required: false - description: The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources. If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch. If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template. + description: The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources. If the fleet type is instant, specify a resource type of fleet to tag the fleet, instance to tag the instances at launch, volume to tag the volumes at launch, or network-interface to tag the network interfaces at launch. If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance, volume, or network-interface. To tag instances at launch, specify the tags in a launch template. schema: $ref: "#/components/schemas/TagSpecificationList" - name: Context @@ -5244,7 +5652,7 @@ paths: - name: ResourceId in: query required: true - description: "The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types." + description: "The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 300 for the other resource types." schema: $ref: "#/components/schemas/FlowLogResourceIds" - name: ResourceType @@ -5295,6 +5703,12 @@ paths: description: The destination options. schema: $ref: "#/components/schemas/DestinationOptionsRequest" + - name: TagFieldSpecification + in: query + required: false + description: The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format. + schema: + $ref: "#/components/schemas/TagFieldSpecificationListRequest" responses: "200": description: Success @@ -5407,7 +5821,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreateImage - description: "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: If the source instance is in a Region, you must create the snapshots in the same Region as the instance. If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide." + description: "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: If the source instance is in a Region, you must create the snapshots in the same Region as the instance. If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. If the source instance is on an Outpost that supports local snapshots, you can create the snapshots on the same Outpost or in the parent Region of that Outpost. In this case, you must use the SnapshotLocation parameter to specify where to create the snapshots. For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide." parameters: - name: TagSpecification in: query @@ -5418,7 +5832,7 @@ paths: - name: SnapshotLocation in: query required: false - description: "Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter. The Amazon S3 location where the snapshots will be stored. To create local snapshots in the same Local Zone as the source instance, specify local. To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter. Default: regional" + description: "Only supported for instances in Local Zones and for instances on Outposts that support local snapshots. If the source instance is not in one of these locations, omit this parameter. The Amazon S3 location where the snapshots will be stored. To create local snapshots in the same Local Zone or on the same Outpost as the source instance, specify local. To create regional snapshots in the parent Region of the Local Zone or Outpost, specify regional. If the source instance is in a Local Zone and you omit this parameter, regional snapshots are created in the parent Region of the Local Zone. If the source instance is on an Outpost that supports local snapshots, this parameter is required. If you omit it, the request fails with an InvalidParameterValue error. Default: regional (for instances in Local Zones only)" schema: $ref: "#/components/schemas/SnapshotLocationEnum" - name: DryRun @@ -5466,7 +5880,7 @@ paths: $ref: "#/components/schemas/CreateImageOutputDisplay" post: operationId: POST_CreateImage - description: "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: If the source instance is in a Region, you must create the snapshots in the same Region as the instance. If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide." + description: "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: If the source instance is in a Region, you must create the snapshots in the same Region as the instance. If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. If the source instance is on an Outpost that supports local snapshots, you can create the snapshots on the same Outpost or in the parent Region of that Outpost. In this case, you must use the SnapshotLocation parameter to specify where to create the snapshots. For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide." responses: "200": description: Success @@ -6020,6 +6434,84 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateIpamExternalResourceVerificationTokenRequest" + /?Action=CreateIpamInternetRegistryAssociation&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateIpamInternetRegistryAssociation + description: Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamId + in: query + required: true + description: The ID of the IPAM to associate with the internet registry. + schema: + $ref: "#/components/schemas/IpamId" + - name: Rir + in: query + required: false + description: "The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean)." + schema: + $ref: "#/components/schemas/Rir" + - name: OrganizationHandle + in: query + required: true + description: The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID). + schema: + $ref: "#/components/schemas/String" + - name: Description + in: query + required: false + description: A description for the internet registry association. + schema: + $ref: "#/components/schemas/String" + - name: TagSpecification + in: query + required: false + description: The tags to assign to the internet registry association. + schema: + $ref: "#/components/schemas/TagSpecificationList" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamInternetRegistryAssociationOutputDisplay" + post: + operationId: POST_CreateIpamInternetRegistryAssociation + description: Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamInternetRegistryAssociationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamInternetRegistryAssociationRequest" /?Action=CreateIpamPolicy&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -6446,6 +6938,96 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateIpamResourceDiscoveryRequest" + /?Action=CreateIpamRoutingPolicyRegistration&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateIpamRoutingPolicyRegistration + description: Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: Cidr + in: query + required: false + description: The IP address prefix in CIDR notation to authorize in the ROA. + schema: + $ref: "#/components/schemas/String" + - name: Asn + in: query + required: false + description: The Autonomous System Numbers (ASNs) authorized to originate the prefix. + schema: + $ref: "#/components/schemas/AsnList" + - name: PermitMoreSpecificAnnouncements + in: query + required: false + description: "Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: MaxLength + in: query + required: false + description: The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only). + schema: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationMaxLength" + - name: Description + in: query + required: false + description: A description for the routing policy registration. + schema: + $ref: "#/components/schemas/String" + - name: Force + in: query + required: false + description: "Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamRoutingPolicyRegistrationOutputDisplay" + post: + operationId: POST_CreateIpamRoutingPolicyRegistration + description: Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamRoutingPolicyRegistrationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateIpamRoutingPolicyRegistrationRequest" /?Action=CreateIpamScope&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -6614,7 +7196,7 @@ paths: required: true description: A name for the launch template. schema: - $ref: "#/components/schemas/LaunchTemplateName" + $ref: "#/components/schemas/String" - name: VersionDescription in: query required: false @@ -7967,7 +8549,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreatePlacementGroup - description: Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement groups in the Amazon EC2 User Guide. + description: Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. A precision-time placement group places instances on supported hardware with direct access to high-precision time sources in Amazon Web Services infrastructure. For more information, see Placement groups in the Amazon EC2 User Guide. parameters: - name: PartitionCount in: query @@ -7999,6 +8581,12 @@ paths: description: Reserved for internal use. schema: $ref: "#/components/schemas/OperatorRequest" + - name: ParentGroupId + in: query + required: false + description: The ID of a parent placement group. Valid only when Strategy is set to cluster. + schema: + $ref: "#/components/schemas/PlacementGroupId" - name: DryRun in: query required: false @@ -8026,7 +8614,7 @@ paths: $ref: "#/components/schemas/CreatePlacementGroupOutputDisplay" post: operationId: POST_CreatePlacementGroup - description: Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement groups in the Amazon EC2 User Guide. + description: Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. A precision-time placement group places instances on supported hardware with direct access to high-precision time sources in Amazon Web Services infrastructure. For more information, see Placement groups in the Amazon EC2 User Guide. responses: "200": description: Success @@ -8105,7 +8693,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreateReplaceRootVolumeTask - description: Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance. For more information, see Replace a root volume in the Amazon EC2 User Guide. + description: Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, that is restored from an AMI that has the same key characteristics as that of the instance, or that is replaced by a specified volume. For more information, see Replace a root volume in the Amazon EC2 User Guide. parameters: - name: InstanceId in: query @@ -8116,7 +8704,7 @@ paths: - name: SnapshotId in: query required: false - description: The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter. + description: The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, if you want to restore the replacement root volume from an AMI, or if you want to replace the root volume with a specified volume, omit this parameter. schema: $ref: "#/components/schemas/SnapshotId" - name: ClientToken @@ -8140,7 +8728,7 @@ paths: - name: ImageId in: query required: false - description: The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter. + description: The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, if you want to restore it to its launch state, or if you want to replace the root volume with a specified volume, omit this parameter. schema: $ref: "#/components/schemas/ImageId" - name: DeleteReplacedRootVolume @@ -8155,6 +8743,12 @@ paths: description: "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. Omit this parameter if: You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide. Valid range: 100 - 300 MiB/s" schema: $ref: "#/components/schemas/Long" + - name: VolumeId + in: query + required: false + description: The ID of the volume to use as the replacement root volume. The specified volume must be in the same Availability Zone as the instance, must be in the available state, and must not be attached to an instance. If the original root volume is encrypted, the specified volume must also be encrypted. If you want to restore the replacement root volume from a specific snapshot, an AMI, or to its launch state, omit this parameter. + schema: + $ref: "#/components/schemas/VolumeId" responses: "200": description: Success @@ -8164,7 +8758,7 @@ paths: $ref: "#/components/schemas/CreateReplaceRootVolumeTaskOutputDisplay" post: operationId: POST_CreateReplaceRootVolumeTask - description: Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance. For more information, see Replace a root volume in the Amazon EC2 User Guide. + description: Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, that is restored from an AMI that has the same key characteristics as that of the instance, or that is replaced by a specified volume. For more information, see Replace a root volume in the Amazon EC2 User Guide. responses: "200": description: Success @@ -10330,6 +10924,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateTransitGatewayPolicyTableRequest" + /?Action=CreateTransitGatewayPolicyTableEntry&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateTransitGatewayPolicyTableEntry + description: Creates an entry in a transit gateway policy table to route matching traffic to a specified route table. + parameters: + - name: TransitGatewayPolicyTableId + in: query + required: true + description: The ID of the transit gateway policy table. + schema: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + - name: PolicyRuleNumber + in: query + required: true + description: The rule number for the policy table entry. Lower rule numbers are evaluated first and take precedence. + schema: + $ref: "#/components/schemas/String" + - name: PolicyRule + in: query + required: false + description: The matching criteria for the policy table entry. + schema: + $ref: "#/components/schemas/TransitGatewayRequestPolicyRule" + - name: TargetRouteTableId + in: query + required: true + description: The ID of the transit gateway route table to use for traffic matching this rule. + schema: + $ref: "#/components/schemas/TransitGatewayRouteTableId" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateTransitGatewayPolicyTableEntryOutputDisplay" + post: + operationId: POST_CreateTransitGatewayPolicyTableEntry + description: Creates an entry in a transit gateway policy table to route matching traffic to a specified route table. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateTransitGatewayPolicyTableEntryOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateTransitGatewayPolicyTableEntryRequest" /?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -12038,6 +12698,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateVpnGatewayRequest" + /?Action=DeleteApplicationStatusCheck&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DeleteApplicationStatusCheck + description: "Deletes an application status check. The following rules apply: Deleting a check automatically removes all of its associations. Use DescribeApplicationStatusChecks to view existing checks before deleting." + parameters: + - name: ApplicationStatusCheckId + in: query + required: true + description: The ID of the application status check to delete. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckId" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteApplicationStatusCheckOutputDisplay" + post: + operationId: POST_DeleteApplicationStatusCheck + description: "Deletes an application status check. The following rules apply: Deleting a check automatically removes all of its associations. Use DescribeApplicationStatusChecks to view existing checks before deleting." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteApplicationStatusCheckOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteApplicationStatusCheckRequest" /?Action=DeleteCapacityManagerDataExport&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -12914,6 +13628,54 @@ paths: text/xml: schema: $ref: "#/components/schemas/DeleteIpamExternalResourceVerificationTokenRequest" + /?Action=DeleteIpamInternetRegistryAssociation&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DeleteIpamInternetRegistryAssociation + description: Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association to delete. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamInternetRegistryAssociationOutputDisplay" + post: + operationId: POST_DeleteIpamInternetRegistryAssociation + description: Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamInternetRegistryAssociationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamInternetRegistryAssociationRequest" /?Action=DeleteIpamPolicy&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -13160,6 +13922,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/DeleteIpamResourceDiscoveryRequest" + /?Action=DeleteIpamRoutingPolicyRegistration&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DeleteIpamRoutingPolicyRegistration + description: Deletes a routing policy registration for a specified CIDR prefix. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: Cidr + in: query + required: false + description: The IP address prefix in CIDR notation identifying the routing policy registration to delete. + schema: + $ref: "#/components/schemas/String" + - name: Force + in: query + required: false + description: "Forces the deletion even if it conflicts with an announced route. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamRoutingPolicyRegistrationOutputDisplay" + post: + operationId: POST_DeleteIpamRoutingPolicyRegistration + description: Deletes a routing policy registration for a specified CIDR prefix. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamRoutingPolicyRegistrationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteIpamRoutingPolicyRegistrationRequest" /?Action=DeleteIpamScope&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -14161,7 +14989,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_DeletePlacementGroup - description: Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide. + description: Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. You cannot delete a placement group that is a parent of a cluster placement group. Delete the cluster placement groups first. For more information, see Placement groups in the Amazon EC2 User Guide. parameters: - name: DryRun in: query @@ -14180,7 +15008,7 @@ paths: description: Success post: operationId: POST_DeletePlacementGroup - description: Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide. + description: Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. You cannot delete a placement group that is a parent of a cluster placement group. Delete the cluster placement groups first. For more information, see Placement groups in the Amazon EC2 User Guide. responses: "200": description: Success @@ -15534,6 +16362,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/DeleteTransitGatewayPolicyTableRequest" + /?Action=DeleteTransitGatewayPolicyTableEntry&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DeleteTransitGatewayPolicyTableEntry + description: Deletes the specified transit gateway policy table entry. + parameters: + - name: TransitGatewayPolicyTableId + in: query + required: true + description: The ID of the transit gateway policy table. + schema: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + - name: PolicyRuleNumber + in: query + required: true + description: The rule number of the policy table entry to delete. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteTransitGatewayPolicyTableEntryOutputDisplay" + post: + operationId: POST_DeleteTransitGatewayPolicyTableEntry + description: Deletes the specified transit gateway policy table entry. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteTransitGatewayPolicyTableEntryOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteTransitGatewayPolicyTableEntryRequest" /?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -17018,6 +17900,48 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribeAccountAttributesRequest" + /?Action=DescribeAccountVpcEncryptionControl&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeAccountVpcEncryptionControl + description: Describes the account-level VPC Encryption Control configuration for your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeAccountVpcEncryptionControlOutputDisplay" + post: + operationId: POST_DescribeAccountVpcEncryptionControl + description: Describes the account-level VPC Encryption Control configuration for your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeAccountVpcEncryptionControlOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeAccountVpcEncryptionControlRequest" /?Action=DescribeAddressTransfers&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -17246,6 +18170,210 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribeAggregateIdFormatRequest" + /?Action=DescribeApplicationStatus&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeApplicationStatus + description: "Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply: The instance-level status is derived from all application status checks with the aggregation setting set to included. Use DescribeApplicationStatusChecks to view the configuration of individual checks. Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status." + parameters: + - name: InstanceId + in: query + required: false + description: The IDs of the instances for which to describe application status. + schema: + $ref: "#/components/schemas/InstanceIdList" + - name: Filter + in: query + required: false + description: The filters. availability-zone-id – The ID of the Availability Zone. status – The instance-level application status. For valid values and their meanings, see ApplicationStatus. + schema: + $ref: "#/components/schemas/FilterList" + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + schema: + $ref: "#/components/schemas/DescribeApplicationStatusMaxResults" + - name: NextToken + in: query + required: false + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusOutputDisplay" + post: + operationId: POST_DescribeApplicationStatus + description: "Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply: The instance-level status is derived from all application status checks with the aggregation setting set to included. Use DescribeApplicationStatusChecks to view the configuration of individual checks. Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusRequest" + /?Action=DescribeApplicationStatusCheckAssociations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeApplicationStatusCheckAssociations + description: Describes the associations for one or more application status checks. For more information, see Application status checks. To avoid timeouts and retrieve complete results, use the pagination parameters. The order of the elements in the response, including those within nested structures, might vary. + parameters: + - name: ApplicationStatusCheckId + in: query + required: false + description: The IDs of the application status checks for which to describe associations. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckIdList" + - name: Filter + in: query + required: false + description: "The filters to use to limit the results. association-type – The type of association. Valid values: tag and instance-id." + schema: + $ref: "#/components/schemas/FilterList" + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + schema: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsMaxResults" + - name: NextToken + in: query + required: false + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsOutputDisplay" + post: + operationId: POST_DescribeApplicationStatusCheckAssociations + description: Describes the associations for one or more application status checks. For more information, see Application status checks. To avoid timeouts and retrieve complete results, use the pagination parameters. The order of the elements in the response, including those within nested structures, might vary. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsRequest" + /?Action=DescribeApplicationStatusChecks&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeApplicationStatusChecks + description: "Describes one or more application status checks. Returns configuration details for your application status checks, including protocol, port, path, thresholds, and associations. The following rules apply: If you do not specify any application status check IDs, all checks in your account are returned. Use DescribeApplicationStatus to see the actual health status of instances." + parameters: + - name: ApplicationStatusCheckId + in: query + required: false + description: The IDs of the application status checks to describe. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckIdList" + - name: Filter + in: query + required: false + description: "The filters. aggregation – The aggregation setting. Valid values: included and excluded." + schema: + $ref: "#/components/schemas/FilterList" + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + schema: + $ref: "#/components/schemas/DescribeApplicationStatusChecksMaxResults" + - name: NextToken + in: query + required: false + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + schema: + $ref: "#/components/schemas/String" + - name: IncludeAll + in: query + required: false + description: Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to false, the response includes only active checks. + schema: + $ref: "#/components/schemas/Boolean" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusChecksOutputDisplay" + post: + operationId: POST_DescribeApplicationStatusChecks + description: "Describes one or more application status checks. Returns configuration details for your application status checks, including protocol, port, path, thresholds, and associations. The following rules apply: If you do not specify any application status check IDs, all checks in your account are returned. Use DescribeApplicationStatus to see the actual health status of instances." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusChecksOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeApplicationStatusChecksRequest" /?Action=DescribeAvailabilityZones&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -17984,6 +19112,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribeCapacityReservationBillingRequestsRequest" + /?Action=DescribeCapacityReservationCancellationQuotes&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeCapacityReservationCancellationQuotes + description: Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action. + parameters: + - name: CapacityReservationCancellationQuoteId + in: query + required: false + description: The IDs of the cancellation quotes to describe. + schema: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteIdSet" + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + schema: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesRequestMaxResults" + - name: NextToken + in: query + required: false + description: The token to use to retrieve the next page of results. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: Filter + in: query + required: false + description: One or more filters. Filter names and values are case-sensitive. + schema: + $ref: "#/components/schemas/FilterList" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesOutputDisplay" + post: + operationId: POST_DescribeCapacityReservationCancellationQuotes + description: Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesRequest" /?Action=DescribeCapacityReservationFleets&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -18084,7 +19278,7 @@ paths: - name: CapacityReservationId in: query required: false - description: "The Capacity Reservation IDs. Default: Describes all your Capacity Reservations. Constraints: Maximum 100 explicitly specified Capacity Reservation IDs." + description: "The Capacity Reservation IDs. Default: Describes all your Capacity Reservations. Constraints: Maximum 10 explicitly specified Capacity Reservation IDs." schema: $ref: "#/components/schemas/CapacityReservationIdSet" - name: Filter @@ -20388,7 +21582,7 @@ paths: - name: Filter in: query required: false - description: The filters. architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted. creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. free-tier-eligible - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (true | false). hypervisor - The hypervisor type (ovm | xen). image-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. image-id - The ID of the image. image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The owner alias (amazon | aws-backup-vault | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter. owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter. platform - The platform. The only supported value is windows. product-code - The product code. product-code.type - The type of the product code (marketplace). ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-image-id - The ID of the source AMI from which the AMI was created. source-image-region - The Region of the source AMI. source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm). + description: The filters. architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted. creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. free-tier-eligible - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (true | false). hypervisor - The hypervisor type (ovm | xen). image-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. image-id - The ID of the image. image-watermark.source-image-creation-time - The creation date of the source AMI, in the ISO 8601 format in the UTC time zone ( YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM ). You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. image-watermark.source-image-id - The ID of the AMI to which the watermark was originally attached. image-watermark.source-image-region - The Region where the watermark was originally attached. image-watermark.watermark-creation-time - The date and time the watermark was attached to the AMI, in the ISO 8601 format in the UTC time zone ( YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM ). You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. image-watermark.watermark-key - The watermark identifier, in accountId:watermarkName format (for example, 123456789012:approvedAmi). image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The owner alias (amazon | aws-backup-vault | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter. owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter. platform - The platform. The only supported value is windows. product-code - The product code. product-code.type - The type of the product code (marketplace). public-ssm-parameter-name - The name of a public Systems Manager parameter associated with the AMI. The parameter must be in a trusted Amazon Web Services namespace under aws/service/. Returns all AMIs that have ever been associated with the parameter, including previous versions. ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-image-id - The ID of the source AMI from which the AMI was created. source-image-region - The Region of the source AMI. source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm). schema: $ref: "#/components/schemas/FilterList" responses: @@ -21061,7 +22255,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_DescribeInstanceStatus - description: "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order." + description: "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide. Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order." parameters: - name: InstanceId in: query @@ -21096,7 +22290,7 @@ paths: - name: Filter in: query required: false - description: The filters. availability-zone - The Availability Zone of the instance. availability-zone-id - The ID of the Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). operator.managed - A Boolean that indicates whether this is a managed instance. operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true. system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable). + description: The filters. availability-zone - The Availability Zone of the instance. availability-zone-id - The ID of the Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). operator.managed - A Boolean that indicates whether this is a managed instance. operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true. system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable). application-status.status - The application status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). schema: $ref: "#/components/schemas/FilterList" - name: IncludeAllInstances @@ -21114,7 +22308,7 @@ paths: $ref: "#/components/schemas/DescribeInstanceStatusOutputDisplay" post: operationId: POST_DescribeInstanceStatus - description: "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order." + description: "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide. Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order." responses: "200": description: Success @@ -21221,7 +22415,7 @@ paths: $ref: "#/components/schemas/Boolean" - name: LocationType in: query - required: false + required: true description: The location type. availability-zone - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region. availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region. outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region. region - The current Region. If you specify a location filter, it must match the current Region. schema: $ref: "#/components/schemas/LocationType" @@ -21596,6 +22790,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribeIpamExternalResourceVerificationTokensRequest" + /?Action=DescribeIpamInternetRegistryAssociations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeIpamInternetRegistryAssociations + description: Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: false + description: The IDs of the internet registry associations to describe. + schema: + $ref: "#/components/schemas/ValueStringList" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + - name: Filter + in: query + required: false + description: One or more filters to apply to the results. + schema: + $ref: "#/components/schemas/FilterList" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamInternetRegistryAssociationsOutputDisplay" + post: + operationId: POST_DescribeIpamInternetRegistryAssociations + description: Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamInternetRegistryAssociationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamInternetRegistryAssociationsRequest" /?Action=DescribeIpamPolicies&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -21662,6 +22922,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribeIpamPoliciesRequest" + /?Action=DescribeIpamPoolAllocations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeIpamPoolAllocations + description: Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID. If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results. This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations. + parameters: + - name: DryRun + in: query + required: false + description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamPoolAllocationId + in: query + required: false + description: The IDs of the IPAM pool allocations you want to describe. + schema: + $ref: "#/components/schemas/ValueStringList" + - name: Filter + in: query + required: false + description: One or more filters for the request. For more information about filtering, see Filtering CLI output. + schema: + $ref: "#/components/schemas/FilterList" + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + schema: + $ref: "#/components/schemas/DescribeIpamPoolAllocationsMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamPoolAllocationsOutputDisplay" + post: + operationId: POST_DescribeIpamPoolAllocations + description: Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID. If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results. This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamPoolAllocationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeIpamPoolAllocationsRequest" /?Action=DescribeIpamPools&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -21690,7 +23016,7 @@ paths: - name: MaxResults in: query required: false - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. schema: $ref: "#/components/schemas/IpamMaxResults" - name: NextToken @@ -22026,7 +23352,7 @@ paths: - name: MaxResults in: query required: false - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. schema: $ref: "#/components/schemas/IpamMaxResults" - name: NextToken @@ -22092,7 +23418,7 @@ paths: - name: MaxResults in: query required: false - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. schema: $ref: "#/components/schemas/IpamMaxResults" - name: NextToken @@ -23880,7 +25206,7 @@ paths: - name: Filter in: query required: false - description: The filters. group-name - The name of the placement group. group-arn - The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level for the placement group (host | rack). state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition). tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. + description: The filters. group-name - The name of the placement group. group-arn - The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level for the placement group (host | rack). state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition | precision-time). tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. schema: $ref: "#/components/schemas/FilterList" responses: @@ -27945,6 +29271,12 @@ paths: description: The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination. schema: $ref: "#/components/schemas/Integer" + - name: IncludeManagedResources + in: query + required: false + description: Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden. + schema: + $ref: "#/components/schemas/Boolean" responses: "200": description: Success @@ -29132,6 +30464,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/DetachClassicLinkVpcRequest" + /?Action=DetachImageWatermark&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DetachImageWatermark + description: Removes a watermark from the specified AMI. This is an idempotent operation. It succeeds even if the watermark does not exist on the image. Removing a watermark from an image does not affect derivative images that already carry the watermark. Only the AMI owner can detach watermarks. + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + $ref: "#/components/schemas/ImageId" + - name: WatermarkKey + in: query + required: true + description: The watermark key to remove, in accountId:watermarkName format (for example, 123456789012:approvedAmi). + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DetachImageWatermarkOutputDisplay" + post: + operationId: POST_DetachImageWatermark + description: Removes a watermark from the specified AMI. This is an idempotent operation. It succeeds even if the watermark does not exist on the image. Removing a watermark from an image does not affect derivative images that already carry the watermark. Only the AMI owner can detach watermarks. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DetachImageWatermarkOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DetachImageWatermarkRequest" /?Action=DetachInternetGateway&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -29486,6 +30872,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/DisableAllowedImagesSettingsRequest" + /?Action=DisableApplicationStatusCheckSuppression&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DisableApplicationStatusCheckSuppression + description: Disables suppression of application status checks for the specified instances. After suppression is disabled, health check results resume affecting the instance-level application status. You can specify a maximum of 100 instance IDs per request. + parameters: + - name: InstanceId + in: query + required: false + description: The IDs of the instances for which to disable application status check suppression. + schema: + $ref: "#/components/schemas/InstanceIdList" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DisableApplicationStatusCheckSuppressionOutputDisplay" + post: + operationId: POST_DisableApplicationStatusCheckSuppression + description: Disables suppression of application status checks for the specified instances. After suppression is disabled, health check results resume affecting the instance-level application status. You can specify a maximum of 100 instance IDs per request. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DisableApplicationStatusCheckSuppressionOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DisableApplicationStatusCheckSuppressionRequest" /?Action=DisableAwsNetworkPerformanceMetricSubscription&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -30472,6 +31912,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/DisassociateAddressRequest" + /?Action=DisassociateApplicationStatusCheck&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DisassociateApplicationStatusCheck + description: "Disassociates an application status check from instances or tags. After disassociation, health monitoring stops for the affected instances. The following rules apply: You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error. The application status check must already exist and belong to your account. Tag keys must not be blank." + parameters: + - name: ApplicationStatusCheckId + in: query + required: true + description: The ID of the application status check to disassociate. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckId" + - name: TargetTagAssociation + in: query + required: false + description: The tags to disassociate from the application status check. Specify the same key-value pairs that were used during association. + schema: + $ref: "#/components/schemas/CustomKeyValuePairRequestSet" + - name: InstanceId + in: query + required: false + description: The IDs of the instances to disassociate from the application status check. + schema: + $ref: "#/components/schemas/InstanceIdList" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DisassociateApplicationStatusCheckOutputDisplay" + post: + operationId: POST_DisassociateApplicationStatusCheck + description: "Disassociates an application status check from instances or tags. After disassociation, health monitoring stops for the affected instances. The following rules apply: You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error. The application status check must already exist and belong to your account. Tag keys must not be blank." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DisassociateApplicationStatusCheckOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DisassociateApplicationStatusCheckRequest" /?Action=DisassociateCapacityReservationBillingOwner&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -31448,6 +32954,66 @@ paths: text/xml: schema: $ref: "#/components/schemas/EnableAllowedImagesSettingsRequest" + /?Action=EnableApplicationStatusCheckSuppression&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_EnableApplicationStatusCheckSuppression + description: "Suppresses application status checks for the specified instances. While suppressed, health checks continue to run but do not affect the instance-level application status. The following rules apply: Maximum 100 instance IDs per request. Use DisableApplicationStatusCheckSuppression to resume normal health check reporting. If you do not specify DurationSeconds, suppression continues indefinitely until you call DisableApplicationStatusCheckSuppression." + parameters: + - name: InstanceId + in: query + required: false + description: The IDs of the instances for which to suppress application status checks. + schema: + $ref: "#/components/schemas/InstanceIdList" + - name: DurationSeconds + in: query + required: false + description: The duration, in seconds, for which to suppress application status checks. If omitted, the application status check is suppressed indefinitely until you call DisableApplicationStatusCheckSuppression. + schema: + $ref: "#/components/schemas/BoxedInteger" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableApplicationStatusCheckSuppressionOutputDisplay" + post: + operationId: POST_EnableApplicationStatusCheckSuppression + description: "Suppresses application status checks for the specified instances. While suppressed, health checks continue to run but do not affect the instance-level application status. The following rules apply: Maximum 100 instance IDs per request. Use DisableApplicationStatusCheckSuppression to resume normal health check reporting. If you do not specify DurationSeconds, suppression continues indefinitely until you call DisableApplicationStatusCheckSuppression." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableApplicationStatusCheckSuppressionOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableApplicationStatusCheckSuppressionRequest" /?Action=EnableAwsNetworkPerformanceMetricSubscription&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -32000,6 +33566,90 @@ paths: text/xml: schema: $ref: "#/components/schemas/EnableInstanceSqlHaStandbyDetectionsRequest" + /?Action=EnableIpamInternetRegistryAssociation&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_EnableIpamInternetRegistryAssociation + description: Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association to enable. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: RpkiVersion + in: query + required: true + description: The RPKI version to use from the Parent Response XML. + schema: + $ref: "#/components/schemas/String" + - name: ServiceUri + in: query + required: true + description: The RPKI service URI for the publication point from the Parent Response XML. + schema: + $ref: "#/components/schemas/String" + - name: ChildHandle + in: query + required: true + description: The child handle for the BPKI certificate hierarchy from the Parent Response XML. + schema: + $ref: "#/components/schemas/String" + - name: ParentHandle + in: query + required: true + description: The parent handle for the BPKI certificate hierarchy from the Parent Response XML. + schema: + $ref: "#/components/schemas/String" + - name: ParentBpkiTa + in: query + required: true + description: The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML. + schema: + $ref: "#/components/schemas/String" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableIpamInternetRegistryAssociationOutputDisplay" + post: + operationId: POST_EnableIpamInternetRegistryAssociation + description: Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableIpamInternetRegistryAssociationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/EnableIpamInternetRegistryAssociationRequest" /?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -34600,6 +36250,210 @@ paths: text/xml: schema: $ref: "#/components/schemas/GetIpamDiscoveredResourceCidrsRequest" + /?Action=GetIpamDiscoveredRoutes&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamDiscoveredRoutes + description: Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamResourceDiscoveryId + in: query + required: true + description: The ID of the IPAM resource discovery. + schema: + $ref: "#/components/schemas/IpamResourceDiscoveryId" + - name: ResourceRegion + in: query + required: true + description: The Amazon Web Services Region to retrieve discovered routes for. + schema: + $ref: "#/components/schemas/String" + - name: Filter + in: query + required: false + description: One or more filters to apply to the results. + schema: + $ref: "#/components/schemas/FilterList" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamDiscoveredRoutesOutputDisplay" + post: + operationId: POST_GetIpamDiscoveredRoutes + description: Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamDiscoveredRoutesOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamDiscoveredRoutesRequest" + /?Action=GetIpamInternetRegistryAssociationAsns&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamInternetRegistryAssociationAsns + description: Retrieves Autonomous System Numbers (ASNs) registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + - name: Filter + in: query + required: false + description: One or more filters to apply to the results. + schema: + $ref: "#/components/schemas/FilterList" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationAsnsOutputDisplay" + post: + operationId: POST_GetIpamInternetRegistryAssociationAsns + description: Retrieves Autonomous System Numbers (ASNs) registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationAsnsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationAsnsRequest" + /?Action=GetIpamInternetRegistryAssociationCidrs&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamInternetRegistryAssociationCidrs + description: Retrieves IP address CIDRs registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + - name: Filter + in: query + required: false + description: One or more filters to apply to the results. + schema: + $ref: "#/components/schemas/FilterList" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationCidrsOutputDisplay" + post: + operationId: POST_GetIpamInternetRegistryAssociationCidrs + description: Retrieves IP address CIDRs registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationCidrsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationCidrsRequest" /?Action=GetIpamPolicyAllocationRules&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -34850,7 +36704,7 @@ paths: - name: MaxResults in: query required: false - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. schema: $ref: "#/components/schemas/IpamMaxResults" - name: NextToken @@ -35114,7 +36968,7 @@ paths: - name: MaxResults in: query required: false - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. schema: $ref: "#/components/schemas/IpamMaxResults" - name: NextToken @@ -35182,6 +37036,288 @@ paths: text/xml: schema: $ref: "#/components/schemas/GetIpamResourceCidrsRequest" + /?Action=GetIpamRouteOriginAuthorizations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamRouteOriginAuthorizations + description: Retrieves the current Route Origin Authorizations (ROAs) published to the RPKI for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: Cidr + in: query + required: false + description: Filter results to a specific CIDR prefix. + schema: + $ref: "#/components/schemas/String" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteOriginAuthorizationsOutputDisplay" + post: + operationId: POST_GetIpamRouteOriginAuthorizations + description: Retrieves the current Route Origin Authorizations (ROAs) published to the RPKI for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteOriginAuthorizationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteOriginAuthorizationsRequest" + /?Action=GetIpamRouteProtectionFindings&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamRouteProtectionFindings + description: Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamId + in: query + required: true + description: The ID of the IPAM to retrieve route protection findings for. + schema: + $ref: "#/components/schemas/IpamId" + - name: Filter + in: query + required: false + description: One or more filters to apply to the results. + schema: + $ref: "#/components/schemas/FilterList" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteProtectionFindingsOutputDisplay" + post: + operationId: POST_GetIpamRouteProtectionFindings + description: Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteProtectionFindingsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRouteProtectionFindingsRequest" + /?Action=GetIpamRoutingPolicyRegistrationDeltas&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamRoutingPolicyRegistrationDeltas + description: Retrieves the history of routing policy registration changes for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: DeltaId + in: query + required: false + description: Filter results to a specific delta ID. + schema: + $ref: "#/components/schemas/String" + - name: StartTime + in: query + required: false + description: The start of the time range to filter deltas by. + schema: + $ref: "#/components/schemas/MillisecondDateTime" + - name: EndTime + in: query + required: false + description: The end of the time range to filter deltas by. + schema: + $ref: "#/components/schemas/MillisecondDateTime" + - name: ChronologicalOrder + in: query + required: false + description: "The chronological order to return results in. Valid values: forward | reverse." + schema: + $ref: "#/components/schemas/ChronologicalOrder" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationDeltasOutputDisplay" + post: + operationId: POST_GetIpamRoutingPolicyRegistrationDeltas + description: Retrieves the history of routing policy registration changes for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationDeltasOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationDeltasRequest" + /?Action=GetIpamRoutingPolicyRegistrations&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetIpamRoutingPolicyRegistrations + description: Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: Cidr + in: query + required: false + description: Filter results to a specific CIDR prefix. + schema: + $ref: "#/components/schemas/String" + - name: MaxResults + in: query + required: false + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + schema: + $ref: "#/components/schemas/IpamMaxResults" + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationsOutputDisplay" + post: + operationId: POST_GetIpamRoutingPolicyRegistrations + description: Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationsRequest" /?Action=GetLaunchTemplateData&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -35993,6 +38129,12 @@ paths: description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: $ref: "#/components/schemas/String" + - name: IncludeLocalZones + in: query + required: false + description: Specify true so that the response returns scores that include Local Zones. Otherwise, the response ignores Local Zones. When you request regional scores, Local Zone capacity counts toward its parent Region. + schema: + $ref: "#/components/schemas/Boolean" responses: "200": description: Success @@ -36368,7 +38510,7 @@ paths: - name: Filter in: query required: false - description: The filters associated with the transit gateway policy table. + description: "One or more filters. The possible values are: policy-rule-number - The rule number for the transit gateway policy table entry. target-route-table-id - The ID of the target route table. policy-rule.source-ip - The source CIDR block for the policy rule. policy-rule.destination-ip - The destination CIDR block for the policy rule. policy-rule.source-port - The source port or port range for the policy rule. policy-rule.destination-port - The destination port or port range for the policy rule. policy-rule.protocol - The protocol for the policy rule. policy-rule.meta-data.key - The metadata key for the policy rule. policy-rule.meta-data.value - The metadata value for the policy rule." schema: $ref: "#/components/schemas/FilterList" - name: MaxResults @@ -37726,6 +39868,102 @@ paths: text/xml: schema: $ref: "#/components/schemas/LockSnapshotRequest" + /?Action=ModifyAccountVpcEncryptionControl&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyAccountVpcEncryptionControl + description: Modifies the account-level VPC Encryption Control configuration. This sets the encryption control mode and resource exclusions that apply to the VPCs in your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: Mode + in: query + required: false + description: The encryption mode for the account encryption control configuration. + schema: + $ref: "#/components/schemas/AccountVpcEncryptionControlMode" + - name: InternetGateway + in: query + required: false + description: Specifies whether to exclude internet gateway resource from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: EgressOnlyInternetGateway + in: query + required: false + description: Specifies whether to exclude egress-only internet gateway resource from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: NatGateway + in: query + required: false + description: Specifies whether to exclude NAT gateway resource from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: VirtualPrivateGateway + in: query + required: false + description: Specifies whether to exclude virtual private gateway resource from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: VpcPeering + in: query + required: false + description: Specifies whether to exclude VPC peering connection resource from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: Lambda + in: query + required: false + description: Specifies whether to exclude Lambda service from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: VpcLattice + in: query + required: false + description: Specifies whether to exclude VPC Lattice service from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + - name: ElasticFileSystem + in: query + required: false + description: Specifies whether to exclude Elastic File System service from account-level encryption enforcement. + schema: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyAccountVpcEncryptionControlOutputDisplay" + post: + operationId: POST_ModifyAccountVpcEncryptionControl + description: Modifies the account-level VPC Encryption Control configuration. This sets the encryption control mode and resource exclusions that apply to the VPCs in your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyAccountVpcEncryptionControlOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyAccountVpcEncryptionControlRequest" /?Action=ModifyAddressAttribute&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -37780,6 +40018,144 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyAddressAttributeRequest" + /?Action=ModifyApplicationStatusCheck&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyApplicationStatusCheck + description: "Modifies an existing application status check. You can update the protocol, port, path, thresholds, and other configuration settings. The following rules apply: The application status check must exist and belong to your account. Changes take effect on the next health check interval." + parameters: + - name: ApplicationStatusCheckId + in: query + required: true + description: The ID of the application status check to modify. + schema: + $ref: "#/components/schemas/ApplicationStatusCheckId" + - name: Aggregation + in: query + required: false + description: "The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded." + schema: + $ref: "#/components/schemas/AggregationStatusEnum" + - name: HealthCheckPath + in: query + required: false + description: The health check paths to use for the application status check. + schema: + $ref: "#/components/schemas/HealthCheckPathRequestList" + - name: Protocol + in: query + required: false + description: "The protocol to use for the health check. Valid values: http | https." + schema: + $ref: "#/components/schemas/NetworkProtocolEnum" + - name: Port + in: query + required: false + description: "The port to use for the health check. Valid values: 1 to 65535." + schema: + $ref: "#/components/schemas/PortNumber" + - name: Path + in: query + required: false + description: The URL path to use for the health check HTTP request (for example, /health or /status). + schema: + $ref: "#/components/schemas/String" + - name: DeviceIndex + in: query + required: false + description: The index of the network device to use for the health check. The value must be greater than or equal to 0. + schema: + $ref: "#/components/schemas/Integer" + - name: IpVersion + in: query + required: false + description: "The IP version to use for the health check. Valid values: ipv4 and ipv6." + schema: + $ref: "#/components/schemas/IpVersionEnum" + - name: IpScope + in: query + required: false + description: "The IP scope to use for the health check. Valid value: private." + schema: + $ref: "#/components/schemas/IpScopeEnum" + - name: Interval + in: query + required: false + description: "The interval, in seconds, between health checks. Valid value: 60." + schema: + $ref: "#/components/schemas/Integer" + - name: Timeout + in: query + required: false + description: "The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval." + schema: + $ref: "#/components/schemas/Integer" + - name: FailureThreshold + in: query + required: false + description: The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0. + schema: + $ref: "#/components/schemas/Integer" + - name: SuccessThreshold + in: query + required: false + description: The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0. + schema: + $ref: "#/components/schemas/Integer" + - name: StatusCodeMatcher + in: query + required: false + description: "The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters." + schema: + $ref: "#/components/schemas/String" + - name: InitializationGracePeriodSeconds + in: query + required: false + description: "The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600." + schema: + $ref: "#/components/schemas/InitializationGracePeriodSeconds" + - name: ClientToken + in: query + required: false + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + schema: + $ref: "#/components/schemas/String" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyApplicationStatusCheckOutputDisplay" + post: + operationId: POST_ModifyApplicationStatusCheck + description: "Modifies an existing application status check. You can update the protocol, port, path, thresholds, and other configuration settings. The following rules apply: The application status check must exist and belong to your account. Changes take effect on the next health check interval." + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyApplicationStatusCheckOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyApplicationStatusCheckRequest" /?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -38675,6 +41051,12 @@ paths: description: Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls. schema: $ref: "#/components/schemas/AttributeBooleanValue" + - name: EnclaveOptions + in: query + required: false + description: Enables or disables the instance for Amazon Web Services Nitro Enclaves. For more information, see the Amazon Web Services Nitro Enclaves User Guide. + schema: + $ref: "#/components/schemas/EnclaveOptionsRequest" - name: DisableApiStop in: query required: false @@ -38740,7 +41122,7 @@ paths: required: false description: Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data. schema: - $ref: "#/components/schemas/BlobAttributeValue" + $ref: "#/components/schemas/SecureBlobAttributeValue" - name: InstanceInitiatedShutdownBehavior in: query required: false @@ -39746,6 +42128,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyIpamPoolRequest" + /?Action=ModifyIpamPoolAllocation&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyIpamPoolAllocation + description: Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide. + parameters: + - name: DryRun + in: query + required: false + description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamPoolAllocationId + in: query + required: true + description: The ID of the IPAM pool allocation you want to modify. + schema: + $ref: "#/components/schemas/IpamPoolAllocationId" + - name: Description + in: query + required: false + description: The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamPoolAllocationOutputDisplay" + post: + operationId: POST_ModifyIpamPoolAllocation + description: Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamPoolAllocationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamPoolAllocationRequest" /?Action=ModifyIpamPrefixListResolver&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -40028,6 +42464,96 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyIpamResourceDiscoveryRequest" + /?Action=ModifyIpamRoutingPolicyRegistration&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyIpamRoutingPolicyRegistration + description: Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA). + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: IpamInternetRegistryAssociationId + in: query + required: true + description: The ID of the IPAM internet registry association. + schema: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + - name: Cidr + in: query + required: false + description: The IP address prefix in CIDR notation identifying the routing policy registration to modify. + schema: + $ref: "#/components/schemas/String" + - name: Asn + in: query + required: false + description: The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix. + schema: + $ref: "#/components/schemas/AsnList" + - name: PermitMoreSpecificAnnouncements + in: query + required: false + description: "Specifies whether to permit more specific route announcements than the CIDR prefix. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: MaxLength + in: query + required: false + description: The new maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. + schema: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationMaxLength" + - name: Description + in: query + required: false + description: A new description for the routing policy registration. + schema: + $ref: "#/components/schemas/String" + - name: Force + in: query + required: false + description: "Forces the modification even if it conflicts with an announced route. Default: false." + schema: + $ref: "#/components/schemas/BoxedBoolean" + - name: ClientToken + in: query + required: false + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamRoutingPolicyRegistrationOutputDisplay" + post: + operationId: POST_ModifyIpamRoutingPolicyRegistration + description: Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA). + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamRoutingPolicyRegistrationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyIpamRoutingPolicyRegistrationRequest" /?Action=ModifyIpamScope&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -41420,6 +43946,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyTransitGatewayMeteringPolicyRequest" + /?Action=ModifyTransitGatewayPolicyTableEntry&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyTransitGatewayPolicyTableEntry + description: Modifies the specified transit gateway policy table entry. + parameters: + - name: TransitGatewayPolicyTableId + in: query + required: true + description: The ID of the transit gateway policy table. + schema: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + - name: PolicyRuleNumber + in: query + required: true + description: The rule number of the policy table entry to modify. + schema: + $ref: "#/components/schemas/String" + - name: PolicyRule + in: query + required: false + description: The updated matching criteria for the policy table entry. Unspecified fields retain their current values. + schema: + $ref: "#/components/schemas/TransitGatewayRequestPolicyRule" + - name: TargetRouteTableId + in: query + required: false + description: The ID of the transit gateway route table to use for traffic matching this rule. + schema: + $ref: "#/components/schemas/TransitGatewayRouteTableId" + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyTransitGatewayPolicyTableEntryOutputDisplay" + post: + operationId: POST_ModifyTransitGatewayPolicyTableEntry + description: Modifies the specified transit gateway policy table entry. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyTransitGatewayPolicyTableEntryOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyTransitGatewayPolicyTableEntryRequest" /?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -42622,6 +45214,72 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest" + /?Action=ModifyVpcEndpointPayerResponsibility&Version=2016-11-15: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyVpcEndpointPayerResponsibility + description: Modifies the billing account for VPC endpoint usage/charges. + parameters: + - name: DryRun + in: query + required: false + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + schema: + $ref: "#/components/schemas/Boolean" + - name: ServiceId + in: query + required: false + description: The ID of the VPC endpoint service. + schema: + $ref: "#/components/schemas/VpcEndpointServiceId" + - name: VpcEndpointId + in: query + required: true + description: The ID of the VPC endpoint. + schema: + $ref: "#/components/schemas/VpcEndpointId" + - name: PayerResponsibility + in: query + required: true + description: The Amazon Web Services account to which the usage of VPC endpoint is charged. + schema: + $ref: "#/components/schemas/PayerResponsibilityType" + - name: Scope + in: query + required: false + description: The scope of usage/charges for which the billing account is being modified. + schema: + $ref: "#/components/schemas/PayerResponsibilityScope" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyVpcEndpointPayerResponsibilityOutputDisplay" + post: + operationId: POST_ModifyVpcEndpointPayerResponsibility + description: Modifies the billing account for VPC endpoint usage/charges. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyVpcEndpointPayerResponsibilityOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyVpcEndpointPayerResponsibilityRequest" /?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -43467,7 +46125,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_ProvisionByoipCidr - description: Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range. + description: Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range. parameters: - name: Cidr in: query @@ -43526,7 +46184,7 @@ paths: $ref: "#/components/schemas/ProvisionByoipCidrOutputDisplay" post: operationId: POST_ProvisionByoipCidr - description: Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range. + description: Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range. responses: "200": description: Success @@ -44975,7 +47633,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_ReplaceImageCriteriaInAllowedImagesSettings - description: Sets or replaces the criteria for Allowed AMIs. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide. + description: "Sets or replaces the criteria for Allowed AMIs. The ImageCriteria can include up to: 10 ImageCriterion The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide." parameters: - name: ImageCriterion in: query @@ -44998,7 +47656,7 @@ paths: $ref: "#/components/schemas/ReplaceImageCriteriaInAllowedImagesSettingsOutputDisplay" post: operationId: POST_ReplaceImageCriteriaInAllowedImagesSettings - description: Sets or replaces the criteria for Allowed AMIs. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide. + description: "Sets or replaces the criteria for Allowed AMIs. The ImageCriteria can include up to: 10 ImageCriterion The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide." responses: "200": description: Success @@ -48478,11 +51136,15 @@ components: - ipam-prefix-list-resolver - ipam-policy - ipam-prefix-list-resolver-target + - ipam-internet-registry-association - secondary-interface - secondary-network - secondary-subnet - capacity-manager-data-export - vpn-concentrator + - ipam-pool-allocation + - capacity-reservation-cancellation-quote + - application-status-check TagList: type: array items: @@ -49012,6 +51674,16 @@ components: description: "Specifies the advertisement method for the BYOIP CIDR. Valid values are: unicast: IP is advertised from a single location (regional services like EC2) anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront) For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide." xml: name: advertisementType + PoolId: + type: string + description: The ID of the address pool associated with the CIDR. + xml: + name: poolId + IpamPoolId: + type: string + description: The ID of the IPAM pool associated with the CIDR. + xml: + name: ipamPoolId AdvertiseByoipCidrOutputDisplay: type: object properties: @@ -49142,6 +51814,18 @@ components: type: string AvailabilityZoneId: type: string + HostCpuOptionsRequest: + description: Contains the CPU configuration options for a Dedicated Host allocation request. Options include AMD Secure Encrypted Virtualization-Secure Nested Paging (AMD SEV-SNP) settings. + type: object + properties: + AmdSevSnp: + $ref: "#/components/schemas/AmdSevSnp" + description: Specifies whether AMD Secure Encrypted Virtualization-Secure Nested Paging (AMD SEV-SNP) is enabled or disabled for the Dedicated Host. If you don't specify a value, AMD SEV-SNP is disabled. + AmdSevSnp: + type: string + enum: + - enabled + - disabled AutoPlacement: type: string enum: @@ -49188,6 +51872,9 @@ components: AvailabilityZoneId: $ref: "#/components/schemas/AvailabilityZoneId" description: The ID of the Availability Zone. + CpuOptions: + $ref: "#/components/schemas/HostCpuOptionsRequest" + description: The CPU configuration options to apply to the Dedicated Host. AutoPlacement: $ref: "#/components/schemas/AutoPlacement" description: "Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide. Default: off" @@ -49249,6 +51936,11 @@ components: description: The owner of the resource. xml: name: resourceOwner + Tags: + type: string + description: The tags for the IPAM pool allocation. + xml: + name: tagSet AllocateIpamPoolCidrOutputDisplay: type: object properties: @@ -49286,6 +51978,9 @@ components: DisallowedCidrs: $ref: "#/components/schemas/IpamPoolAllocationDisallowedCidrs" description: Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. + TagSpecifications: + $ref: "#/components/schemas/TagSpecificationList" + description: The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. If you specify tags, the request is authorized against the allocation resource in addition to the pool resource. required: - IpamPoolId ClientVpnEndpointId: @@ -49532,6 +52227,66 @@ components: AllowReassociation: $ref: "#/components/schemas/Boolean" description: Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. + ApplicationStatusCheckId: + type: string + CustomKeyValuePairRequestSet: + type: array + items: + $ref: "#/components/schemas/CustomTagKeyValueRequestPair" + CustomTagKeyValueRequestPair: + description: Describes a tag key-value pair for an application status check association request. + type: object + properties: + Key: + $ref: "#/components/schemas/String" + description: The key of the tag. + Value: + $ref: "#/components/schemas/String" + description: The value of the tag. + InstanceIdList: + type: array + items: + $ref: "#/components/schemas/InstanceId" + AssociateApplicationStatusCheckResultDisplay: + type: object + properties: + SuccessfulResults: + type: string + description: The associations that were successfully created. + xml: + name: successfulResultSet + UnsuccessfulResults: + type: string + description: The associations that failed to be created. + xml: + name: unsuccessfulResultSet + AssociateApplicationStatusCheckOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/AssociateApplicationStatusCheckResultDisplay" + AssociateApplicationStatusCheckRequest: + type: object + properties: + ApplicationStatusCheckId: + $ref: "#/components/schemas/ApplicationStatusCheckId" + description: The ID of the application status check to associate. + TargetTagAssociations: + $ref: "#/components/schemas/CustomKeyValuePairRequestSet" + description: The tags to associate the application status check with. Each tag is a key-value pair. When you associate tags, the application status check automatically monitors all instances that have the specified tags. + InstanceIds: + $ref: "#/components/schemas/InstanceIdList" + description: The IDs of the instances to associate with the application status check. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ApplicationStatusCheckId AccountID: type: string minLength: 12 @@ -49745,10 +52500,6 @@ components: DedicatedHostIds: $ref: "#/components/schemas/DedicatedHostIdList" description: The IDs of the Dedicated Hosts to associate with the event window. - InstanceIdList: - type: array - items: - $ref: "#/components/schemas/InstanceId" DedicatedHostIdList: type: array items: @@ -50431,6 +53182,42 @@ components: - InstanceId - VpcId - Groups + ImageId: + type: string + ImageWatermarkNameRequest: + type: string + minLength: 3 + maxLength: 128 + AttachImageWatermarkResultDisplay: + type: object + properties: + WatermarkKey: + type: string + description: The watermark identifier, in accountId:watermarkName format (for example, 123456789012:approvedAmi). + xml: + name: watermarkKey + AttachImageWatermarkOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/AttachImageWatermarkResultDisplay" + AttachImageWatermarkRequest: + type: object + properties: + ImageId: + $ref: "#/components/schemas/ImageId" + description: The ID of the AMI. + WatermarkName: + $ref: "#/components/schemas/ImageWatermarkNameRequest" + description: "The name for the watermark. Combined with the caller's account ID to form the WatermarkKey (accountId:watermarkName). Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)" + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ImageId + - WatermarkName InternetGatewayId: type: string AttachInternetGatewayRequest: @@ -50990,6 +53777,61 @@ components: DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + type: string + BoxedBoolean: + type: boolean + IpamRoutingPolicyRegistrationDeltaDisplay: + type: object + properties: + DeltaId: + type: string + description: The unique identifier of the delta. + xml: + name: deltaId + DeltaJson: + type: string + description: The JSON specification describing the changes applied in this delta. + xml: + name: deltaJson + State: + type: string + description: "The state of the delta. Valid values: pending | published | failed." + xml: + name: state + StateMessage: + type: string + description: A message describing the current state, including error information if the delta failed. + xml: + name: stateMessage + BatchModifyIpamRoutingPolicyRegistrationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDeltaDisplay" + BatchModifyIpamRoutingPolicyRegistrationsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + DeltaJson: + $ref: "#/components/schemas/String" + description: The batch modifications to apply, in JSON format. + Force: + $ref: "#/components/schemas/BoxedBoolean" + description: "Forces the batch modification even if individual changes conflict with announced routes. Default: false." + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamInternetRegistryAssociationId + - DeltaJson Storage: description: Describes the storage location for an instance store-backed AMI. type: object @@ -51011,12 +53853,12 @@ components: $ref: "#/components/schemas/String" description: The beginning of the file name of the AMI. UploadPolicy: - $ref: "#/components/schemas/Blob" + $ref: "#/components/schemas/SecureBlob" description: An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. UploadPolicySignature: $ref: "#/components/schemas/S3StorageUploadPolicySignature" description: The signature of the JSON document. - Blob: + SecureBlob: type: string format: byte S3StorageUploadPolicySignature: @@ -51108,6 +53950,12 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - BundleId + ApplyCancellationCharges: + type: string + enum: + - commitment-wind-down + CapacityReservationCancellationQuoteId: + type: string CancelCapacityReservationResultDisplay: type: object properties: @@ -51132,6 +53980,12 @@ components: DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + ApplyCancellationCharges: + $ref: "#/components/schemas/ApplyCancellationCharges" + description: Specifies the cancellation charge type to apply when cancelling a future-dated Capacity Reservation during its commitment duration. Possible values include commitment-wind-down, which continues billing for the remaining commitment duration without delivering capacity. + QuoteId: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteId" + description: The ID of the cancellation quote to use for the cancellation. You can generate a cancellation quote by using the CreateCapacityReservationCancellationQuote action. The cancellation quote must be in an active state. required: - CapacityReservationId CapacityReservationFleetIdSet: @@ -51225,8 +54079,6 @@ components: description: The ID of the export task. This is the ID returned by the CreateInstanceExportTask and ExportImage operations. required: - ExportTaskId - ImageId: - type: string CancelImageLaunchPermissionResultDisplay: type: object properties: @@ -51774,6 +54626,243 @@ components: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. required: - SourceVolumeId + HealthCheckPathRequestList: + type: array + items: + $ref: "#/components/schemas/HealthCheckPathRequestObject" + HealthCheckPathRequestObject: + description: Describes a health check path for an application status check request. + type: object + properties: + Source: + $ref: "#/components/schemas/HealthCheckPathSourceRequestObject" + description: The source for the health check path. + Destinations: + $ref: "#/components/schemas/HealthCheckPathDestinationRequestSet" + description: The destinations for the health check path. + HealthCheckPathSourceRequestObject: + description: Describes the source for a health check path in a request. The source defines the subnet and security group where a health check elastic network interface (ENI) is created to originate health check traffic. + type: object + properties: + SubnetId: + $ref: "#/components/schemas/SubnetId" + description: The ID of the subnet for the source. + SecurityGroupId: + $ref: "#/components/schemas/SecurityGroupId" + description: The ID of the security group for the source. + HealthCheckPathDestinationRequestSet: + type: array + items: + $ref: "#/components/schemas/HealthCheckPathDestinationRequestObject" + HealthCheckPathDestinationRequestObject: + description: Describes a destination for a health check path in a request. Destinations can be in a different Availability Zone than the source (cross-AZ) or in a Local Zone (AZ to Local Zone), enabling remote health validation of your application. + type: object + properties: + SubnetId: + $ref: "#/components/schemas/SubnetId" + description: The ID of the subnet for the destination. + SecurityGroupId: + $ref: "#/components/schemas/SecurityGroupId" + description: The ID of the security group for the destination. + AggregationStatusEnum: + type: string + enum: + - included + - excluded + NetworkProtocolEnum: + type: string + enum: + - http + - https + PortNumber: + type: integer + minimum: 1 + maximum: 65535 + IpVersionEnum: + type: string + enum: + - ipv4 + - ipv6 + IpScopeEnum: + type: string + enum: + - private + InitializationGracePeriodSeconds: + type: integer + minimum: -1 + maximum: 600 + ApplicationStatusCheckResponseObjectDisplay: + type: object + properties: + ApplicationStatusCheckId: + type: string + description: The ID of the application status check. + xml: + name: applicationStatusCheckId + Aggregation: + type: string + description: The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status. + xml: + name: aggregation + HealthCheckPaths: + type: string + description: The health check paths for the application status check. + xml: + name: healthCheckPathSet + Protocol: + type: string + description: The protocol used for the health check. + xml: + name: protocol + Port: + type: integer + description: The port used for the health check. + xml: + name: port + Path: + type: string + description: The URL path used for the health check HTTP request. + xml: + name: path + DeviceIndex: + type: integer + description: The index of the network device used for the health check. The value is greater than or equal to 0. + xml: + name: deviceIndex + IpVersion: + type: string + description: The IP version used for the health check. + xml: + name: ipVersion + IpScope: + type: string + description: The IP scope used for the health check. + xml: + name: ipScope + Interval: + type: integer + description: "The interval, in seconds, between health checks. Valid value: 60." + xml: + name: interval + Timeout: + type: integer + description: "The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30." + xml: + name: timeout + FailureThreshold: + type: integer + description: The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0. + xml: + name: failureThreshold + SuccessThreshold: + type: integer + description: The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0. + xml: + name: successThreshold + StatusCodeMatcher: + type: string + description: The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response. + xml: + name: statusCodeMatcher + InitializationGracePeriodSeconds: + type: integer + description: "The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600." + xml: + name: initializationGracePeriodSeconds + LastUpdatedAt: + type: string + description: The date and time when the application status check was last updated. + xml: + name: lastUpdatedAt + TargetTagAssociations: + type: string + description: The tags associated with the application status check. Instances with these tags are automatically monitored by this check. + xml: + name: targetTagAssociationSet + Tags: + type: string + description: The tags assigned to the application status check. + xml: + name: tagSet + CreationTime: + type: string + description: The date and time when the application status check was created. + xml: + name: creationTime + ModifyTime: + type: string + description: The date and time when the application status check was last modified. + xml: + name: modifyTime + DeletionTime: + type: string + description: The date and time when the application status check was deleted. + xml: + name: deletionTime + CreateApplicationStatusCheckOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckResponseObjectDisplay" + CreateApplicationStatusCheckRequest: + type: object + properties: + HealthCheckPaths: + $ref: "#/components/schemas/HealthCheckPathRequestList" + description: The health check paths to use for the application status check. Health check paths define the network path from a source subnet to one or more destination subnets for cross-Availability Zone or Availability Zone to Local Zone health checking. If omitted, health checks are performed in the same subnet as the instance. + Aggregation: + $ref: "#/components/schemas/AggregationStatusEnum" + description: "The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded." + Protocol: + $ref: "#/components/schemas/NetworkProtocolEnum" + description: "The protocol to use for the health check. Valid values: http | https." + Port: + $ref: "#/components/schemas/PortNumber" + description: "The port to use for the health check. Valid values: 1 to 65535." + Path: + $ref: "#/components/schemas/String" + description: The URL path to use for the health check HTTP request (for example, /health or /status). + DeviceIndex: + $ref: "#/components/schemas/Integer" + description: The index of the network device to use for the health check. The value must be greater than or equal to 0. + IpVersion: + $ref: "#/components/schemas/IpVersionEnum" + description: "The IP version to use for the health check. Valid values: ipv4 and ipv6." + IpScope: + $ref: "#/components/schemas/IpScopeEnum" + description: "The IP scope to use for the health check. Valid value: private." + Interval: + $ref: "#/components/schemas/Integer" + description: "The interval, in seconds, between health checks. Valid value: 60." + Timeout: + $ref: "#/components/schemas/Integer" + description: "The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval." + FailureThreshold: + $ref: "#/components/schemas/Integer" + description: The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0. + SuccessThreshold: + $ref: "#/components/schemas/Integer" + description: The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0. + StatusCodeMatcher: + $ref: "#/components/schemas/String" + description: "The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters. Default: 200." + InitializationGracePeriodSeconds: + $ref: "#/components/schemas/InitializationGracePeriodSeconds" + description: "The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600." + TagSpecifications: + $ref: "#/components/schemas/TagSpecificationList" + description: The tags to apply to the application status check. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - Protocol + - Port Schedule: type: string enum: @@ -51949,7 +55038,7 @@ components: name: ephemeralStorage State: type: string - description: "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active - The capacity is available for use. expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. payment-pending - (Capacity Blocks) The upfront payment has not been processed yet. payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered." + description: "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active - The capacity is available for use. expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. payment-pending - (Capacity Blocks) The upfront payment has not been processed yet. payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes." xml: name: state StartDate: @@ -52159,6 +55248,73 @@ components: required: - SourceCapacityReservationId - InstanceCount + CapacityReservationCancellationQuoteDisplay: + type: object + properties: + CapacityReservationCancellationQuoteId: + type: string + description: The ID of the cancellation quote. + xml: + name: capacityReservationCancellationQuoteId + CapacityReservationId: + type: string + description: The ID of the Capacity Reservation associated with the cancellation quote. + xml: + name: capacityReservationId + CreateTime: + type: string + description: The date and time at which the cancellation quote was created. + xml: + name: createTime + ExpirationTime: + type: string + description: The date and time at which the cancellation quote expires. + xml: + name: expirationTime + QuoteState: + type: string + description: The state of the cancellation quote. Possible values include pending, active, and expired. + xml: + name: quoteState + CurrentConfiguration: + type: string + description: The current configuration of the Capacity Reservation. + xml: + name: currentConfiguration + CancellationTerms: + type: string + description: The cancellation terms associated with the quote, including the fee type and charge details. + xml: + name: cancellationTermSet + Tags: + type: string + description: The tags assigned to the cancellation quote. + xml: + name: tagSet + CreateCapacityReservationCancellationQuoteOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteDisplay" + CreateCapacityReservationCancellationQuoteRequest: + type: object + properties: + CapacityReservationId: + $ref: "#/components/schemas/CapacityReservationId" + description: The ID of the Capacity Reservation. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. + TagSpecifications: + $ref: "#/components/schemas/TagSpecificationList" + description: The tags to apply to the cancellation quote. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - CapacityReservationId ReservationFleetInstanceSpecificationList: type: array items: @@ -53403,6 +56559,199 @@ components: - m8id.metal-48xl - m8id.metal-96xl - hpc8a.96xlarge + - c8in.large + - c8in.xlarge + - c8in.2xlarge + - c8in.4xlarge + - c8in.8xlarge + - c8in.12xlarge + - c8in.16xlarge + - c8in.24xlarge + - c8in.32xlarge + - c8in.48xlarge + - c8in.96xlarge + - c8in.metal-48xl + - c8in.metal-96xl + - c8ib.large + - c8ib.xlarge + - c8ib.2xlarge + - c8ib.4xlarge + - c8ib.8xlarge + - c8ib.12xlarge + - c8ib.16xlarge + - c8ib.24xlarge + - c8ib.32xlarge + - c8ib.48xlarge + - c8ib.96xlarge + - c8ib.metal-48xl + - c8ib.metal-96xl + - r8in.large + - r8in.xlarge + - r8in.2xlarge + - r8in.4xlarge + - r8in.8xlarge + - r8in.12xlarge + - r8in.16xlarge + - r8in.24xlarge + - r8in.32xlarge + - r8in.48xlarge + - r8in.96xlarge + - r8ib.large + - r8ib.xlarge + - r8ib.2xlarge + - r8ib.4xlarge + - r8ib.8xlarge + - r8ib.12xlarge + - r8ib.16xlarge + - r8ib.24xlarge + - r8ib.32xlarge + - r8ib.48xlarge + - r8ib.96xlarge + - m8in.large + - m8in.xlarge + - m8in.2xlarge + - m8in.4xlarge + - m8in.8xlarge + - m8in.12xlarge + - m8in.16xlarge + - m8in.24xlarge + - m8in.32xlarge + - m8in.48xlarge + - m8in.96xlarge + - m8ib.large + - m8ib.xlarge + - m8ib.2xlarge + - m8ib.4xlarge + - m8ib.8xlarge + - m8ib.12xlarge + - m8ib.16xlarge + - m8ib.24xlarge + - m8ib.32xlarge + - m8ib.48xlarge + - m8ib.96xlarge + - m8ine.large + - m8ine.xlarge + - m8ine.2xlarge + - m8ine.4xlarge + - m8ine.8xlarge + - m8ine.12xlarge + - c8ine.large + - c8ine.xlarge + - c8ine.2xlarge + - c8ine.4xlarge + - c8ine.8xlarge + - c8ine.12xlarge + - m8idn.large + - m8idn.xlarge + - m8idn.2xlarge + - m8idn.4xlarge + - m8idn.8xlarge + - m8idn.12xlarge + - m8idn.16xlarge + - m8idn.24xlarge + - m8idn.32xlarge + - m8idn.48xlarge + - m8idn.96xlarge + - r8idn.large + - r8idn.xlarge + - r8idn.2xlarge + - r8idn.4xlarge + - r8idn.8xlarge + - r8idn.12xlarge + - r8idn.16xlarge + - r8idn.24xlarge + - r8idn.32xlarge + - r8idn.48xlarge + - r8idn.96xlarge + - m8idb.large + - m8idb.xlarge + - m8idb.2xlarge + - m8idb.4xlarge + - m8idb.8xlarge + - m8idb.12xlarge + - m8idb.16xlarge + - m8idb.24xlarge + - m8idb.32xlarge + - m8idb.48xlarge + - m8idb.96xlarge + - r8idb.large + - r8idb.xlarge + - r8idb.2xlarge + - r8idb.4xlarge + - r8idb.8xlarge + - r8idb.12xlarge + - r8idb.16xlarge + - r8idb.24xlarge + - r8idb.32xlarge + - r8idb.48xlarge + - r8idb.96xlarge + - mac-m3ultra.metal + - m9g.large + - m9g.xlarge + - m9g.2xlarge + - m9g.4xlarge + - m9g.8xlarge + - m9g.12xlarge + - m9g.16xlarge + - m9g.24xlarge + - m9g.48xlarge + - m9g.metal-24xl + - m9g.metal-48xl + - m9gd.large + - m9gd.xlarge + - m9gd.2xlarge + - m9gd.4xlarge + - m9gd.8xlarge + - m9gd.12xlarge + - m9gd.16xlarge + - m9gd.24xlarge + - m9gd.48xlarge + - m9gd.metal-24xl + - m9gd.metal-48xl + - r8in.metal-48xl + - r8in.metal-96xl + - r8ib.metal-48xl + - r8ib.metal-96xl + - r8idn.metal-48xl + - r8idn.metal-96xl + - r8idb.metal-48xl + - r8idb.metal-96xl + - m8in.metal-48xl + - m8in.metal-96xl + - m8ib.metal-48xl + - m8ib.metal-96xl + - m8idn.metal-48xl + - m8idn.metal-96xl + - m8idb.metal-48xl + - m8idb.metal-96xl + - g7.2xlarge + - g7.4xlarge + - g7.8xlarge + - g7.12xlarge + - g7.24xlarge + - g7.48xlarge + - c9g.medium + - c9g.large + - c9g.xlarge + - c9g.2xlarge + - c9g.4xlarge + - c9g.8xlarge + - c9g.12xlarge + - c9g.16xlarge + - c9g.24xlarge + - c9g.48xlarge + - c9g.metal-48xl + - c9gd.medium + - c9gd.large + - c9gd.xlarge + - c9gd.2xlarge + - c9gd.4xlarge + - c9gd.8xlarge + - c9gd.12xlarge + - c9gd.16xlarge + - c9gd.24xlarge + - c9gd.48xlarge + - c9gd.metal-48xl DoubleWithConstraints: type: number format: double @@ -53515,7 +56864,6 @@ components: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - - InstanceTypeSpecifications - TotalTargetCapacity CarrierGatewayDisplay: type: object @@ -54567,6 +57915,9 @@ components: Version: $ref: "#/components/schemas/String" description: The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails. If the value is $Latest, Amazon EC2 uses the latest version of the launch template. If the value is $Default, Amazon EC2 uses the default version of the launch template. + LaunchTemplateSpecificationUserData: + $ref: "#/components/schemas/SensitiveUserData" + description: The base64-encoded user data for instances launched by the fleet. User data is limited to 16 KB, in raw form, before it is base64-encoded. Supported only for fleets of type instant. LaunchTemplateId: type: string LaunchTemplateName: @@ -54574,6 +57925,8 @@ components: minLength: 3 maxLength: 128 pattern: "[a-zA-Z0-9\\(\\)\\.\\-/_]+" + SensitiveUserData: + type: string FleetLaunchTemplateOverridesListRequest: type: array items: @@ -54603,9 +57956,18 @@ components: Placement: $ref: "#/components/schemas/Placement" description: The location where the instance launched, if applicable. + KeyName: + $ref: "#/components/schemas/String" + description: The name of the key pair to use for the instances. Supported only for fleets of type instant. For more information, see Amazon EC2 key pairs in the Amazon EC2 User Guide. BlockDeviceMappings: $ref: "#/components/schemas/FleetBlockDeviceMappingRequestList" description: The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch. Supported only for fleets of type instant. For more information, see Block device mappings for volumes on Amazon EC2 instances in the Amazon EC2 User Guide. + IamInstanceProfile: + $ref: "#/components/schemas/FleetIamInstanceProfileSpecificationRequest" + description: The IAM instance profile to associate with the instances. Supported only for fleets of type instant. For more information, see IAM roles for Amazon EC2 in the Amazon EC2 User Guide. + MetadataOptions: + $ref: "#/components/schemas/FleetInstanceMetadataOptionsRequest" + description: The metadata options for the instances. Supported only for fleets of type instant. For more information, see Configure the instance metadata service in the Amazon EC2 User Guide. InstanceRequirements: $ref: "#/components/schemas/InstanceRequirementsRequest" description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify InstanceRequirements, you can't specify InstanceType. @@ -54712,6 +58074,39 @@ components: description: The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide. SnapshotId: type: string + FleetIamInstanceProfileSpecificationRequest: + description: Describes an IAM instance profile. Supported only for fleets of type instant. + type: object + properties: + Arn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the instance profile. + Name: + $ref: "#/components/schemas/String" + description: The name of the instance profile. + FleetInstanceMetadataOptionsRequest: + description: Describes the metadata options for the instances. Supported only for fleets of type instant. + type: object + properties: + HttpTokens: + $ref: "#/components/schemas/FleetHttpTokensState" + description: Indicates whether IMDSv2 is required. optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. + HttpPutResponseHopLimit: + $ref: "#/components/schemas/Integer" + description: "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Default: 1 Possible values: Integers from 1 to 64" + HttpEndpoint: + $ref: "#/components/schemas/FleetInstanceMetadataEndpointState" + description: Enables or disables the HTTP metadata endpoint on your instances. enabled - The HTTP metadata endpoint is enabled. disabled - The HTTP metadata endpoint is disabled. + FleetHttpTokensState: + type: string + enum: + - optional + - required + FleetInstanceMetadataEndpointState: + type: string + enum: + - disabled + - enabled InstanceRequirementsRequest: description: "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes. If you specify InstanceRequirements, you can't specify InstanceType. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements. For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide." type: object @@ -55139,7 +58534,7 @@ components: description: Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide. TagSpecifications: $ref: "#/components/schemas/TagSpecificationList" - description: The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources. If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch. If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template. + description: The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources. If the fleet type is instant, specify a resource type of fleet to tag the fleet, instance to tag the instances at launch, volume to tag the volumes at launch, or network-interface to tag the network interfaces at launch. If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance, volume, or network-interface. To tag instances at launch, specify the tags in a launch template. Context: $ref: "#/components/schemas/String" description: Reserved. @@ -55191,6 +58586,34 @@ components: enum: - plain-text - parquet + TagFieldSpecificationListRequest: + type: array + items: + $ref: "#/components/schemas/TagFieldSpecificationRequest" + TagFieldSpecificationRequest: + description: A single resource's tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format. + type: object + properties: + ResourceType: + $ref: "#/components/schemas/TaggableResourceType" + description: The resource type for the tag keys associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format. + TagKeys: + $ref: "#/components/schemas/TagKeyList" + description: The tag keys on your tagged resources to be displayed by the Flow Logs Amazon EC2 Tags feature fields in your custom log format. + TaggableResourceType: + type: string + enum: + - network-interface + - instance + - auto-scaling-group + TagKeyList: + type: array + items: + $ref: "#/components/schemas/TagKey" + TagKey: + type: string + minLength: 1 + maxLength: 128 CreateFlowLogsResultDisplay: type: object properties: @@ -55236,7 +58659,7 @@ components: description: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is valid only if the destination type is cloud-watch-logs. ResourceIds: $ref: "#/components/schemas/FlowLogResourceIds" - description: "The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types." + description: "The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 300 for the other resource types." ResourceType: $ref: "#/components/schemas/FlowLogsResourceType" description: The type of resource to monitor. @@ -55261,6 +58684,9 @@ components: DestinationOptions: $ref: "#/components/schemas/DestinationOptionsRequest" description: The destination options. + TagFieldSpecifications: + $ref: "#/components/schemas/TagFieldSpecificationListRequest" + description: The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format. required: - ResourceIds - ResourceType @@ -55411,7 +58837,7 @@ components: description: The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both. To tag the AMI, the value for ResourceType must be image. To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created. If you specify other values for ResourceType, the request fails. To tag an AMI or snapshot after it has been created, see CreateTags. SnapshotLocation: $ref: "#/components/schemas/SnapshotLocationEnum" - description: "Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter. The Amazon S3 location where the snapshots will be stored. To create local snapshots in the same Local Zone as the source instance, specify local. To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter. Default: regional" + description: "Only supported for instances in Local Zones and for instances on Outposts that support local snapshots. If the source instance is not in one of these locations, omit this parameter. The Amazon S3 location where the snapshots will be stored. To create local snapshots in the same Local Zone or on the same Outpost as the source instance, specify local. To create regional snapshots in the parent Region of the Local Zone or Outpost, specify regional. If the source instance is in a Local Zone and you omit this parameter, regional snapshots are created in the parent Region of the Local Zone. If the source instance is on an Outpost that supports local snapshots, this parameter is required. If you omit it, the request fails with an InvalidParameterValue error. Default: regional (for instances in Local Zones only)" DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. @@ -56132,6 +59558,107 @@ components: description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. required: - IpamId + Rir: + description: The Regional Internet Registry (RIR). + type: string + enum: + - ripe + - apnic + - arin + - lacnic + IpamInternetRegistryAssociationDisplay: + type: object + properties: + OwnerId: + type: string + description: The ID of the Amazon Web Services account that owns the internet registry association. + xml: + name: ownerId + IpamInternetRegistryAssociationId: + type: string + description: The ID of the internet registry association. + xml: + name: ipamInternetRegistryAssociationId + IpamInternetRegistryAssociationArn: + type: string + description: The Amazon Resource Name (ARN) of the internet registry association. + xml: + name: ipamInternetRegistryAssociationArn + IpamId: + type: string + description: The ID of the associated IPAM. + xml: + name: ipamId + IpamRegion: + type: string + description: The Amazon Web Services Region of the IPAM. + xml: + name: ipamRegion + Rir: + type: string + description: "The Regional Internet Registry. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean)." + xml: + name: rir + OrganizationHandle: + type: string + description: The organization handle at the internet registry. + xml: + name: organizationHandle + Description: + type: string + description: The description of the internet registry association. + xml: + name: description + State: + type: string + description: "The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed." + xml: + name: state + ChildRequestXml: + type: string + description: The XML content for the child request to be submitted to the internet registry to complete the BPKI setup. + xml: + name: childRequestXml + Tags: + type: string + description: The tags assigned to the internet registry association. + xml: + name: tagSet + CreateIpamInternetRegistryAssociationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationDisplay" + CreateIpamInternetRegistryAssociationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamId: + $ref: "#/components/schemas/IpamId" + description: The ID of the IPAM to associate with the internet registry. + Rir: + $ref: "#/components/schemas/Rir" + description: "The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean)." + OrganizationHandle: + $ref: "#/components/schemas/String" + description: The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID). + Description: + $ref: "#/components/schemas/String" + description: A description for the internet registry association. + TagSpecifications: + $ref: "#/components/schemas/TagSpecificationList" + description: The tags to assign to the internet registry association. + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamId + - Rir + - OrganizationHandle IpamPolicyDisplay: type: object properties: @@ -56796,6 +60323,55 @@ components: ClientToken: $ref: "#/components/schemas/String" description: A client token for the IPAM resource discovery. + AsnList: + type: array + items: + $ref: "#/components/schemas/String" + IpamRoutingPolicyRegistrationMaxLength: + type: integer + minimum: 0 + maximum: 48 + CreateIpamRoutingPolicyRegistrationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDeltaDisplay" + CreateIpamRoutingPolicyRegistrationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + Cidr: + $ref: "#/components/schemas/String" + description: The IP address prefix in CIDR notation to authorize in the ROA. + Asns: + $ref: "#/components/schemas/AsnList" + description: The Autonomous System Numbers (ASNs) authorized to originate the prefix. + PermitMoreSpecificAnnouncements: + $ref: "#/components/schemas/BoxedBoolean" + description: "Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false." + MaxLength: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationMaxLength" + description: The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only). + Description: + $ref: "#/components/schemas/String" + description: A description for the routing policy registration. + Force: + $ref: "#/components/schemas/BoxedBoolean" + description: "Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false." + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamInternetRegistryAssociationId + - Cidr + - Asns ExternalAuthorityConfiguration: description: The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system. For more information, see Integrate VPC IPAM with Infoblox infrastructure in the Amazon VPC IPAM User Guide. type: object @@ -57295,7 +60871,7 @@ components: properties: TcpEstablishedTimeout: $ref: "#/components/schemas/Integer" - description: "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds." + description: "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 350 seconds for Nitro v6 instance types (excluding P6e-GB200); 432000 seconds for all other instance types (including P6e-GB200). Recommended: Less than 432000 seconds." UdpStreamTimeout: $ref: "#/components/schemas/Integer" description: "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds." @@ -57352,8 +60928,6 @@ components: enum: - stop - terminate - SensitiveUserData: - type: string LaunchTemplateTagSpecificationRequestList: type: array items: @@ -57731,7 +61305,7 @@ components: $ref: "#/components/schemas/String" description: "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency. For more information, see Ensuring idempotency. Constraint: Maximum 128 ASCII characters." LaunchTemplateName: - $ref: "#/components/schemas/LaunchTemplateName" + $ref: "#/components/schemas/String" description: A name for the launch template. VersionDescription: $ref: "#/components/schemas/VersionDescription" @@ -59427,6 +63001,7 @@ components: - cluster - spread - partition + - precision-time PlacementGroupDisplay: type: object properties: @@ -59480,6 +63055,11 @@ components: description: The service provider that manages the Placement Group. xml: name: operator + ParentGroupId: + type: string + description: The ID of the parent placement group. + xml: + name: parentGroupId CreatePlacementGroupOutputDisplay: type: object properties: @@ -59505,6 +63085,9 @@ components: Operator: $ref: "#/components/schemas/OperatorRequest" description: Reserved for internal use. + ParentGroupId: + $ref: "#/components/schemas/PlacementGroupId" + description: The ID of a parent placement group. Valid only when Strategy is set to cluster. DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. @@ -59604,7 +63187,7 @@ components: description: The ID of the instance for which to replace the root volume. SnapshotId: $ref: "#/components/schemas/SnapshotId" - description: The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter. + description: The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, if you want to restore the replacement root volume from an AMI, or if you want to replace the root volume with a specified volume, omit this parameter. ClientToken: $ref: "#/components/schemas/String" description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency. @@ -59616,13 +63199,16 @@ components: description: The tags to apply to the root volume replacement task. ImageId: $ref: "#/components/schemas/ImageId" - description: The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter. + description: The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, if you want to restore it to its launch state, or if you want to replace the root volume with a specified volume, omit this parameter. DeleteReplacedRootVolume: $ref: "#/components/schemas/Boolean" description: Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it. VolumeInitializationRate: $ref: "#/components/schemas/Long" description: "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. Omit this parameter if: You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide. Valid range: 100 - 300 MiB/s" + VolumeId: + $ref: "#/components/schemas/VolumeId" + description: The ID of the volume to use as the replacement root volume. The specified volume must be in the same Availability Zone as the instance, must be in the available state, and must not be attached to an instance. If the original root volume is encrypted, the specified volume must also be encrypted. If you want to restore the replacement root volume from a specific snapshot, an AMI, or to its launch state, omit this parameter. required: - InstanceId PriceScheduleSpecificationList: @@ -61894,6 +65480,90 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - TransitGatewayId + TransitGatewayRequestPolicyRule: + description: The matching criteria for a transit gateway policy table entry. + type: object + properties: + SourceCidrBlock: + $ref: "#/components/schemas/String" + description: The source CIDR block for the policy rule. + SourcePortRange: + $ref: "#/components/schemas/String" + description: The source port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be *. + DestinationCidrBlock: + $ref: "#/components/schemas/String" + description: The destination CIDR block for the policy rule. + DestinationPortRange: + $ref: "#/components/schemas/String" + description: The destination port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be *. + Protocol: + $ref: "#/components/schemas/String" + description: The protocol for the policy rule. Valid values are 1 (ICMP), 6 (TCP), 17 (UDP), 47 (GRE), or * for all protocols. + MetaData: + $ref: "#/components/schemas/TransitGatewayRequestPolicyRuleMetaData" + description: The metadata key-value pair for the policy rule. + TransitGatewayRequestPolicyRuleMetaData: + description: A metadata key-value pair for a transit gateway policy rule. + type: object + properties: + MetaDataKey: + $ref: "#/components/schemas/String" + description: The key of the metadata pair for the policy rule. + MetaDataValue: + $ref: "#/components/schemas/String" + description: The value of the metadata pair for the policy rule. + TransitGatewayPolicyTableEntryDisplay: + type: object + properties: + PolicyRuleNumber: + type: string + description: The rule number for the transit gateway policy table entry. + xml: + name: policyRuleNumber + PolicyRule: + type: string + description: The policy rule associated with the transit gateway policy table. + xml: + name: policyRule + TargetRouteTableId: + type: string + description: The ID of the target route table. + xml: + name: targetRouteTableId + State: + type: string + description: The state of the transit gateway policy table entry. + xml: + name: state + CreateTransitGatewayPolicyTableEntryOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/TransitGatewayPolicyTableEntryDisplay" + CreateTransitGatewayPolicyTableEntryRequest: + type: object + properties: + TransitGatewayPolicyTableId: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + description: The ID of the transit gateway policy table. + PolicyRuleNumber: + $ref: "#/components/schemas/String" + description: The rule number for the policy table entry. Lower rule numbers are evaluated first and take precedence. + PolicyRule: + $ref: "#/components/schemas/TransitGatewayRequestPolicyRule" + description: The matching criteria for the policy table entry. + TargetRouteTableId: + $ref: "#/components/schemas/TransitGatewayRouteTableId" + description: The ID of the transit gateway route table to use for traffic matching this rule. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - TransitGatewayPolicyTableId + - PolicyRuleNumber + - TargetRouteTableId TransitGatewayPrefixListReferenceDisplay: type: object properties: @@ -62170,7 +65840,7 @@ components: description: Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is set to enable by default. However, at the transit gateway level the default is set to disable. For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide. Ipv6Support: $ref: "#/components/schemas/Ipv6SupportValue" - description: Enable or disable IPv6 support. The default is disable. + description: Specifies whether IPv6 support is enabled for the attachment. When enabled, the transit gateway network interface receives an IPv6 address. When you enable route propagation, IPv6 VPC CIDRs propagate to the transit gateway route tables. When disabled, the network interface does not receive an IPv6 address, and IPv6 routes do not propagate. The setting does not filter IPv6 traffic. The default is disable. ApplianceModeSupport: $ref: "#/components/schemas/ApplianceModeSupportValue" description: Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable. @@ -63304,6 +66974,11 @@ components: description: The Region where the service is hosted. xml: name: serviceRegion + PayerResponsibilities: + type: string + description: The payer responsibility settings for the endpoint. + xml: + name: payerResponsibilitySet CreateVpcEndpointOutputDisplay: type: object properties: @@ -63991,6 +67666,27 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - Type + DeleteApplicationStatusCheckOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckResponseObjectDisplay" + DeleteApplicationStatusCheckRequest: + type: object + properties: + ApplicationStatusCheckId: + $ref: "#/components/schemas/ApplicationStatusCheckId" + description: The ID of the application status check to delete. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ApplicationStatusCheckId CapacityManagerDataExportId: type: string DeleteCapacityManagerDataExportResultDisplay: @@ -64419,6 +68115,24 @@ components: description: The token ID. required: - IpamExternalResourceVerificationTokenId + DeleteIpamInternetRegistryAssociationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationDisplay" + DeleteIpamInternetRegistryAssociationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association to delete. + required: + - IpamInternetRegistryAssociationId IpamPolicyId: type: string DeleteIpamPolicyOutputDisplay: @@ -64516,6 +68230,34 @@ components: description: The IPAM resource discovery ID. required: - IpamResourceDiscoveryId + DeleteIpamRoutingPolicyRegistrationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDeltaDisplay" + DeleteIpamRoutingPolicyRegistrationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + Cidr: + $ref: "#/components/schemas/String" + description: The IP address prefix in CIDR notation identifying the routing policy registration to delete. + Force: + $ref: "#/components/schemas/BoxedBoolean" + description: "Forces the deletion even if it conflicts with an announced route. Default: false." + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamInternetRegistryAssociationId + - Cidr DeleteIpamScopeOutputDisplay: type: object properties: @@ -65557,6 +69299,28 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - TransitGatewayPolicyTableId + DeleteTransitGatewayPolicyTableEntryOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/TransitGatewayPolicyTableEntryDisplay" + DeleteTransitGatewayPolicyTableEntryRequest: + type: object + properties: + TransitGatewayPolicyTableId: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + description: The ID of the transit gateway policy table. + PolicyRuleNumber: + $ref: "#/components/schemas/String" + description: The rule number of the policy table entry to delete. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - TransitGatewayPolicyTableId + - PolicyRuleNumber DeleteTransitGatewayPrefixListReferenceOutputDisplay: type: object properties: @@ -66331,6 +70095,47 @@ components: AttributeNames: $ref: "#/components/schemas/AccountAttributeNameStringList" description: The account attribute names. + AccountVpcEncryptionControlDisplay: + type: object + properties: + State: + type: string + description: The current state of the account-level VPC Encryption Control configuration. + xml: + name: state + Mode: + type: string + description: The encryption mode for the account-level VPC Encryption Control configuration. + xml: + name: mode + Exclusions: + type: string + description: Information about the traffic exclusions for the account-level VPC Encryption Control configuration. + xml: + name: exclusions + ManagedBy: + type: string + description: The entity that manages the account-level VPC Encryption Control configuration. + xml: + name: managedBy + LastUpdateTimestamp: + type: string + description: The date and time when the account-level VPC Encryption Control configuration was last updated. + xml: + name: lastUpdateTimestamp + DescribeAccountVpcEncryptionControlOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/AccountVpcEncryptionControlDisplay" + DescribeAccountVpcEncryptionControlRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. DescribeAddressTransfersMaxResults: type: integer minimum: 5 @@ -66573,6 +70378,136 @@ components: DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + DescribeApplicationStatusMaxResults: + type: integer + minimum: 1 + maximum: 100 + DescribeApplicationStatusResultDisplay: + type: object + properties: + ApplicationStatuses: + type: string + description: The application statuses for the specified instances. + xml: + name: applicationStatusesResponseType + NextToken: + type: string + description: The token to include in another request to get the next page of items. This value is ``null when there are no more items to return. + xml: + name: nextToken + DescribeApplicationStatusOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/DescribeApplicationStatusResultDisplay" + DescribeApplicationStatusRequest: + type: object + properties: + InstanceIds: + $ref: "#/components/schemas/InstanceIdList" + description: The IDs of the instances for which to describe application status. + Filters: + $ref: "#/components/schemas/FilterList" + description: The filters. availability-zone-id – The ID of the Availability Zone. status – The instance-level application status. For valid values and their meanings, see ApplicationStatus. + MaxResults: + $ref: "#/components/schemas/DescribeApplicationStatusMaxResults" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + NextToken: + $ref: "#/components/schemas/String" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + ApplicationStatusCheckIdList: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckId" + DescribeApplicationStatusCheckAssociationsMaxResults: + type: integer + minimum: 5 + maximum: 1000 + ApplicationStatusCheckAssociationObjectDisplay: + type: object + properties: + ApplicationStatusCheckId: + type: string + description: The ID of the application status check. + xml: + name: applicationStatusCheckId + AssociationType: + type: string + description: "The type of target that the application status check is associated with. Possible values: tag – The check applies to current and future instances with a matching tag key-value pair. instance-id – The check applies to a specific instance." + xml: + name: associationType + Key: + type: string + description: The key for the association. This value is present only for tag-based associations, where it contains the tag key. For instance-based associations, this value is absent. + xml: + name: key + Value: + type: string + description: The value for the association target. For tag-based associations, this is the tag value. For instance-based associations, this is the instance ID (for example, i-0123456789abcdef0). + xml: + name: value + DescribeApplicationStatusCheckAssociationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckAssociationObjectDisplay" + DescribeApplicationStatusCheckAssociationsRequest: + type: object + properties: + ApplicationStatusCheckIds: + $ref: "#/components/schemas/ApplicationStatusCheckIdList" + description: The IDs of the application status checks for which to describe associations. + Filters: + $ref: "#/components/schemas/FilterList" + description: "The filters to use to limit the results. association-type – The type of association. Valid values: tag and instance-id." + MaxResults: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsMaxResults" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + NextToken: + $ref: "#/components/schemas/String" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + DescribeApplicationStatusChecksMaxResults: + type: integer + minimum: 5 + maximum: 100 + DescribeApplicationStatusChecksOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckResponseObjectDisplay" + DescribeApplicationStatusChecksRequest: + type: object + properties: + ApplicationStatusCheckIds: + $ref: "#/components/schemas/ApplicationStatusCheckIdList" + description: The IDs of the application status checks to describe. + Filters: + $ref: "#/components/schemas/FilterList" + description: "The filters. aggregation – The aggregation setting. Valid values: included and excluded." + MaxResults: + $ref: "#/components/schemas/DescribeApplicationStatusChecksMaxResults" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + NextToken: + $ref: "#/components/schemas/String" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + IncludeAll: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to false, the response includes only active checks. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. ZoneNameStringList: type: array items: @@ -67427,6 +71362,39 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - Role + CapacityReservationCancellationQuoteIdSet: + type: array + items: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteId" + DescribeCapacityReservationCancellationQuotesRequestMaxResults: + type: integer + minimum: 1 + maximum: 1000 + DescribeCapacityReservationCancellationQuotesOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteDisplay" + DescribeCapacityReservationCancellationQuotesRequest: + type: object + properties: + CapacityReservationCancellationQuoteIds: + $ref: "#/components/schemas/CapacityReservationCancellationQuoteIdSet" + description: The IDs of the cancellation quotes to describe. + MaxResults: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesRequestMaxResults" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + NextToken: + $ref: "#/components/schemas/String" + description: The token to use to retrieve the next page of results. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters. Filter names and values are case-sensitive. DescribeCapacityReservationFleetsMaxResults: type: integer minimum: 1 @@ -67587,7 +71555,7 @@ components: description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You can't specify this parameter and the Capacity Reservation IDs parameter in the same request. Default: 10" CapacityReservationIds: $ref: "#/components/schemas/CapacityReservationIdSet" - description: "The Capacity Reservation IDs. Default: Describes all your Capacity Reservations. Constraints: Maximum 100 explicitly specified Capacity Reservation IDs." + description: "The Capacity Reservation IDs. Default: Describes all your Capacity Reservations. Constraints: Maximum 10 explicitly specified Capacity Reservation IDs." Filters: $ref: "#/components/schemas/FilterList" description: The filters. availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the Capacity Reservation is in. instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character. @@ -69128,6 +73096,11 @@ components: description: The destination options. xml: name: destinationOptions + TagFieldSpecifications: + type: string + description: The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format. + xml: + name: tagFieldSpecificationSet DescribeFlowLogsOutputDisplay: type: object properties: @@ -69613,6 +73586,11 @@ components: description: The ID of the Outpost hardware asset on which the Dedicated Host is allocated. xml: name: assetId + CpuOptions: + type: string + description: The CPU options for the Dedicated Host, including AMD Secure Encrypted Virtualization-Secure Nested Paging (AMD SEV-SNP) settings. + xml: + name: cpuOptions DescribeHostsOutputDisplay: type: object properties: @@ -70199,6 +74177,16 @@ components: description: Indicates whether the image is eligible for Amazon Web Services Free Tier. If true, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits. If false, the AMI is not eligible for Free Tier. xml: name: freeTierEligible + PublicSsmParameterName: + type: string + description: The name of the public Systems Manager parameter that resolves to this AMI, under the aws/service/ namespace. + xml: + name: publicSsmParameterName + ImageWatermarks: + type: string + description: The watermarks attached to the AMI. + xml: + name: imageWatermarkSet ImageId: type: string description: The ID of the AMI. @@ -70295,7 +74283,7 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. Filters: $ref: "#/components/schemas/FilterList" - description: The filters. architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted. creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. free-tier-eligible - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (true | false). hypervisor - The hypervisor type (ovm | xen). image-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. image-id - The ID of the image. image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The owner alias (amazon | aws-backup-vault | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter. owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter. platform - The platform. The only supported value is windows. product-code - The product code. product-code.type - The type of the product code (marketplace). ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-image-id - The ID of the source AMI from which the AMI was created. source-image-region - The Region of the source AMI. source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm). + description: The filters. architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted. creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. free-tier-eligible - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier (true | false). hypervisor - The hypervisor type (ovm | xen). image-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. image-id - The ID of the image. image-watermark.source-image-creation-time - The creation date of the source AMI, in the ISO 8601 format in the UTC time zone ( YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM ). You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. image-watermark.source-image-id - The ID of the AMI to which the watermark was originally attached. image-watermark.source-image-region - The Region where the watermark was originally attached. image-watermark.watermark-creation-time - The date and time the watermark was attached to the AMI, in the ISO 8601 format in the UTC time zone ( YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM ). You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day. image-watermark.watermark-key - The watermark identifier, in accountId:watermarkName format (for example, 123456789012:approvedAmi). image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The owner alias (amazon | aws-backup-vault | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter. owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter. platform - The platform. The only supported value is windows. product-code - The product code. product-code.type - The type of the product code (marketplace). public-ssm-parameter-name - The name of a public Systems Manager parameter associated with the AMI. The parameter must be in a trusted Amazon Web Services namespace under aws/service/. Returns all AMIs that have ever been associated with the parameter, including previous versions. ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-image-id - The ID of the source AMI from which the AMI was created. source-image-region - The Region of the source AMI. source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm). ImportTaskIdList: type: array items: @@ -70949,6 +74937,11 @@ components: description: Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations. xml: name: attachedEbsStatus + ApplicationStatus: + type: string + description: Reports impaired functionality that stems from issues with applications running on the instance. + xml: + name: applicationStatus DescribeInstanceStatusOutputDisplay: type: object properties: @@ -70976,7 +74969,7 @@ components: description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. Filters: $ref: "#/components/schemas/FilterList" - description: The filters. availability-zone - The Availability Zone of the instance. availability-zone-id - The ID of the Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). operator.managed - A Boolean that indicates whether this is a managed instance. operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true. system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable). + description: The filters. availability-zone - The Availability Zone of the instance. availability-zone-id - The ID of the Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). operator.managed - A Boolean that indicates whether this is a managed instance. operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true. system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable). application-status.status - The application status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). IncludeAllInstances: $ref: "#/components/schemas/Boolean" description: "When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false" @@ -71762,6 +75755,31 @@ components: IpamExternalResourceVerificationTokenIds: $ref: "#/components/schemas/ValueStringList" description: Verification token IDs. + DescribeIpamInternetRegistryAssociationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationDisplay" + DescribeIpamInternetRegistryAssociationsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationIds: + $ref: "#/components/schemas/ValueStringList" + description: The IDs of the internet registry associations to describe. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters to apply to the results. DescribeIpamPoliciesOutputDisplay: type: object properties: @@ -71787,6 +75805,35 @@ components: IpamPolicyIds: $ref: "#/components/schemas/ValueStringList" description: The IDs of the IPAM policies to describe. + DescribeIpamPoolAllocationsMaxResults: + type: integer + minimum: 1000 + maximum: 100000 + DescribeIpamPoolAllocationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamPoolAllocationDisplay" + DescribeIpamPoolAllocationsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamPoolAllocationIds: + $ref: "#/components/schemas/ValueStringList" + description: The IDs of the IPAM pool allocations you want to describe. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters for the request. For more information about filtering, see Filtering CLI output. + MaxResults: + $ref: "#/components/schemas/DescribeIpamPoolAllocationsMaxResults" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. DescribeIpamPoolsOutputDisplay: type: object properties: @@ -71805,7 +75852,7 @@ components: description: One or more filters for the request. For more information about filtering, see Filtering CLI output. MaxResults: $ref: "#/components/schemas/IpamMaxResults" - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. NextToken: $ref: "#/components/schemas/NextToken" description: The token for the next page of results. @@ -71933,7 +75980,7 @@ components: description: One or more filters for the request. For more information about filtering, see Filtering CLI output. MaxResults: $ref: "#/components/schemas/IpamMaxResults" - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. NextToken: $ref: "#/components/schemas/NextToken" description: The token for the next page of results. @@ -71958,7 +76005,7 @@ components: description: One or more filters for the request. For more information about filtering, see Filtering CLI output. MaxResults: $ref: "#/components/schemas/IpamMaxResults" - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. NextToken: $ref: "#/components/schemas/NextToken" description: The token for the next page of results. @@ -73171,7 +77218,7 @@ components: description: "The names of the placement groups. Constraints: You can specify a name only if the placement group is owned by your account. If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead." Filters: $ref: "#/components/schemas/FilterList" - description: The filters. group-name - The name of the placement group. group-arn - The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level for the placement group (host | rack). state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition). tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. + description: The filters. group-name - The name of the placement group. group-arn - The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level for the placement group (host | rack). state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition | precision-time). tag:`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. PrefixListResourceIdStringList: type: array items: @@ -76525,6 +80572,11 @@ components: description: The modification completion or failure time. xml: name: endTime + Operator: + type: string + description: The service provider that manages the resource. + xml: + name: operator DescribeVolumesModificationsOutputDisplay: type: object properties: @@ -76550,6 +80602,9 @@ components: MaxResults: $ref: "#/components/schemas/Integer" description: The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination. + IncludeManagedResources: + $ref: "#/components/schemas/Boolean" + description: Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden. VpcAttributeName: type: string enum: @@ -77034,6 +81089,11 @@ components: description: The Region of the endpoint. xml: name: vpcEndpointRegion + PayerResponsibilities: + type: string + description: The payer responsibility settings for the endpoint. + xml: + name: payerResponsibilitySet DescribeVpcEndpointConnectionsOutputDisplay: type: object properties: @@ -77543,6 +81603,36 @@ components: required: - InstanceId - VpcId + DetachImageWatermarkResultDisplay: + type: object + properties: + Return: + type: boolean + description: Returns true if the request succeeds; otherwise, it returns an error. + xml: + name: return + DetachImageWatermarkOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/DetachImageWatermarkResultDisplay" + DetachImageWatermarkRequest: + type: object + properties: + ImageId: + $ref: "#/components/schemas/ImageId" + description: The ID of the AMI. + WatermarkKey: + $ref: "#/components/schemas/String" + description: The watermark key to remove, in accountId:watermarkName format (for example, 123456789012:approvedAmi). + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ImageId + - WatermarkKey DetachInternetGatewayRequest: type: object properties: @@ -77686,6 +81776,38 @@ components: DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + DisableApplicationStatusCheckSuppressionResultDisplay: + type: object + properties: + SuccessfulResults: + type: string + description: The instances for which suppression was successfully disabled. + xml: + name: successfulResultSet + UnsuccessfulResults: + type: string + description: The instances for which suppression failed to be disabled. + xml: + name: unsuccessfulResultSet + DisableApplicationStatusCheckSuppressionOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/DisableApplicationStatusCheckSuppressionResultDisplay" + DisableApplicationStatusCheckSuppressionRequest: + type: object + properties: + InstanceIds: + $ref: "#/components/schemas/InstanceIdList" + description: The IDs of the instances for which to disable application status check suppression. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. MetricType: type: string enum: @@ -78291,6 +82413,46 @@ components: DryRun: $ref: "#/components/schemas/Boolean" description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + DisassociateApplicationStatusCheckResultDisplay: + type: object + properties: + SuccessfulResults: + type: string + description: The associations that were successfully removed. + xml: + name: successfulResultSet + UnsuccessfulResults: + type: string + description: The associations that failed to be removed. + xml: + name: unsuccessfulResultSet + DisassociateApplicationStatusCheckOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/DisassociateApplicationStatusCheckResultDisplay" + DisassociateApplicationStatusCheckRequest: + type: object + properties: + ApplicationStatusCheckId: + $ref: "#/components/schemas/ApplicationStatusCheckId" + description: The ID of the application status check to disassociate. + TargetTagAssociations: + $ref: "#/components/schemas/CustomKeyValuePairRequestSet" + description: The tags to disassociate from the application status check. Specify the same key-value pairs that were used during association. + InstanceIds: + $ref: "#/components/schemas/InstanceIdList" + description: The IDs of the instances to disassociate from the application status check. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ApplicationStatusCheckId DisassociateCapacityReservationBillingOwnerResultDisplay: type: object properties: @@ -78813,6 +82975,41 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - AllowedImagesSettingsState + EnableApplicationStatusCheckSuppressionResultDisplay: + type: object + properties: + SuccessfulResults: + type: string + description: The instances for which suppression was successfully enabled. + xml: + name: successfulResultSet + UnsuccessfulResults: + type: string + description: The instances for which suppression failed to be enabled. + xml: + name: unsuccessfulResultSet + EnableApplicationStatusCheckSuppressionOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/EnableApplicationStatusCheckSuppressionResultDisplay" + EnableApplicationStatusCheckSuppressionRequest: + type: object + properties: + InstanceIds: + $ref: "#/components/schemas/InstanceIdList" + description: The IDs of the instances for which to suppress application status checks. + DurationSeconds: + $ref: "#/components/schemas/BoxedInteger" + description: The duration, in seconds, for which to suppress application status checks. If omitted, the application status check is suppressed indefinitely until you call DisableApplicationStatusCheckSuppression. + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. EnableAwsNetworkPerformanceMetricSubscriptionResultDisplay: type: object properties: @@ -79183,6 +83380,47 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - InstanceIds + EnableIpamInternetRegistryAssociationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationDisplay" + EnableIpamInternetRegistryAssociationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association to enable. + RpkiVersion: + $ref: "#/components/schemas/String" + description: The RPKI version to use from the Parent Response XML. + ServiceUri: + $ref: "#/components/schemas/String" + description: The RPKI service URI for the publication point from the Parent Response XML. + ChildHandle: + $ref: "#/components/schemas/String" + description: The child handle for the BPKI certificate hierarchy from the Parent Response XML. + ParentHandle: + $ref: "#/components/schemas/String" + description: The parent handle for the BPKI certificate hierarchy from the Parent Response XML. + ParentBpkiTa: + $ref: "#/components/schemas/String" + description: The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML. + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamInternetRegistryAssociationId + - RpkiVersion + - ServiceUri + - ChildHandle + - ParentHandle + - ParentBpkiTa EnableIpamOrganizationAdminAccountResultDisplay: type: object properties: @@ -80422,7 +84660,7 @@ components: name: availableInstanceCount State: type: string - description: "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active - The capacity is available for use. expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. payment-pending - (Capacity Blocks) The upfront payment has not been processed yet. payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered." + description: "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active - The capacity is available for use. expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. payment-pending - (Capacity Blocks) The upfront payment has not been processed yet. payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes." xml: name: state InstanceUsages: @@ -81585,6 +85823,175 @@ components: required: - IpamResourceDiscoveryId - ResourceRegion + IpamDiscoveredRouteDisplay: + type: object + properties: + IpamResourceDiscoveryId: + type: string + description: The ID of the IPAM resource discovery that discovered the route. + xml: + name: ipamResourceDiscoveryId + ResourceRegion: + type: string + description: The Amazon Web Services Region where the route was discovered. + xml: + name: resourceRegion + ResourceOwnerId: + type: string + description: The ID of the resource owner. + xml: + name: resourceOwnerId + Cidr: + type: string + description: The IP address prefix of the discovered route in CIDR notation. + xml: + name: cidr + Asn: + type: string + description: The Autonomous System Number (ASN) that originates the route. + xml: + name: asn + State: + type: string + description: "The state of the BYOIP CIDR. Possible values: advertised - The CIDR is being advertised. deprovisioned - The CIDR has been deprovisioned. failed-deprovision - Deprovisioning failed. failed-provision - Provisioning failed. pending-deprovision - Deprovisioning is in progress. pending-provision - Provisioning is in progress. provisioned - The CIDR is provisioned. provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable." + xml: + name: state + AdvertisementType: + type: string + description: "The advertisement type of the route. Possible values: regional - The IP address is advertised from a single location (regional services such as Amazon EC2). global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront)." + xml: + name: advertisementType + NetworkBorderGroup: + type: string + description: The network border group for the route. + xml: + name: networkBorderGroup + PoolId: + type: string + description: The ID of the BYOIP pool associated with the route. + xml: + name: poolId + IpamPoolId: + type: string + description: The ID of the IPAM pool associated with the route. + xml: + name: ipamPoolId + SampleTime: + type: string + description: The time when the route was last sampled. + xml: + name: sampleTime + GetIpamDiscoveredRoutesOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamDiscoveredRouteDisplay" + GetIpamDiscoveredRoutesRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamResourceDiscoveryId: + $ref: "#/components/schemas/IpamResourceDiscoveryId" + description: The ID of the IPAM resource discovery. + ResourceRegion: + $ref: "#/components/schemas/String" + description: The Amazon Web Services Region to retrieve discovered routes for. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters to apply to the results. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + required: + - IpamResourceDiscoveryId + - ResourceRegion + IpamInternetRegistryAssociationAsnDisplay: + type: object + properties: + Asn: + type: string + description: The Autonomous System Number. + xml: + name: asn + LastObservedAt: + type: string + description: The time when the ASN was last observed at the internet registry. + xml: + name: lastObservedAt + GetIpamInternetRegistryAssociationAsnsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationAsnDisplay" + GetIpamInternetRegistryAssociationAsnsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters to apply to the results. + required: + - IpamInternetRegistryAssociationId + IpamInternetRegistryAssociationCidrDisplay: + type: object + properties: + Cidr: + type: string + description: The IP address prefix in CIDR notation. + xml: + name: cidr + LastObservedAt: + type: string + description: The time when the CIDR was last observed at the internet registry. + xml: + name: lastObservedAt + GetIpamInternetRegistryAssociationCidrsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamInternetRegistryAssociationCidrDisplay" + GetIpamInternetRegistryAssociationCidrsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters to apply to the results. + required: + - IpamInternetRegistryAssociationId IpamPolicyResourceType: type: string enum: @@ -81735,7 +86142,7 @@ components: description: One or more filters for the request. For more information about filtering, see Filtering CLI output. MaxResults: $ref: "#/components/schemas/IpamMaxResults" - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. NextToken: $ref: "#/components/schemas/NextToken" description: The token for the next page of results. @@ -81975,7 +86382,7 @@ components: description: One or more filters for the request. For more information about filtering, see Filtering CLI output. MaxResults: $ref: "#/components/schemas/IpamMaxResults" - description: The maximum number of results to return in the request. + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. NextToken: $ref: "#/components/schemas/NextToken" description: The token for the next page of results. @@ -81999,6 +86406,203 @@ components: description: The ID of the Amazon Web Services account that owns the resource. required: - IpamScopeId + IpamRouteOriginAuthorizationInfoDisplay: + type: object + properties: + Cidr: + type: string + description: The IP address prefix in CIDR notation authorized by the ROA. + xml: + name: cidr + Asn: + type: string + description: The Autonomous System Number (ASN) authorized to originate the prefix. + xml: + name: asn + MaxLength: + type: integer + description: The maximum prefix length that the ASN is authorized to announce. + xml: + name: maxLength + GetIpamRouteOriginAuthorizationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRouteOriginAuthorizationInfoDisplay" + GetIpamRouteOriginAuthorizationsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + Cidr: + $ref: "#/components/schemas/String" + description: Filter results to a specific CIDR prefix. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + required: + - IpamInternetRegistryAssociationId + GetIpamRouteProtectionFindingsResultDisplay: + type: object + properties: + IpamId: + type: string + description: The ID of the IPAM. + xml: + name: ipamId + RouteProtectionFindings: + type: string + description: The route protection findings. + xml: + name: routeProtectionFindingSet + NextToken: + type: string + description: The token to use to retrieve the next page of results. + xml: + name: nextToken + GetIpamRouteProtectionFindingsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/GetIpamRouteProtectionFindingsResultDisplay" + GetIpamRouteProtectionFindingsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamId: + $ref: "#/components/schemas/IpamId" + description: The ID of the IPAM to retrieve route protection findings for. + Filters: + $ref: "#/components/schemas/FilterList" + description: One or more filters to apply to the results. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + required: + - IpamId + ChronologicalOrder: + description: The chronological order for returning results. + type: string + enum: + - forward + - reverse + GetIpamRoutingPolicyRegistrationDeltasOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDeltaDisplay" + GetIpamRoutingPolicyRegistrationDeltasRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + DeltaId: + $ref: "#/components/schemas/String" + description: Filter results to a specific delta ID. + StartTime: + $ref: "#/components/schemas/MillisecondDateTime" + description: The start of the time range to filter deltas by. + EndTime: + $ref: "#/components/schemas/MillisecondDateTime" + description: The end of the time range to filter deltas by. + ChronologicalOrder: + $ref: "#/components/schemas/ChronologicalOrder" + description: "The chronological order to return results in. Valid values: forward | reverse." + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + required: + - IpamInternetRegistryAssociationId + IpamRoutingPolicyRegistrationDisplay: + type: object + properties: + Cidr: + type: string + description: The IP address prefix in CIDR notation authorized by the ROA. + xml: + name: cidr + Asns: + type: string + description: The Autonomous System Numbers (ASNs) authorized to originate the prefix. + xml: + name: asnSet + PermitMoreSpecificAnnouncements: + type: boolean + description: "Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false." + xml: + name: permitMoreSpecificAnnouncements + MaxLength: + type: integer + description: The maximum prefix length that the ASNs are authorized to announce. + xml: + name: maxLength + Description: + type: string + description: The description of the routing policy registration. + xml: + name: description + LatestDeltaId: + type: string + description: The ID of the most recent delta that modified this registration. + xml: + name: latestDeltaId + State: + type: string + description: "The state of the routing policy registration. Valid values: pending-activate | activate-failed | create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | delete-complete." + xml: + name: state + GetIpamRoutingPolicyRegistrationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDisplay" + GetIpamRoutingPolicyRegistrationsRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + Cidr: + $ref: "#/components/schemas/String" + description: Filter results to a specific CIDR prefix. + MaxResults: + $ref: "#/components/schemas/IpamMaxResults" + description: The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + required: + - IpamInternetRegistryAssociationId ResponseLaunchTemplateDataDisplay: type: object properties: @@ -82769,6 +87373,9 @@ components: NextToken: $ref: "#/components/schemas/String" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + IncludeLocalZones: + $ref: "#/components/schemas/Boolean" + description: Specify true so that the response returns scores that include Local Zones. Otherwise, the response ignores Local Zones. When you request regional scores, Local Zone capacity counts toward its parent Region. required: - TargetCapacity GetSubnetCidrReservationsMaxResults: @@ -82969,24 +87576,6 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - TransitGatewayPolicyTableId - TransitGatewayPolicyTableEntryDisplay: - type: object - properties: - PolicyRuleNumber: - type: string - description: The rule number for the transit gateway policy table entry. - xml: - name: policyRuleNumber - PolicyRule: - type: string - description: The policy rule associated with the transit gateway policy table. - xml: - name: policyRule - TargetRouteTableId: - type: string - description: The ID of the target route table. - xml: - name: targetRouteTableId GetTransitGatewayPolicyTableEntriesOutputDisplay: type: object properties: @@ -83002,7 +87591,7 @@ components: description: The ID of the transit gateway policy table. Filters: $ref: "#/components/schemas/FilterList" - description: The filters associated with the transit gateway policy table. + description: "One or more filters. The possible values are: policy-rule-number - The rule number for the transit gateway policy table entry. target-route-table-id - The ID of the target route table. policy-rule.source-ip - The source CIDR block for the policy rule. policy-rule.destination-ip - The destination CIDR block for the policy rule. policy-rule.source-port - The source port or port range for the policy rule. policy-rule.destination-port - The destination port or port range for the policy rule. policy-rule.protocol - The protocol for the policy rule. policy-rule.meta-data.key - The metadata key for the policy rule. policy-rule.meta-data.value - The metadata value for the policy rule." MaxResults: $ref: "#/components/schemas/TransitGatewayMaxResults" description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. @@ -83800,6 +88389,9 @@ components: description: The instance operating system. required: - Platform + Blob: + type: string + format: byte ImportKeyPairResultDisplay: type: object properties: @@ -84250,6 +88842,52 @@ components: required: - SnapshotId - LockMode + AccountVpcEncryptionControlMode: + type: string + enum: + - unmanaged + - attempt-monitor + - attempt-enforce + ModifyAccountVpcEncryptionControlOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/AccountVpcEncryptionControlDisplay" + ModifyAccountVpcEncryptionControlRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + Mode: + $ref: "#/components/schemas/AccountVpcEncryptionControlMode" + description: The encryption mode for the account encryption control configuration. + InternetGateway: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude internet gateway resource from account-level encryption enforcement. + EgressOnlyInternetGateway: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude egress-only internet gateway resource from account-level encryption enforcement. + NatGateway: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude NAT gateway resource from account-level encryption enforcement. + VirtualPrivateGateway: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude virtual private gateway resource from account-level encryption enforcement. + VpcPeering: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude VPC peering connection resource from account-level encryption enforcement. + Lambda: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude Lambda service from account-level encryption enforcement. + VpcLattice: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude VPC Lattice service from account-level encryption enforcement. + ElasticFileSystem: + $ref: "#/components/schemas/VpcEncryptionControlExclusionStateInput" + description: Specifies whether to exclude Elastic File System service from account-level encryption enforcement. ModifyAddressAttributeOutputDisplay: type: object properties: @@ -84271,6 +88909,69 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - AllocationId + ModifyApplicationStatusCheckOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ApplicationStatusCheckResponseObjectDisplay" + ModifyApplicationStatusCheckRequest: + type: object + properties: + ApplicationStatusCheckId: + $ref: "#/components/schemas/ApplicationStatusCheckId" + description: The ID of the application status check to modify. + Aggregation: + $ref: "#/components/schemas/AggregationStatusEnum" + description: "The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded." + HealthCheckPaths: + $ref: "#/components/schemas/HealthCheckPathRequestList" + description: The health check paths to use for the application status check. + Protocol: + $ref: "#/components/schemas/NetworkProtocolEnum" + description: "The protocol to use for the health check. Valid values: http | https." + Port: + $ref: "#/components/schemas/PortNumber" + description: "The port to use for the health check. Valid values: 1 to 65535." + Path: + $ref: "#/components/schemas/String" + description: The URL path to use for the health check HTTP request (for example, /health or /status). + DeviceIndex: + $ref: "#/components/schemas/Integer" + description: The index of the network device to use for the health check. The value must be greater than or equal to 0. + IpVersion: + $ref: "#/components/schemas/IpVersionEnum" + description: "The IP version to use for the health check. Valid values: ipv4 and ipv6." + IpScope: + $ref: "#/components/schemas/IpScopeEnum" + description: "The IP scope to use for the health check. Valid value: private." + Interval: + $ref: "#/components/schemas/Integer" + description: "The interval, in seconds, between health checks. Valid value: 60." + Timeout: + $ref: "#/components/schemas/Integer" + description: "The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval." + FailureThreshold: + $ref: "#/components/schemas/Integer" + description: The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0. + SuccessThreshold: + $ref: "#/components/schemas/Integer" + description: The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0. + StatusCodeMatcher: + $ref: "#/components/schemas/String" + description: "The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters." + InitializationGracePeriodSeconds: + $ref: "#/components/schemas/InitializationGracePeriodSeconds" + description: "The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600." + ClientToken: + $ref: "#/components/schemas/String" + description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - ApplicationStatusCheckId ModifyAvailabilityZoneOptInStatus: type: string enum: @@ -84807,6 +89508,13 @@ components: Value: $ref: "#/components/schemas/Boolean" description: The attribute value. The valid values are true or false. + EnclaveOptionsRequest: + description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true. ModifyInstanceAttributeValue: type: string InstanceBlockDeviceMappingSpecificationList: @@ -84839,17 +89547,20 @@ components: DeleteOnTermination: $ref: "#/components/schemas/Boolean" description: Indicates whether the volume is deleted on instance termination. - BlobAttributeValue: + SecureBlobAttributeValue: type: object properties: Value: - $ref: "#/components/schemas/Blob" + $ref: "#/components/schemas/SecureBlob" ModifyInstanceAttributeRequest: type: object properties: SourceDestCheck: $ref: "#/components/schemas/AttributeBooleanValue" description: Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls. + EnclaveOptions: + $ref: "#/components/schemas/EnclaveOptionsRequest" + description: Enables or disables the instance for Amazon Web Services Nitro Enclaves. For more information, see the Amazon Web Services Nitro Enclaves User Guide. DisableApiStop: $ref: "#/components/schemas/AttributeBooleanValue" description: Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance. @@ -84881,7 +89592,7 @@ components: $ref: "#/components/schemas/AttributeValue" description: Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB. UserData: - $ref: "#/components/schemas/BlobAttributeValue" + $ref: "#/components/schemas/SecureBlobAttributeValue" description: Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data. InstanceInitiatedShutdownBehavior: $ref: "#/components/schemas/AttributeValue" @@ -85601,6 +90312,27 @@ components: description: Remove tag allocation rules from a pool. required: - IpamPoolId + ModifyIpamPoolAllocationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamPoolAllocationDisplay" + ModifyIpamPoolAllocationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamPoolAllocationId: + $ref: "#/components/schemas/IpamPoolAllocationId" + description: The ID of the IPAM pool allocation you want to modify. + Description: + $ref: "#/components/schemas/String" + description: The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation. + required: + - IpamPoolAllocationId ModifyIpamPrefixListResolverOutputDisplay: type: object properties: @@ -85625,8 +90357,6 @@ components: description: The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely. required: - IpamPrefixListResolverId - BoxedBoolean: - type: boolean ModifyIpamPrefixListResolverTargetOutputDisplay: type: object properties: @@ -85746,6 +90476,47 @@ components: description: Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide. required: - IpamResourceDiscoveryId + ModifyIpamRoutingPolicyRegistrationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationDeltaDisplay" + ModifyIpamRoutingPolicyRegistrationRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + IpamInternetRegistryAssociationId: + $ref: "#/components/schemas/IpamInternetRegistryAssociationId" + description: The ID of the IPAM internet registry association. + Cidr: + $ref: "#/components/schemas/String" + description: The IP address prefix in CIDR notation identifying the routing policy registration to modify. + Asns: + $ref: "#/components/schemas/AsnList" + description: The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix. + PermitMoreSpecificAnnouncements: + $ref: "#/components/schemas/BoxedBoolean" + description: "Specifies whether to permit more specific route announcements than the CIDR prefix. Default: false." + MaxLength: + $ref: "#/components/schemas/IpamRoutingPolicyRegistrationMaxLength" + description: The new maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. + Description: + $ref: "#/components/schemas/String" + description: A new description for the routing policy registration. + Force: + $ref: "#/components/schemas/BoxedBoolean" + description: "Forces the modification even if it conflicts with an announced route. Default: false." + ClientToken: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error. + required: + - IpamInternetRegistryAssociationId + - Cidr + - Asns ModifyIpamScopeOutputDisplay: type: object properties: @@ -86799,7 +91570,7 @@ components: description: The ID of the default propagation route table. AmazonSideAsn: $ref: "#/components/schemas/Long" - description: "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The modify ASN operation is not allowed on a transit gateway if it has the following attachments: Dynamic VPN Static VPN Direct Connect Gateway Connect You must first delete all transit gateway attachments configured prior to modifying the ASN on the transit gateway." + description: "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The modify ASN operation is not allowed on a transit gateway if it has the following attachments: Dynamic VPN Static VPN Direct Connect Gateway Connect VPN Concentrator Client VPN You must first delete all transit gateway attachments configured prior to modifying the ASN on the transit gateway." EncryptionSupport: $ref: "#/components/schemas/EncryptionSupportOptionValue" description: Enable or disable encryption support for VPC Encryption Control. @@ -86856,6 +91627,34 @@ components: description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. required: - TransitGatewayMeteringPolicyId + ModifyTransitGatewayPolicyTableEntryOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/TransitGatewayPolicyTableEntryDisplay" + ModifyTransitGatewayPolicyTableEntryRequest: + type: object + properties: + TransitGatewayPolicyTableId: + $ref: "#/components/schemas/TransitGatewayPolicyTableId" + description: The ID of the transit gateway policy table. + PolicyRuleNumber: + $ref: "#/components/schemas/String" + description: The rule number of the policy table entry to modify. + PolicyRule: + $ref: "#/components/schemas/TransitGatewayRequestPolicyRule" + description: The updated matching criteria for the policy table entry. Unspecified fields retain their current values. + TargetRouteTableId: + $ref: "#/components/schemas/TransitGatewayRouteTableId" + description: The ID of the transit gateway route table to use for traffic matching this rule. + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + required: + - TransitGatewayPolicyTableId + - PolicyRuleNumber ModifyTransitGatewayPrefixListReferenceOutputDisplay: type: object properties: @@ -86896,7 +91695,7 @@ components: description: Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is disabled by default. For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide. Ipv6Support: $ref: "#/components/schemas/Ipv6SupportValue" - description: Enable or disable IPv6 support. The default is enable. + description: Specifies whether IPv6 support is enabled for the attachment. When enabled, the transit gateway network interface receives an IPv6 address. When you enable route propagation, IPv6 VPC CIDRs propagate to the transit gateway route tables. When disabled, the network interface does not receive an IPv6 address, and IPv6 routes do not propagate. The setting does not filter IPv6 traffic. ApplianceModeSupport: $ref: "#/components/schemas/ApplianceModeSupportValue" description: Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable. @@ -87614,6 +92413,57 @@ components: description: The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject. required: - ConnectionNotificationId + PayerResponsibilityType: + type: string + enum: + - vpc-endpoint-account + - vpc-endpoint-service-account + PayerResponsibilityScope: + type: string + enum: + - vpc-endpoint-charges + ModifyVpcEndpointPayerResponsibilityResultDisplay: + type: object + properties: + VpcEndpointId: + type: string + description: The ID of the VPC endpoint. + xml: + name: vpcEndpointId + PayerResponsibilities: + type: string + description: The payer responsibility settings for the VPC endpoint. + xml: + name: payerResponsibilitySet + ModifyVpcEndpointPayerResponsibilityOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ModifyVpcEndpointPayerResponsibilityResultDisplay" + ModifyVpcEndpointPayerResponsibilityRequest: + type: object + properties: + DryRun: + $ref: "#/components/schemas/Boolean" + description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + ServiceId: + $ref: "#/components/schemas/VpcEndpointServiceId" + description: The ID of the VPC endpoint service. + VpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint. + PayerResponsibility: + $ref: "#/components/schemas/PayerResponsibilityType" + description: The Amazon Web Services account to which the usage of VPC endpoint is charged. + Scope: + $ref: "#/components/schemas/PayerResponsibilityScope" + description: The scope of usage/charges for which the billing account is being modified. + required: + - VpcEndpointId + - PayerResponsibility + - Scope ModifyVpcEndpointServiceConfigurationResultDisplay: type: object properties: @@ -89013,7 +93863,7 @@ components: items: $ref: "#/components/schemas/ImageCriterionRequest" ImageCriterionRequest: - description: "The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region. The ImageCriteria can include up to: 10 ImageCriterion Each ImageCriterion can include up to: 200 values for ImageProviders 50 values for ImageNames 50 values for MarketplaceProductCodes For more information, see How Allowed AMIs works in the Amazon EC2 User Guide." + description: "The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region. The ImageCriteria can include up to: 10 ImageCriterion Each ImageCriterion can include up to: 200 values for ImageProviders 50 values for ImageNames 50 values for MarketplaceProductCodes 50 values for ImageWatermarks For more information, see How Allowed AMIs works in the Amazon EC2 User Guide." type: object properties: ImageProviders: @@ -89031,6 +93881,9 @@ components: CreationDateCondition: $ref: "#/components/schemas/CreationDateConditionRequest" description: The maximum age for allowed images. + ImageWatermarks: + $ref: "#/components/schemas/ImageWatermarkFilterRequestList" + description: "The watermark criteria that an AMI must match to be allowed. An AMI is allowed if it carries at least one watermark that satisfies an ImageWatermarkFilter. A watermark satisfies a filter when all specified fields in the ImageWatermarkFilter match the corresponding values on the watermark of the AMI. Maximum: 50 values" ImageProviderRequestList: type: array items: @@ -89073,6 +93926,26 @@ components: type: integer minimum: 0 maximum: 2147483647 + ImageWatermarkFilterRequestList: + type: array + items: + $ref: "#/components/schemas/ImageWatermarkFilterRequest" + ImageWatermarkFilterRequest: + description: The watermark filter criteria for an allowed image. Each entry can specify one or more fields. All specified fields must match the same watermark on the image. + type: object + properties: + WatermarkKey: + $ref: "#/components/schemas/String" + description: The accountId:name of the watermark. Supports wildcards (*, ?). + SourceImageRegion: + $ref: "#/components/schemas/String" + description: The Region where the watermark was originally created. Supports wildcards (*, ?). + MaximumDaysSinceSourceImageCreated: + $ref: "#/components/schemas/Integer" + description: "The maximum number of days that have elapsed since the source image was created. Constraints: Minimum value of 0. Maximum value of 2147483647." + MaximumDaysSinceWatermarkCreated: + $ref: "#/components/schemas/Integer" + description: "The maximum number of days that have elapsed since the watermark was attached to the image. Constraints: Minimum value of 0. Maximum value of 2147483647." ReplaceImageCriteriaInAllowedImagesSettingsResultDisplay: type: object properties: @@ -90535,13 +95408,6 @@ components: InstanceMetadataTags: $ref: "#/components/schemas/InstanceMetadataTagsState" description: "Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata. Default: disabled" - EnclaveOptionsRequest: - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide. - type: object - properties: - Enabled: - $ref: "#/components/schemas/Boolean" - description: To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true. PrivateDnsNameOptionsRequest: description: Describes the options for instance hostnames. type: object @@ -93504,6 +98370,164 @@ components: - $ref: "#/components/x-stackQL-resources/nat_gateways/methods/assign_private_nat_gateway_address" delete: - $ref: "#/components/x-stackQL-resources/nat_gateways/methods/delete_nat_gateway" + application_status_checks: + id: aws.ec2.application_status_checks + name: application_status_checks + title: application_status_checks + methods: + associate_application_status_check: + operation: + $ref: "#/paths/~1?Action=AssociateApplicationStatusCheck&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/AssociateApplicationStatusCheckOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + create_application_status_check: + operation: + $ref: "#/paths/~1?Action=CreateApplicationStatusCheck&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateApplicationStatusCheckOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + delete_application_status_check: + operation: + $ref: "#/paths/~1?Action=DeleteApplicationStatusCheck&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeleteApplicationStatusCheckOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + describe_application_status_checks: + operation: + $ref: "#/paths/~1?Action=DescribeApplicationStatusChecks&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeApplicationStatusChecksOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disable_application_status_check_suppression: + operation: + $ref: "#/paths/~1?Action=DisableApplicationStatusCheckSuppression&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisableApplicationStatusCheckSuppressionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disassociate_application_status_check: + operation: + $ref: "#/paths/~1?Action=DisassociateApplicationStatusCheck&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisassociateApplicationStatusCheckOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + enable_application_status_check_suppression: + operation: + $ref: "#/paths/~1?Action=EnableApplicationStatusCheckSuppression&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableApplicationStatusCheckSuppressionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_application_status_check: + operation: + $ref: "#/paths/~1?Action=ModifyApplicationStatusCheck&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyApplicationStatusCheckOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/application_status_checks/methods/describe_application_status_checks" + insert: + - $ref: "#/components/x-stackQL-resources/application_status_checks/methods/create_application_status_check" + update: + - $ref: "#/components/x-stackQL-resources/application_status_checks/methods/associate_application_status_check" + delete: + - $ref: "#/components/x-stackQL-resources/application_status_checks/methods/delete_application_status_check" client_vpn_target_networks: id: aws.ec2.client_vpn_target_networks name: client_vpn_target_networks @@ -94990,6 +100014,316 @@ components: - $ref: "#/components/x-stackQL-resources/trunk_interfaces/methods/associate_trunk_interface" - $ref: "#/components/x-stackQL-resources/trunk_interfaces/methods/disassociate_trunk_interface" delete: [] + images: + id: aws.ec2.images + name: images + title: images + methods: + attach_image_watermark: + operation: + $ref: "#/paths/~1?Action=AttachImageWatermark&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/AttachImageWatermarkOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + cancel_image_launch_permission: + operation: + $ref: "#/paths/~1?Action=CancelImageLaunchPermission&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CancelImageLaunchPermissionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + create_image: + operation: + $ref: "#/paths/~1?Action=CreateImage&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateImageOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + deregister_image: + operation: + $ref: "#/paths/~1?Action=DeregisterImage&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeregisterImageOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + describe_images: + operation: + $ref: "#/paths/~1?Action=DescribeImages&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeImagesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + detach_image_watermark: + operation: + $ref: "#/paths/~1?Action=DetachImageWatermark&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DetachImageWatermarkOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disable_fast_launch: + operation: + $ref: "#/paths/~1?Action=DisableFastLaunch&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisableFastLaunchOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disable_image_block_public_access: + operation: + $ref: "#/paths/~1?Action=DisableImageBlockPublicAccess&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisableImageBlockPublicAccessOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disable_image_deprecation: + operation: + $ref: "#/paths/~1?Action=DisableImageDeprecation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisableImageDeprecationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + disable_image_deregistration_protection: + operation: + $ref: "#/paths/~1?Action=DisableImageDeregistrationProtection&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DisableImageDeregistrationProtectionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + enable_fast_launch: + operation: + $ref: "#/paths/~1?Action=EnableFastLaunch&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableFastLaunchOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + enable_image_block_public_access: + operation: + $ref: "#/paths/~1?Action=EnableImageBlockPublicAccess&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableImageBlockPublicAccessOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + enable_image_deprecation: + operation: + $ref: "#/paths/~1?Action=EnableImageDeprecation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableImageDeprecationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + enable_image_deregistration_protection: + operation: + $ref: "#/paths/~1?Action=EnableImageDeregistrationProtection&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableImageDeregistrationProtectionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + register_image: + operation: + $ref: "#/paths/~1?Action=RegisterImage&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/RegisterImageOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + reset_image_attribute: + operation: + $ref: "#/paths/~1?Action=ResetImageAttribute&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + restore_image_from_recycle_bin: + operation: + $ref: "#/paths/~1?Action=RestoreImageFromRecycleBin&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/RestoreImageFromRecycleBinOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/images/methods/describe_images" + insert: + - $ref: "#/components/x-stackQL-resources/images/methods/create_image" + - $ref: "#/components/x-stackQL-resources/images/methods/register_image" + update: + - $ref: "#/components/x-stackQL-resources/images/methods/attach_image_watermark" + - $ref: "#/components/x-stackQL-resources/images/methods/detach_image_watermark" + delete: + - $ref: "#/components/x-stackQL-resources/images/methods/deregister_image" internet_gateways: id: aws.ec2.internet_gateways name: internet_gateways @@ -95731,6 +101065,114 @@ components: - $ref: "#/components/x-stackQL-resources/security_groups/methods/authorize_security_group_ingress" delete: - $ref: "#/components/x-stackQL-resources/security_groups/methods/delete_security_group" + ipam_routing_policy_registrations: + id: aws.ec2.ipam_routing_policy_registrations + name: ipam_routing_policy_registrations + title: ipam_routing_policy_registrations + methods: + batch_modify_ipam_routing_policy_registrations: + operation: + $ref: "#/paths/~1?Action=BatchModifyIpamRoutingPolicyRegistrations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + create_ipam_routing_policy_registration: + operation: + $ref: "#/paths/~1?Action=CreateIpamRoutingPolicyRegistration&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateIpamRoutingPolicyRegistrationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + delete_ipam_routing_policy_registration: + operation: + $ref: "#/paths/~1?Action=DeleteIpamRoutingPolicyRegistration&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeleteIpamRoutingPolicyRegistrationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + get_ipam_routing_policy_registrations: + operation: + $ref: "#/paths/~1?Action=GetIpamRoutingPolicyRegistrations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationsOutputDisplay" + transform: + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamRoutingPolicyRegistrationsResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamRoutingPolicyRegistrationSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_ipam_routing_policy_registration: + operation: + $ref: "#/paths/~1?Action=ModifyIpamRoutingPolicyRegistration&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyIpamRoutingPolicyRegistrationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_routing_policy_registrations/methods/get_ipam_routing_policy_registrations" + insert: + - $ref: "#/components/x-stackQL-resources/ipam_routing_policy_registrations/methods/create_ipam_routing_policy_registration" + update: + - $ref: "#/components/x-stackQL-resources/ipam_routing_policy_registrations/methods/modify_ipam_routing_policy_registration" + delete: + - $ref: "#/components/x-stackQL-resources/ipam_routing_policy_registrations/methods/delete_ipam_routing_policy_registration" instances: id: aws.ec2.instances name: instances @@ -96378,276 +101820,6 @@ components: - $ref: "#/components/x-stackQL-resources/export_tasks/methods/create_instance_export_task" update: [] delete: [] - images: - id: aws.ec2.images - name: images - title: images - methods: - cancel_image_launch_permission: - operation: - $ref: "#/paths/~1?Action=CancelImageLaunchPermission&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/CancelImageLaunchPermissionOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - create_image: - operation: - $ref: "#/paths/~1?Action=CreateImage&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/CreateImageOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - deregister_image: - operation: - $ref: "#/paths/~1?Action=DeregisterImage&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DeregisterImageOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - describe_images: - operation: - $ref: "#/paths/~1?Action=DescribeImages&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DescribeImagesOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - disable_fast_launch: - operation: - $ref: "#/paths/~1?Action=DisableFastLaunch&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DisableFastLaunchOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - disable_image_block_public_access: - operation: - $ref: "#/paths/~1?Action=DisableImageBlockPublicAccess&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DisableImageBlockPublicAccessOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - disable_image_deprecation: - operation: - $ref: "#/paths/~1?Action=DisableImageDeprecation&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DisableImageDeprecationOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - disable_image_deregistration_protection: - operation: - $ref: "#/paths/~1?Action=DisableImageDeregistrationProtection&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/DisableImageDeregistrationProtectionOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - enable_fast_launch: - operation: - $ref: "#/paths/~1?Action=EnableFastLaunch&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/EnableFastLaunchOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - enable_image_block_public_access: - operation: - $ref: "#/paths/~1?Action=EnableImageBlockPublicAccess&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/EnableImageBlockPublicAccessOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - enable_image_deprecation: - operation: - $ref: "#/paths/~1?Action=EnableImageDeprecation&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/EnableImageDeprecationOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - enable_image_deregistration_protection: - operation: - $ref: "#/paths/~1?Action=EnableImageDeregistrationProtection&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/EnableImageDeregistrationProtectionOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - register_image: - operation: - $ref: "#/paths/~1?Action=RegisterImage&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/RegisterImageOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - reset_image_attribute: - operation: - $ref: "#/paths/~1?Action=ResetImageAttribute&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - restore_image_from_recycle_bin: - operation: - $ref: "#/paths/~1?Action=RestoreImageFromRecycleBin&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/RestoreImageFromRecycleBinOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/images/methods/describe_images" - insert: - - $ref: "#/components/x-stackQL-resources/images/methods/create_image" - - $ref: "#/components/x-stackQL-resources/images/methods/register_image" - update: [] - delete: - - $ref: "#/components/x-stackQL-resources/images/methods/deregister_image" spot_fleet_requests: id: aws.ec2.spot_fleet_requests name: spot_fleet_requests @@ -96832,6 +102004,56 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/capacity_manager_data_exports/methods/delete_capacity_manager_data_export" + capacity_reservation_cancellation_quotes: + id: aws.ec2.capacity_reservation_cancellation_quotes + name: capacity_reservation_cancellation_quotes + title: capacity_reservation_cancellation_quotes + methods: + create_capacity_reservation_cancellation_quote: + operation: + $ref: "#/paths/~1?Action=CreateCapacityReservationCancellationQuote&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateCapacityReservationCancellationQuoteOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + describe_capacity_reservation_cancellation_quotes: + operation: + $ref: "#/paths/~1?Action=DescribeCapacityReservationCancellationQuotes&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeCapacityReservationCancellationQuotesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/capacity_reservation_cancellation_quotes/methods/describe_capacity_reservation_cancellation_quotes" + insert: + - $ref: "#/components/x-stackQL-resources/capacity_reservation_cancellation_quotes/methods/create_capacity_reservation_cancellation_quote" + update: [] + delete: [] carrier_gateways: id: aws.ec2.carrier_gateways name: carrier_gateways @@ -97715,6 +102937,23 @@ components: algorithm: AWSCanonical requestTranslate: algorithm: get_query_to_post_form_utf_8 + enable_ipam_internet_registry_association: + operation: + $ref: "#/paths/~1?Action=EnableIpamInternetRegistryAssociation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/EnableIpamInternetRegistryAssociationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 enable_ipam_organization_admin_account: operation: $ref: "#/paths/~1?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15/get" @@ -97847,6 +103086,76 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/ipam_external_resource_verification_tokens/methods/delete_ipam_external_resource_verification_token" + ipam_internet_registry_associations: + id: aws.ec2.ipam_internet_registry_associations + name: ipam_internet_registry_associations + title: ipam_internet_registry_associations + methods: + create_ipam_internet_registry_association: + operation: + $ref: "#/paths/~1?Action=CreateIpamInternetRegistryAssociation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateIpamInternetRegistryAssociationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + delete_ipam_internet_registry_association: + operation: + $ref: "#/paths/~1?Action=DeleteIpamInternetRegistryAssociation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeleteIpamInternetRegistryAssociationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + describe_ipam_internet_registry_associations: + operation: + $ref: "#/paths/~1?Action=DescribeIpamInternetRegistryAssociations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeIpamInternetRegistryAssociationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_internet_registry_associations/methods/describe_ipam_internet_registry_associations" + insert: + - $ref: "#/components/x-stackQL-resources/ipam_internet_registry_associations/methods/create_ipam_internet_registry_association" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/ipam_internet_registry_associations/methods/delete_ipam_internet_registry_association" ipam_policies: id: aws.ec2.ipam_policies name: ipam_policies @@ -101173,6 +106482,96 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/delete_transit_gateway_peering_attachment" + transit_gateway_policy_table_entries: + id: aws.ec2.transit_gateway_policy_table_entries + name: transit_gateway_policy_table_entries + title: transit_gateway_policy_table_entries + methods: + create_transit_gateway_policy_table_entry: + operation: + $ref: "#/paths/~1?Action=CreateTransitGatewayPolicyTableEntry&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateTransitGatewayPolicyTableEntryOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + delete_transit_gateway_policy_table_entry: + operation: + $ref: "#/paths/~1?Action=DeleteTransitGatewayPolicyTableEntry&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeleteTransitGatewayPolicyTableEntryOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + get_transit_gateway_policy_table_entries: + operation: + $ref: "#/paths/~1?Action=GetTransitGatewayPolicyTableEntries&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetTransitGatewayPolicyTableEntriesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_transit_gateway_policy_table_entry: + operation: + $ref: "#/paths/~1?Action=ModifyTransitGatewayPolicyTableEntry&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyTransitGatewayPolicyTableEntryOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/transit_gateway_policy_table_entries/methods/get_transit_gateway_policy_table_entries" + insert: + - $ref: "#/components/x-stackQL-resources/transit_gateway_policy_table_entries/methods/create_transit_gateway_policy_table_entry" + update: + - $ref: "#/components/x-stackQL-resources/transit_gateway_policy_table_entries/methods/modify_transit_gateway_policy_table_entry" + delete: + - $ref: "#/components/x-stackQL-resources/transit_gateway_policy_table_entries/methods/delete_transit_gateway_policy_table_entry" transit_gateway_prefix_list_references: id: aws.ec2.transit_gateway_prefix_list_references name: transit_gateway_prefix_list_references @@ -102079,12 +107478,32 @@ components: algorithm: AWSCanonical requestTranslate: algorithm: get_query_to_post_form_utf_8 + modify_vpc_endpoint_payer_responsibility: + operation: + $ref: "#/paths/~1?Action=ModifyVpcEndpointPayerResponsibility&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyVpcEndpointPayerResponsibilityOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/vpc_endpoints/methods/describe_vpc_endpoints" insert: - $ref: "#/components/x-stackQL-resources/vpc_endpoints/methods/create_vpc_endpoint" update: + - $ref: "#/components/x-stackQL-resources/vpc_endpoints/methods/modify_vpc_endpoint_payer_responsibility" - $ref: "#/components/x-stackQL-resources/vpc_endpoints/methods/modify_vpc_endpoint" delete: - $ref: "#/components/x-stackQL-resources/vpc_endpoints/methods/delete_vpc_endpoints" @@ -102866,6 +108285,56 @@ components: insert: [] update: [] delete: [] + account_vpc_encryption_controls: + id: aws.ec2.account_vpc_encryption_controls + name: account_vpc_encryption_controls + title: account_vpc_encryption_controls + methods: + describe_account_vpc_encryption_control: + operation: + $ref: "#/paths/~1?Action=DescribeAccountVpcEncryptionControl&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeAccountVpcEncryptionControlOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_account_vpc_encryption_control: + operation: + $ref: "#/paths/~1?Action=ModifyAccountVpcEncryptionControl&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyAccountVpcEncryptionControlOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/account_vpc_encryption_controls/methods/describe_account_vpc_encryption_control" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/account_vpc_encryption_controls/methods/modify_account_vpc_encryption_control" + delete: [] address_transfers: id: aws.ec2.address_transfers name: address_transfers @@ -102956,6 +108425,66 @@ components: insert: [] update: [] delete: [] + application_status: + id: aws.ec2.application_status + name: application_status + title: application_status + methods: + describe_application_status: + operation: + $ref: "#/paths/~1?Action=DescribeApplicationStatus&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeApplicationStatusOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/application_status/methods/describe_application_status" + insert: [] + update: [] + delete: [] + application_status_check_associations: + id: aws.ec2.application_status_check_associations + name: application_status_check_associations + title: application_status_check_associations + methods: + describe_application_status_check_associations: + operation: + $ref: "#/paths/~1?Action=DescribeApplicationStatusCheckAssociations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeApplicationStatusCheckAssociationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/application_status_check_associations/methods/describe_application_status_check_associations" + insert: [] + update: [] + delete: [] availability_zones: id: aws.ec2.availability_zones name: availability_zones @@ -104327,10 +109856,10 @@ components: insert: [] update: [] delete: [] - instance_type_offerings: - id: aws.ec2.instance_type_offerings - name: instance_type_offerings - title: instance_type_offerings + instance_types: + id: aws.ec2.instance_types + name: instance_types + title: instance_types methods: describe_instance_type_offerings: operation: @@ -104351,26 +109880,123 @@ components: algorithm: AWSCanonical requestTranslate: algorithm: get_query_to_post_form_utf_8 + describe_instance_types: + operation: + $ref: "#/paths/~1?Action=DescribeInstanceTypes&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeInstanceTypesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + get_instance_types_from_instance_requirements: + operation: + $ref: "#/paths/~1?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetInstanceTypesFromInstanceRequirementsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/instance_type_offerings/methods/describe_instance_type_offerings" + - $ref: "#/components/x-stackQL-resources/instance_types/methods/get_instance_types_from_instance_requirements" + - $ref: "#/components/x-stackQL-resources/instance_types/methods/describe_instance_type_offerings" + - $ref: "#/components/x-stackQL-resources/instance_types/methods/describe_instance_types" insert: [] update: [] delete: [] - instance_types: - id: aws.ec2.instance_types - name: instance_types - title: instance_types + ipam_pool_allocations: + id: aws.ec2.ipam_pool_allocations + name: ipam_pool_allocations + title: ipam_pool_allocations methods: - describe_instance_types: + describe_ipam_pool_allocations: operation: - $ref: "#/paths/~1?Action=DescribeInstanceTypes&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=DescribeIpamPoolAllocations&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/DescribeInstanceTypesOutputDisplay" + $ref: "#/components/schemas/DescribeIpamPoolAllocationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + get_ipam_pool_allocations: + operation: + $ref: "#/paths/~1?Action=GetIpamPoolAllocations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamPoolAllocationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_ipam_pool_allocation: + operation: + $ref: "#/paths/~1?Action=ModifyIpamPoolAllocation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyIpamPoolAllocationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + release_ipam_pool_allocation: + operation: + $ref: "#/paths/~1?Action=ReleaseIpamPoolAllocation&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ReleaseIpamPoolAllocationOutputDisplay" transform: type: schema_driven_xml_v0.1.0 objectKey: $.line_items @@ -104383,9 +110009,12 @@ components: algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/instance_types/methods/describe_instance_types" + - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/get_ipam_pool_allocations" + - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/describe_ipam_pool_allocations" insert: [] - update: [] + update: + - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/release_ipam_pool_allocation" + - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/modify_ipam_pool_allocation" delete: [] ipam_resource_discovery_associations: id: aws.ec2.ipam_resource_discovery_associations @@ -106823,36 +112452,6 @@ components: insert: [] update: [] delete: [] - instance_types_from_instance_requirements: - id: aws.ec2.instance_types_from_instance_requirements - name: instance_types_from_instance_requirements - title: instance_types_from_instance_requirements - methods: - get_instance_types_from_instance_requirements: - operation: - $ref: "#/paths/~1?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/GetInstanceTypesFromInstanceRequirementsOutputDisplay" - transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/instance_types_from_instance_requirements/methods/get_instance_types_from_instance_requirements" - insert: [] - update: [] - delete: [] instance_uefi_datas: id: aws.ec2.instance_uefi_datas name: instance_uefi_datas @@ -107004,22 +112603,23 @@ components: insert: [] update: [] delete: [] - ipam_policy_allocation_rules: - id: aws.ec2.ipam_policy_allocation_rules - name: ipam_policy_allocation_rules - title: ipam_policy_allocation_rules + ipam_discovered_routes: + id: aws.ec2.ipam_discovered_routes + name: ipam_discovered_routes + title: ipam_discovered_routes methods: - get_ipam_policy_allocation_rules: + get_ipam_discovered_routes: operation: - $ref: "#/paths/~1?Action=GetIpamPolicyAllocationRules&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=GetIpamDiscoveredRoutes&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/GetIpamPolicyAllocationRulesOutputDisplay" + $ref: "#/components/schemas/GetIpamDiscoveredRoutesOutputDisplay" transform: - type: schema_driven_xml_v0.1.0 + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamDiscoveredRoutesResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamDiscoveredRouteSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' objectKey: $.line_items request: nativeCasing: pascal @@ -107028,17 +112628,29 @@ components: algorithm: AWSCanonical requestTranslate: algorithm: get_query_to_post_form_utf_8 - modify_ipam_policy_allocation_rules: + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_discovered_routes/methods/get_ipam_discovered_routes" + insert: [] + update: [] + delete: [] + ipam_internet_registry_association_asns: + id: aws.ec2.ipam_internet_registry_association_asns + name: ipam_internet_registry_association_asns + title: ipam_internet_registry_association_asns + methods: + get_ipam_internet_registry_association_asns: operation: - $ref: "#/paths/~1?Action=ModifyIpamPolicyAllocationRules&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=GetIpamInternetRegistryAssociationAsns&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/ModifyIpamPolicyAllocationRulesOutputDisplay" + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationAsnsOutputDisplay" transform: - type: schema_driven_xml_v0.1.0 + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamInternetRegistryAssociationAsnsResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamInternetRegistryAssociationAsnSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' objectKey: $.line_items request: nativeCasing: pascal @@ -107049,27 +112661,27 @@ components: algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/ipam_policy_allocation_rules/methods/get_ipam_policy_allocation_rules" + - $ref: "#/components/x-stackQL-resources/ipam_internet_registry_association_asns/methods/get_ipam_internet_registry_association_asns" insert: [] - update: - - $ref: "#/components/x-stackQL-resources/ipam_policy_allocation_rules/methods/modify_ipam_policy_allocation_rules" + update: [] delete: [] - ipam_policy_organization_targets: - id: aws.ec2.ipam_policy_organization_targets - name: ipam_policy_organization_targets - title: ipam_policy_organization_targets + ipam_internet_registry_association_cidrs: + id: aws.ec2.ipam_internet_registry_association_cidrs + name: ipam_internet_registry_association_cidrs + title: ipam_internet_registry_association_cidrs methods: - get_ipam_policy_organization_targets: + get_ipam_internet_registry_association_cidrs: operation: - $ref: "#/paths/~1?Action=GetIpamPolicyOrganizationTargets&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=GetIpamInternetRegistryAssociationCidrs&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/GetIpamPolicyOrganizationTargetsOutputDisplay" + $ref: "#/components/schemas/GetIpamInternetRegistryAssociationCidrsOutputDisplay" transform: - type: schema_driven_xml_v0.1.0 + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamInternetRegistryAssociationCidrsResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamInternetRegistryAssociationCidrSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' objectKey: $.line_items request: nativeCasing: pascal @@ -107080,24 +112692,24 @@ components: algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/ipam_policy_organization_targets/methods/get_ipam_policy_organization_targets" + - $ref: "#/components/x-stackQL-resources/ipam_internet_registry_association_cidrs/methods/get_ipam_internet_registry_association_cidrs" insert: [] update: [] delete: [] - ipam_pool_allocations: - id: aws.ec2.ipam_pool_allocations - name: ipam_pool_allocations - title: ipam_pool_allocations + ipam_policy_allocation_rules: + id: aws.ec2.ipam_policy_allocation_rules + name: ipam_policy_allocation_rules + title: ipam_policy_allocation_rules methods: - get_ipam_pool_allocations: + get_ipam_policy_allocation_rules: operation: - $ref: "#/paths/~1?Action=GetIpamPoolAllocations&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=GetIpamPolicyAllocationRules&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/GetIpamPoolAllocationsOutputDisplay" + $ref: "#/components/schemas/GetIpamPolicyAllocationRulesOutputDisplay" transform: type: schema_driven_xml_v0.1.0 objectKey: $.line_items @@ -107108,15 +112720,15 @@ components: algorithm: AWSCanonical requestTranslate: algorithm: get_query_to_post_form_utf_8 - release_ipam_pool_allocation: + modify_ipam_policy_allocation_rules: operation: - $ref: "#/paths/~1?Action=ReleaseIpamPoolAllocation&Version=2016-11-15/get" + $ref: "#/paths/~1?Action=ModifyIpamPolicyAllocationRules&Version=2016-11-15/get" response: openAPIDocKey: "200" mediaType: application/xml overrideMediaType: application/json schema_override: - $ref: "#/components/schemas/ReleaseIpamPoolAllocationOutputDisplay" + $ref: "#/components/schemas/ModifyIpamPolicyAllocationRulesOutputDisplay" transform: type: schema_driven_xml_v0.1.0 objectKey: $.line_items @@ -107129,10 +112741,40 @@ components: algorithm: get_query_to_post_form_utf_8 sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/get_ipam_pool_allocations" + - $ref: "#/components/x-stackQL-resources/ipam_policy_allocation_rules/methods/get_ipam_policy_allocation_rules" insert: [] update: - - $ref: "#/components/x-stackQL-resources/ipam_pool_allocations/methods/release_ipam_pool_allocation" + - $ref: "#/components/x-stackQL-resources/ipam_policy_allocation_rules/methods/modify_ipam_policy_allocation_rules" + delete: [] + ipam_policy_organization_targets: + id: aws.ec2.ipam_policy_organization_targets + name: ipam_policy_organization_targets + title: ipam_policy_organization_targets + methods: + get_ipam_policy_organization_targets: + operation: + $ref: "#/paths/~1?Action=GetIpamPolicyOrganizationTargets&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamPolicyOrganizationTargetsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_policy_organization_targets/methods/get_ipam_policy_organization_targets" + insert: [] + update: [] delete: [] ipam_prefix_list_resolver_rules: id: aws.ec2.ipam_prefix_list_resolver_rules @@ -107274,6 +112916,98 @@ components: update: - $ref: "#/components/x-stackQL-resources/ipam_resource_cidrs/methods/modify_ipam_resource_cidr" delete: [] + ipam_route_origin_authorizations: + id: aws.ec2.ipam_route_origin_authorizations + name: ipam_route_origin_authorizations + title: ipam_route_origin_authorizations + methods: + get_ipam_route_origin_authorizations: + operation: + $ref: "#/paths/~1?Action=GetIpamRouteOriginAuthorizations&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamRouteOriginAuthorizationsOutputDisplay" + transform: + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamRouteOriginAuthorizationsResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamRouteOriginAuthorizationSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_route_origin_authorizations/methods/get_ipam_route_origin_authorizations" + insert: [] + update: [] + delete: [] + ipam_route_protection_findings: + id: aws.ec2.ipam_route_protection_findings + name: ipam_route_protection_findings + title: ipam_route_protection_findings + methods: + get_ipam_route_protection_findings: + operation: + $ref: "#/paths/~1?Action=GetIpamRouteProtectionFindings&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamRouteProtectionFindingsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_route_protection_findings/methods/get_ipam_route_protection_findings" + insert: [] + update: [] + delete: [] + ipam_routing_policy_registration_deltas: + id: aws.ec2.ipam_routing_policy_registration_deltas + name: ipam_routing_policy_registration_deltas + title: ipam_routing_policy_registration_deltas + methods: + get_ipam_routing_policy_registration_deltas: + operation: + $ref: "#/paths/~1?Action=GetIpamRoutingPolicyRegistrationDeltas&Version=2016-11-15/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetIpamRoutingPolicyRegistrationDeltasOutputDisplay" + transform: + type: golang_template_mxj_v0.3.0 + body: '{{- $s := separator ", " -}}{{- $n := index . "GetIpamRoutingPolicyRegistrationDeltasResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "ipamRoutingPolicyRegistrationDeltaSet" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/ipam_routing_policy_registration_deltas/methods/get_ipam_routing_policy_registration_deltas" + insert: [] + update: [] + delete: [] launch_template_datas: id: aws.ec2.launch_template_datas name: launch_template_datas @@ -107806,37 +113540,6 @@ components: insert: [] update: [] delete: [] - transit_gateway_policy_table_entries: - id: aws.ec2.transit_gateway_policy_table_entries - name: transit_gateway_policy_table_entries - title: transit_gateway_policy_table_entries - methods: - get_transit_gateway_policy_table_entries: - operation: - $ref: "#/paths/~1?Action=GetTransitGatewayPolicyTableEntries&Version=2016-11-15/get" - response: - openAPIDocKey: "200" - mediaType: application/xml - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/GetTransitGatewayPolicyTableEntriesOutputDisplay" - transform: - type: golang_template_mxj_v0.3.0 - body: '{{- $s := separator ", " -}}{{- $n := index . "GetTransitGatewayPolicyTableEntriesResponse" -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "transitGatewayPolicyTableEntries" }}{{ else }}{{ $n = "" }}{{ end -}}{{- if eq (kindOf $n) "map" }}{{ $n = index $n "item" }}{{ else }}{{ $n = "" }}{{ end -}}{"line_items": [{{- if eq (kindOf $n) "slice" -}}{{- range $x := $n }}{{ call $s }}{{ toJson $x }}{{ end -}}{{- else if eq (kindOf $n) "map" -}}{{ call $s }}{{ toJson $n }}{{- end -}}]}' - objectKey: $.line_items - request: - nativeCasing: pascal - config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/transit_gateway_policy_table_entries/methods/get_transit_gateway_policy_table_entries" - insert: [] - update: [] - delete: [] transit_gateway_route_table_associations: id: aws.ec2.transit_gateway_route_table_associations name: transit_gateway_route_table_associations diff --git a/providers/src/aws/v00.00.00000/services/ecs.yaml b/providers/src/aws/v00.00.00000/services/ecs.yaml index 69318fe6..85701f20 100644 --- a/providers/src/aws/v00.00.00000/services/ecs.yaml +++ b/providers/src/aws/v00.00.00000/services/ecs.yaml @@ -18,6 +18,46 @@ servers: description: AWS region description: Regional endpoint for ecs paths: + /ContinueServiceDeployment: + post: + operationId: ContinueServiceDeployment + description: Continues or rolls back an Amazon ECS service deployment that is paused at a lifecycle hook. When a service deployment reaches a lifecycle stage that has a PAUSE hook configured, the deployment pauses and waits for an explicit action. Use this API to either continue the deployment to the next stage or roll back to the previous service revision. To find the hookId of the paused hook, call DescribeServiceDeployments and inspect the lifecycleHookDetails field. For more information, see Continuing Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonEC2ContainerServiceV20141113.ContinueServiceDeployment + default: AmazonEC2ContainerServiceV20141113.ContinueServiceDeployment + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + serviceDeploymentArn: + $ref: "#/components/schemas/String" + description: The ARN of the service deployment to continue or roll back. + hookId: + $ref: "#/components/schemas/String" + description: The ID of the paused lifecycle hook to act on. You can find the hookId by calling DescribeServiceDeployments and inspecting the lifecycleHookDetails field of the service deployment. + action: + $ref: "#/components/schemas/DeploymentLifecycleHookAction" + description: "The action to take on the paused lifecycle hook. Valid values are: CONTINUE - Proceeds the deployment to the next lifecycle stage. ROLLBACK - Rolls back the deployment to the previous service revision. If no value is specified, the default action is CONTINUE." + required: + - serviceDeploymentArn + - hookId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ContinueServiceDeploymentResponse" /CreateCapacityProvider: post: operationId: CreateCapacityProvider @@ -231,10 +271,11 @@ paths: tags: $ref: "#/components/schemas/Tags" description: The metadata that you apply to the Express service to help categorize and organize it. Each tag consists of a key and an optional value. You can apply up to 50 tags to a service. + taskDefinitionArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of a task definition to use to create the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers. The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility. If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, or memory. required: - - executionRoleArn - infrastructureRoleArn - - primaryContainer responses: "200": description: Success @@ -341,6 +382,9 @@ paths: vpcLatticeConfigurations: $ref: "#/components/schemas/VpcLatticeConfigurations" description: The VPC Lattice configuration for the service being created. + monitoring: + $ref: "#/components/schemas/MonitoringConfiguration" + description: The optional monitoring configuration for the service, which defines the resolution for the service-level CPUUtilization and MemoryUtilization Amazon CloudWatch metrics. When not specified, Amazon ECS uses the default resolution of 60 seconds. required: - serviceName responses: @@ -1761,7 +1805,7 @@ paths: properties: clusterArn: $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the cluster to filter daemons by. If not specified, daemons from all clusters are returned. + description: The Amazon Resource Name (ARN) of the cluster to filter daemons by. If you do not specify a cluster, the default cluster is assumed. capacityProviderArns: $ref: "#/components/schemas/StringList" description: The Amazon Resource Names (ARNs) of the capacity providers to filter daemons by. Only daemons associated with the specified capacity providers are returned. @@ -2283,7 +2327,7 @@ paths: description: The container instance attributes that this container instance supports. platformDevices: $ref: "#/components/schemas/PlatformDevices" - description: The devices that are available on the container instance. The only supported device type is a GPU. + description: The devices that are available on the container instance. The supported device types are GPUs and Neuron devices. tags: $ref: "#/components/schemas/Tags" description: "The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." @@ -2339,6 +2383,12 @@ paths: tags: $ref: "#/components/schemas/Tags" description: "The metadata that you apply to the daemon task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." + pidMode: + $ref: "#/components/schemas/DaemonPidMode" + description: 'The PID namespace mode for the daemon. The valid values are none and shared. The default is none. If none is specified or no value is provided, the daemon runs with its own PID namespace, isolated from other tasks. If shared is specified, the daemon joins the host PID namespace, making it accessible to non-daemon tasks that use pidMode: "host" or other daemons that use pidMode: "shared".' + ipcMode: + $ref: "#/components/schemas/DaemonIpcMode" + description: 'The IPC namespace mode for the daemon. The valid values are none and shared. The default is none. If none is specified or no value is provided, the daemon runs with its own IPC namespace, isolated from other tasks. If shared is specified, the daemon joins the host IPC namespace, making it accessible to non-daemon tasks that use ipcMode: "host" or other daemons that use ipcMode: "shared".' required: - family - containerDefinitions @@ -3184,6 +3234,9 @@ paths: scalingTarget: $ref: "#/components/schemas/ExpressGatewayScalingTarget" description: The auto-scaling configuration for the Express service. + taskDefinitionArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers. The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility. If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, or memory. required: - serviceArn responses: @@ -3279,6 +3332,9 @@ paths: vpcLatticeConfigurations: $ref: "#/components/schemas/VpcLatticeConfigurations" description: An object representing the VPC Lattice configuration for the service being updated. This parameter triggers a new service deployment. + monitoring: + $ref: "#/components/schemas/MonitoringConfiguration" + description: The optional monitoring configuration for the service, which defines the resolution for the service-level CPUUtilization and MemoryUtilization Amazon CloudWatch metrics. When not specified, Amazon ECS uses the default resolution of 60 seconds. required: - service responses: @@ -3465,6 +3521,17 @@ components: schemas: String: type: string + DeploymentLifecycleHookAction: + type: string + enum: + - ROLLBACK + - CONTINUE + ContinueServiceDeploymentResponse: + type: object + properties: + serviceDeploymentArn: + $ref: "#/components/schemas/String" + description: The ARN of the service deployment that was continued or rolled back. AutoScalingGroupProvider: description: The details of the Auto Scaling group for the capacity provider. type: object @@ -4512,6 +4579,9 @@ components: taskRoleArn: $ref: "#/components/schemas/String" description: The ARN of the task role for the service revision. + taskDefinitionArn: + $ref: "#/components/schemas/String" + description: The ARN of the task definition used by this service revision. This is present for all Express services and reflects the task definition in use, whether managed by Amazon ECS or provided by the customer. cpu: $ref: "#/components/schemas/String" description: The CPU allocation for tasks in this service revision. @@ -4653,7 +4723,7 @@ components: description: The time period when both blue and green service revisions are running simultaneously after the production traffic has shifted. You must provide this parameter when you use the BLUE_GREEN deployment strategy. lifecycleHooks: $ref: "#/components/schemas/DeploymentLifecycleHookList" - description: An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle. + description: An array of deployment lifecycle hook objects to run custom logic or pause the deployment at specific stages of the deployment lifecycle. linearConfiguration: $ref: "#/components/schemas/LinearConfiguration" description: Configuration for linear deployment strategy. Only valid when the deployment strategy is LINEAR. This configuration enables progressive traffic shifting in equal percentage increments with configurable bake times between each step. @@ -4670,9 +4740,35 @@ components: rollback: $ref: "#/components/schemas/Boolean" description: Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. + resetOnHealthyTask: + $ref: "#/components/schemas/BoxedBoolean" + description: Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true. + thresholdConfiguration: + $ref: "#/components/schemas/ThresholdConfiguration" + description: The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates. required: - enable - rollback + ThresholdConfiguration: + description: Defines the failure threshold that the deployment circuit breaker uses to monitor a deployment. The type and value together determine the number of task failures that are tolerated before the circuit breaker triggers. By default, the threshold configuration uses a type of BOUNDED_PERCENT with a value of 50. + type: object + properties: + type_: + $ref: "#/components/schemas/ThresholdType" + description: Determines how Amazon ECS uses value to calculate the failure threshold. For the percentage types (BOUNDED_PERCENT and UNBOUNDED_PERCENT), Amazon ECS multiplies value by the latest service desired count. For COUNT, Amazon ECS uses value directly as the threshold. The default is BOUNDED_PERCENT. + value: + $ref: "#/components/schemas/Integer" + description: Specifies the integer that Amazon ECS uses to calculate the failure threshold. When type is COUNT, this value is the failure threshold itself. When type is a percentage type, Amazon ECS multiplies this value by the latest service desired count to produce the failure threshold. The default is 50. + required: + - type_ + - value + ThresholdType: + description: Determines how the deployment circuit breaker calculates the number of task failures tolerated before it triggers, based on the configured value. + type: string + enum: + - COUNT + - BOUNDED_PERCENT + - UNBOUNDED_PERCENT DeploymentAlarms: description: One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide . type: object @@ -4702,21 +4798,32 @@ components: items: $ref: "#/components/schemas/DeploymentLifecycleHook" DeploymentLifecycleHook: - description: A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets. For more information, see Lifecycle hooks for Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide. + description: A deployment lifecycle hook runs custom logic or pauses the deployment at specific stages of the deployment process. You can use Lambda functions or pause hooks as hook targets. For more information, see Lifecycle hooks for Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide. type: object properties: + targetType: + $ref: "#/components/schemas/DeploymentLifecycleHookTargetType" + description: "The type of action the lifecycle hook performs. Valid values are: AWS_LAMBDA - Invokes a Lambda function at the specified lifecycle stage. This is the default value. PAUSE - Pauses the deployment at the specified lifecycle stage until you call ContinueServiceDeployment to continue or roll back. This field is optional. If not specified, the default value is AWS_LAMBDA." hookTargetArn: $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported. You must provide this parameter when configuring a deployment lifecycle hook. + description: The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. This field is not applicable for PAUSE hooks. You must provide this parameter when configuring an AWS_LAMBDA lifecycle hook. roleArn: $ref: "#/components/schemas/IAMRoleArn" description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf. For more information, see Permissions required for Lambda functions in Amazon ECS blue/green deployments in the Amazon Elastic Container Service Developer Guide. lifecycleStages: $ref: "#/components/schemas/DeploymentLifecycleHookStageList" - description: "The lifecycle stages at which to run the hook. Choose from these valid values: RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. You can use a lifecycle hook for this stage. PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. You can use a lifecycle hook for this stage. POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. You can use a lifecycle hook for this stage. PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. You can use a lifecycle hook for this stage. POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. You can use a lifecycle hook for this stage. You must provide this parameter when configuring a deployment lifecycle hook." + description: "The lifecycle stages at which to run the hook. Choose from these valid values: RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. You can use a lifecycle hook for this stage. PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. You can use a lifecycle hook for this stage. POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. You can use a lifecycle hook for this stage. PRE_PRODUCTION_TRAFFIC_SHIFT Occurs before production traffic shift. For linear and canary deployments, this stage is invoked before every traffic shift step. You can use a lifecycle hook for this stage. PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. For linear and canary deployments, this stage is invoked at every traffic shift step. You can use a lifecycle hook for this stage. POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. You can use a lifecycle hook for this stage. PAUSE hooks cannot be configured at TEST_TRAFFIC_SHIFT or PRODUCTION_TRAFFIC_SHIFT stages. These stages are only valid for AWS_LAMBDA hooks. You must provide this parameter when configuring a deployment lifecycle hook." hookDetails: $ref: "#/components/schemas/HookDetails" - description: Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function). + description: Use this field to specify custom parameters that Amazon ECS passes to your Lambda function on each invocation. This field is not used for PAUSE hooks. + timeoutConfiguration: + $ref: "#/components/schemas/DeploymentLifecycleHookTimeoutConfiguration" + description: The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved. + DeploymentLifecycleHookTargetType: + type: string + enum: + - AWS_LAMBDA + - PAUSE IAMRoleArn: type: string DeploymentLifecycleHookStageList: @@ -4731,10 +4838,25 @@ components: - POST_SCALE_UP - TEST_TRAFFIC_SHIFT - POST_TEST_TRAFFIC_SHIFT + - PRE_PRODUCTION_TRAFFIC_SHIFT - PRODUCTION_TRAFFIC_SHIFT - POST_PRODUCTION_TRAFFIC_SHIFT HookDetails: type: object + DeploymentLifecycleHookTimeoutConfiguration: + description: The timeout configuration for a deployment lifecycle hook. This determines how long Amazon ECS waits for the hook to complete before taking the specified timeout action. + type: object + properties: + timeoutInMinutes: + $ref: "#/components/schemas/DeploymentLifecycleHookDuration" + description: "The number of minutes Amazon ECS waits for the lifecycle hook to complete before taking the timeout action. Default: 1440 (24 hours)" + action: + $ref: "#/components/schemas/DeploymentLifecycleHookAction" + description: "The action Amazon ECS takes when the lifecycle hook times out. Valid values are: CONTINUE - Proceeds the deployment to the next lifecycle stage. ROLLBACK - Rolls back the deployment to the previous service revision. Default: ROLLBACK" + DeploymentLifecycleHookDuration: + type: integer + minimum: 1 + maximum: 20160 LinearConfiguration: description: Configuration for linear deployment strategy that shifts production traffic in equal percentage increments with configurable wait times between each step until 100% of traffic is shifted to the new service revision. This is only valid when you run CreateService or UpdateService with deploymentController set to ECS and a deploymentConfiguration with a strategy set to LINEAR. type: object @@ -5152,12 +5274,48 @@ components: - roleArn - targetGroupArn - portName + MonitoringConfiguration: + description: The optional monitoring configuration for a service, which defines the resolution for the service-level CPUUtilization and MemoryUtilization Amazon CloudWatch metrics. When not specified, Amazon ECS uses the default resolution of 60 seconds. + type: object + properties: + metricConfigurations: + $ref: "#/components/schemas/MetricConfigurationList" + description: The list of metric configurations for the service monitoring. + MetricConfigurationList: + type: array + items: + $ref: "#/components/schemas/MetricConfiguration" + MetricConfiguration: + description: The configuration for a specific set of metrics to collect for a service. + type: object + properties: + metricNames: + $ref: "#/components/schemas/MetricNamesList" + description: The list of metric names to configure. The supported metric names are CPUUtilization and MemoryUtilization. + resolutionSeconds: + $ref: "#/components/schemas/MetricResolutionSeconds" + description: The resolution, in seconds, at which to collect the metrics. The valid values are 20 and 60. + required: + - metricNames + - resolutionSeconds + MetricNamesList: + type: array + items: + $ref: "#/components/schemas/MetricName" + MetricName: + type: string + minLength: 1 + maxLength: 255 + MetricResolutionSeconds: + type: integer + minimum: 20 + maximum: 60 CreateServiceResponse: type: object properties: service: $ref: "#/components/schemas/Service" - description: The full description of your service following the create call. A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created. If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned. if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list. + description: The full description of your service following the create call. A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created. If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned. if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list. The response includes a lifecycleHookDetails field, which is an empty array when the service is created or updated. The values are populated when a lifecycle hook executes and are available as part of the service deployment details (DescribeServiceDeployments). Service: description: Details on a service within a cluster. type: object @@ -5859,7 +6017,7 @@ components: description: A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections. resourceRequirements: $ref: "#/components/schemas/ResourceRequirements" - description: The type and amount of a resource to assign to a container. The only supported resource is a GPU. + description: The type and amount of a resource to assign to a container. The supported resources are GPUs and Neuron devices. firelensConfiguration: $ref: "#/components/schemas/FirelensConfiguration" description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. @@ -6192,12 +6350,12 @@ components: items: $ref: "#/components/schemas/ResourceRequirement" ResourceRequirement: - description: The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide + description: The type and amount of a resource to assign to a container. The supported resource types are GPUs, Neuron devices, and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide type: object properties: value: $ref: "#/components/schemas/String" - description: The value for the specified resource type. When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition. + description: The value for the specified resource type. When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. You can also specify ALL to allocate all available GPUs on the instance to the container. When the type is NeuronDevice, the value must be ALL. This allocates all available Neuron devices on the instance to the container. Only one container in a task can specify NeuronDevice resources. This resource type is only supported on Managed Instances. When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition. type_: $ref: "#/components/schemas/ResourceType" description: The type of resource to assign to a container. @@ -6209,6 +6367,7 @@ components: enum: - GPU - InferenceAccelerator + - NeuronDevice FirelensConfiguration: description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide. type: object @@ -6338,7 +6497,7 @@ components: - ENABLED - DISABLED S3FilesVolumeConfiguration: - description: This parameter is specified when you're using an Amazon S3 Files file system for task storage. For more information, see Amazon S3 Files volumes in the Amazon Elastic Container Service Developer Guide. Your task definition must include a Task IAM Role. See IAM role for attaching your file system to AWS compute resources for required permissions. + description: This parameter is specified when you're using an Amazon S3 Files file system for task storage. For more information, see Amazon S3 Files volumes in the Amazon Elastic Container Service Developer Guide. Your task definition must include a Task IAM Role. See IAM role for attaching your file system to Amazon Web Services compute resources for required permissions. type: object properties: fileSystemArn: @@ -6696,6 +6855,7 @@ components: - CONTAINER_RUNTIME - ACCELERATED_COMPUTE - DAEMON + - AGENT_CONNECTIVITY DeregisterTaskDefinitionResponse: type: object properties: @@ -7101,6 +7261,12 @@ components: registeredBy: $ref: "#/components/schemas/String" description: The principal that registered the daemon task definition. + pidMode: + $ref: "#/components/schemas/DaemonPidMode" + description: 'The PID namespace mode for the daemon. The valid values are none and shared. The default is none. If none is specified or no value is provided, the daemon runs with its own PID namespace, isolated from other tasks. If shared is specified, the daemon joins the host PID namespace, making it accessible to non-daemon tasks that use pidMode: "host" or other daemons that use pidMode: "shared".' + ipcMode: + $ref: "#/components/schemas/DaemonIpcMode" + description: 'The IPC namespace mode for the daemon. The valid values are none and shared. The default is none. If none is specified or no value is provided, the daemon runs with its own IPC namespace, isolated from other tasks. If shared is specified, the daemon joins the host IPC namespace, making it accessible to non-daemon tasks that use ipcMode: "host" or other daemons that use ipcMode: "shared".' DaemonContainerDefinitionList: type: array items: @@ -7234,6 +7400,16 @@ components: - ACTIVE - DELETE_IN_PROGRESS - DELETED + DaemonPidMode: + type: string + enum: + - none + - shared + DaemonIpcMode: + type: string + enum: + - none + - shared ExpressGatewayServiceIncludeList: type: array items: @@ -7303,7 +7479,10 @@ components: description: Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure. lifecycleStage: $ref: "#/components/schemas/ServiceDeploymentLifecycleStage" - description: "The current lifecycle stage of the deployment. Possible values include: RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. SCALE_UP The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point. POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. BAKE_TIME The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted. CLEAN_UP The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage." + description: "The current lifecycle stage of the deployment. Possible values include: RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. SCALE_UP The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point. POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. PRE_PRODUCTION_TRAFFIC_SHIFT Occurs before production traffic shift. For linear and canary deployments, this stage is invoked before every traffic shift step. PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. For linear and canary deployments, this stage is invoked at every traffic shift step. POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. BAKE_TIME The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted. CLEAN_UP The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage." + lifecycleHookDetails: + $ref: "#/components/schemas/DeploymentLifecycleHookDetailList" + description: The details of the lifecycle hooks for the current service deployment. deploymentConfiguration: $ref: "#/components/schemas/DeploymentConfiguration" rollback: @@ -7366,6 +7545,40 @@ components: - POST_PRODUCTION_TRAFFIC_SHIFT - BAKE_TIME - CLEAN_UP + DeploymentLifecycleHookDetailList: + type: array + items: + $ref: "#/components/schemas/DeploymentLifecycleHookDetail" + DeploymentLifecycleHookDetail: + description: The details of a deployment lifecycle hook that is active during a service deployment. You can view lifecycle hook details by calling DescribeServiceDeployments. + type: object + properties: + hookId: + $ref: "#/components/schemas/String" + description: The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment. + targetType: + $ref: "#/components/schemas/DeploymentLifecycleHookTargetType" + description: The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE. + targetArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set. + status: + $ref: "#/components/schemas/DeploymentLifecycleHookStatus" + description: The status of the lifecycle hook. Valid values include AWAITING_ACTION, IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT. + expiresAt: + $ref: "#/components/schemas/Timestamp" + description: The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action. + timeoutAction: + $ref: "#/components/schemas/DeploymentLifecycleHookAction" + description: The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK. + DeploymentLifecycleHookStatus: + type: string + enum: + - AWAITING_ACTION + - IN_PROGRESS + - SUCCEEDED + - FAILED + - TIMED_OUT Rollback: description: Information about the service deployment rollback. type: object @@ -7486,6 +7699,12 @@ components: ecsManagedResources: $ref: "#/components/schemas/ECSManagedResources" description: The resources created and managed by Amazon ECS when you create an Express service for Amazon ECS. + overrides: + $ref: "#/components/schemas/ServiceRevisionOverrides" + description: The effective runtime overrides that Amazon ECS applies to this service revision. This value is present only when Amazon ECS detects a difference between the task definition and the actual runtime configuration. + monitoring: + $ref: "#/components/schemas/MonitoringConfiguration" + description: The optional monitoring configuration for the service, which defines the resolution for the service-level CPUUtilization and MemoryUtilization Amazon CloudWatch metrics. When not specified, Amazon ECS uses the default resolution of 60 seconds. ContainerImages: type: array items: @@ -7856,6 +8075,20 @@ components: - status - updatedAt - logGroupName + ServiceRevisionOverrides: + description: Contains the runtime overrides that Amazon ECS automatically applies to a service revision when the effective runtime configuration differs from the task definition. This value is read-only. + type: object + properties: + runtimePlatform: + $ref: "#/components/schemas/RuntimePlatformOverride" + description: The runtime platform override that Amazon ECS automatically applies to the service revision. You can't set this value. + RuntimePlatformOverride: + description: The runtime platform that Amazon ECS applies to a service revision. This value overrides the runtime platform specified in the task definition. You can't set this value. + type: object + properties: + cpuArchitecture: + $ref: "#/components/schemas/String" + description: "The CPU architecture that tasks in this service revision run on. This value might differ from the architecture declared in the task definition—for example, when Amazon ECS detects an architecture mismatch during an Amazon ECS Express deployment and runs tasks on a different architecture. You can't set this value. Valid values: X86_64 - The x86 64-bit architecture. ARM64 - The 64-bit ARM architecture." ServiceFieldList: type: array items: @@ -8111,6 +8344,9 @@ components: gpuIds: $ref: "#/components/schemas/GpuIds" description: The IDs of each GPU assigned to the container. + neuronDeviceIds: + $ref: "#/components/schemas/NeuronDeviceIds" + description: The IDs of each Neuron device assigned to the container. NetworkBindings: type: array items: @@ -8188,6 +8424,10 @@ components: type: array items: $ref: "#/components/schemas/String" + NeuronDeviceIds: + type: array + items: + $ref: "#/components/schemas/String" TaskOverride: description: The overrides that are associated with a task. type: object @@ -8244,7 +8484,7 @@ components: description: The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name. resourceRequirements: $ref: "#/components/schemas/ResourceRequirements" - description: The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU. + description: The type and amount of a resource to assign to a container, instead of the default value from the task definition. The supported resources are GPUs and Neuron devices. InferenceAcceleratorOverrides: type: array items: @@ -8268,6 +8508,7 @@ components: - ServiceSchedulerInitiated - SpotInterruption - TerminationNotice + - InfrastructureHealth TaskEphemeralStorage: description: The amount of ephemeral storage to allocate for the task. type: object @@ -8705,15 +8946,15 @@ components: items: $ref: "#/components/schemas/PlatformDevice" PlatformDevice: - description: The devices that are available on the container instance. The only supported device type is a GPU. + description: The devices that are available on the container instance. The supported device types are GPUs and Neuron devices. type: object properties: id: $ref: "#/components/schemas/String" - description: The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file. + description: The ID for the GPU or Neuron device on the container instance. For GPUs, the available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file. For Neuron devices, the ID corresponds to the device index (for example, 0 for /dev/neuron0). type_: $ref: "#/components/schemas/PlatformDeviceType" - description: The type of device that's available on the container instance. The only supported value is GPU. + description: The type of device that's available on the container instance. The supported values are GPU and NEURON_DEVICE. required: - id - type_ @@ -8721,6 +8962,7 @@ components: type: string enum: - GPU + - NEURON_DEVICE RegisterContainerInstanceResponse: type: object properties: @@ -9090,7 +9332,7 @@ components: properties: service: $ref: "#/components/schemas/Service" - description: The full description of your service following the update call. + description: The full description of your service following the update call. The response includes a lifecycleHookDetails field, which is an empty array when the service is created or updated. The values are populated when a lifecycle hook executes and are available as part of the service deployment details (DescribeServiceDeployments). UpdateServicePrimaryTaskSetResponse: type: object properties: @@ -9113,6 +9355,57 @@ components: $ref: "#/components/schemas/TaskSet" description: Details about the task set. x-stackQL-resources: + service_deployments: + id: aws.ecs.service_deployments + name: service_deployments + title: service_deployments + methods: + continue_service_deployment: + operation: + $ref: "#/paths/~1ContinueServiceDeployment/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_service_deployments: + operation: + $ref: "#/paths/~1DescribeServiceDeployments/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_service_deployments: + operation: + $ref: "#/paths/~1ListServiceDeployments/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/service_deployments/methods/describe_service_deployments" + - $ref: "#/components/x-stackQL-resources/service_deployments/methods/list_service_deployments" + insert: [] + update: [] + delete: [] capacity_providers: id: aws.ecs.capacity_providers name: capacity_providers @@ -10088,44 +10381,6 @@ components: insert: [] update: [] delete: [] - service_deployments: - id: aws.ecs.service_deployments - name: service_deployments - title: service_deployments - methods: - describe_service_deployments: - operation: - $ref: "#/paths/~1DescribeServiceDeployments/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - list_service_deployments: - operation: - $ref: "#/paths/~1ListServiceDeployments/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/service_deployments/methods/describe_service_deployments" - - $ref: "#/components/x-stackQL-resources/service_deployments/methods/list_service_deployments" - insert: [] - update: [] - delete: [] service_revisions: id: aws.ecs.service_revisions name: service_revisions diff --git a/providers/src/aws/v00.00.00000/services/eks.yaml b/providers/src/aws/v00.00.00000/services/eks.yaml index acf5b4e2..c2e0ecfa 100644 --- a/providers/src/aws/v00.00.00000/services/eks.yaml +++ b/providers/src/aws/v00.00.00000/services/eks.yaml @@ -17,6 +17,39 @@ servers: description: AWS region description: Regional endpoint for eks paths: + /clusters/{name}/certificate-authorities/{certificate_authority_id}/activate: + post: + operationId: ActivateCertificateAuthority + description: Activates a successor certificate authority (CA) as the signing certificate authority for your cluster, completing a CA rotation. When you activate a successor CA, Amazon EKS promotes it to be the cluster's signer (its signingStatus becomes IN_USE) and the outgoing CA is retired (NOT_USED). The outgoing CA remains in the cluster's trust bundle but no longer signs certificates. The successor CA you activate must already be present on the cluster and fully distributed (its distributionStatus must be COMPLETE). This is an asynchronous operation that returns an update object you can track with DescribeUpdate . Before you activate the successor CA, make sure the worker nodes you manage and your external clients have been updated to trust it, so they maintain connectivity to the API server after activation. For a limited period after activation, CA rollback is available to revert to the outgoing CA if needed. If you don't activate the successor CA yourself, Amazon EKS activates it automatically as the expiration deadline approaches. For more information, see Rotate the Amazon EKS cluster certificate authority in the Amazon EKS User Guide. + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of your cluster. + - name: certificate_authority_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The ID of the certificate authority to activate as the cluster's signing certificate authority. This certificate authority must already exist on the cluster and have a distributionStatus of COMPLETE. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientRequestToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivateCertificateAuthorityResponse" /clusters/{name}/access-entries/{principal_arn}/access-policies: post: operationId: AssociateAccessPolicy @@ -154,6 +187,39 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateIdentityProviderConfigResponse" + /clusters/{name}/updates/{update_id}/cancel-update: + post: + operationId: CancelUpdate + description: Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back. A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails. + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of the Amazon EKS cluster associated with the update. + - name: update_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The ID of the update to cancel. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientRequestToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelUpdateResponse" /clusters/{name}/access-entries: post: operationId: CreateAccessEntry @@ -375,6 +441,62 @@ paths: application/json: schema: $ref: "#/components/schemas/ListCapabilitiesResponse" + /clusters/{name}/certificate-authorities: + post: + operationId: CreateCertificateAuthority + description: "Appends a successor certificate authority (CA) to your cluster, beginning the CA rotation process. A cluster certificate authority is the root of trust for your cluster's control plane. It signs the certificates that secure communication between the Kubernetes API server and its clients, and its public certificate is distributed to your cluster's trust bundle so that worker nodes and clients can verify the API server's identity. Each cluster can have at most two certificate authorities at a time: the outgoing CA that's currently signing (its signingStatus is IN_USE) and one successor CA (signingStatus of NOT_USED) that you can later activate to complete the rotation. Appending a successor CA adds its public certificate to the cluster's trust bundle so that the cluster trusts both CAs simultaneously (the dual trust period), but it doesn't begin signing certificates. Amazon EKS then distributes the successor CA to the Amazon Web Services managed components in your cluster; you can track this through the CA's distributionStatus. The successor CA can't be activated until its distributionStatus is COMPLETE. To activate it as the cluster's signer, use ActivateCertificateAuthority . This is an asynchronous operation that returns an update object. If you don't append a successor CA yourself, Amazon EKS appends one automatically before the outgoing CA approaches expiration. For more information, see Rotate the Amazon EKS cluster certificate authority in the Amazon EKS User Guide." + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of your cluster. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientRequestToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCertificateAuthorityResponse" + get: + operationId: ListCertificateAuthorities + description: "Lists the certificate authorities (CAs) for your cluster. A cluster has at most two certificate authorities: the outgoing CA that's currently signing and, during a rotation, one successor CA." + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of your cluster. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/CertificateAuthorityMaxResults" + description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you don't specify a value, the default is 100 results. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListCertificateAuthoritiesResponse" /clusters: post: operationId: CreateCluster @@ -425,6 +547,12 @@ paths: $ref: "#/components/schemas/BoxedBoolean" controlPlaneScalingConfig: $ref: "#/components/schemas/ControlPlaneScalingConfig" + kubeApiServerConfig: + $ref: "#/components/schemas/KubeApiServerConfigRequest" + kubeSchedulerConfig: + $ref: "#/components/schemas/KubeSchedulerConfigRequest" + kubeControllerManagerConfig: + $ref: "#/components/schemas/KubeControllerManagerConfigRequest" required: - name - roleArn @@ -1002,6 +1130,59 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateCapabilityResponse" + /clusters/{name}/certificate-authorities/{certificate_authority_id}: + delete: + operationId: DeleteCertificateAuthority + description: Deletes a certificate authority (CA) from your cluster. Deleting a certificate authority removes its public certificate from the cluster's trust bundle. You can't delete the certificate authority that's currently signing certificates for the cluster (its signingStatus is IN_USE) — to remove the outgoing CA, first activate the successor CA with ActivateCertificateAuthority . Amazon EKS also protects a successor CA from deletion in certain cases to keep a valid rotation path — for example, a successor that Amazon EKS appended can't be deleted while it's the only successor on the cluster. This is an asynchronous operation that returns an update object. + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of your cluster. + - name: certificate_authority_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The ID of the certificate authority to delete. You can't delete the certificate authority that's currently signing certificates for the cluster. + - name: clientRequestToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteCertificateAuthorityResponse" + get: + operationId: DescribeCertificateAuthority + description: Returns detailed information about a certificate authority (CA) in your cluster, including its validity period, signing and distribution status, provenance, scheduled auto-activation events, and public certificate data. + parameters: + - name: name + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The name of your cluster. + - name: certificate_authority_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The ID of the certificate authority to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeCertificateAuthorityResponse" /clusters/{name}: delete: operationId: DeleteCluster @@ -1855,6 +2036,8 @@ paths: $ref: "#/components/schemas/String" force: $ref: "#/components/schemas/Boolean" + rollbackConfig: + $ref: "#/components/schemas/RollbackConfig" required: - version responses: @@ -1979,6 +2162,12 @@ paths: $ref: "#/components/schemas/BoxedBoolean" controlPlaneScalingConfig: $ref: "#/components/schemas/ControlPlaneScalingConfig" + kubeApiServerConfig: + $ref: "#/components/schemas/KubeApiServerConfigRequest" + kubeSchedulerConfig: + $ref: "#/components/schemas/KubeSchedulerConfigRequest" + kubeControllerManagerConfig: + $ref: "#/components/schemas/KubeControllerManagerConfigRequest" responses: "200": description: Success @@ -2119,82 +2308,15 @@ components: schemas: String: type: string - AccessScope: - description: The scope of an AccessPolicy that's associated to an AccessEntry. - type: object - properties: - type_: - $ref: "#/components/schemas/AccessScopeType" - description: The scope type of an access policy. - namespaces: - $ref: "#/components/schemas/StringList" - description: A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type. - AccessScopeType: - type: string - enum: - - cluster - - namespace - StringList: - type: array - items: - $ref: "#/components/schemas/String" - AssociateAccessPolicyResponse: - type: object - properties: - clusterName: - $ref: "#/components/schemas/String" - description: The name of your cluster. - principalArn: - $ref: "#/components/schemas/String" - description: The ARN of the IAM principal for the AccessEntry. - associatedAccessPolicy: - $ref: "#/components/schemas/AssociatedAccessPolicy" - description: The AccessPolicy and scope associated to the AccessEntry. - AssociatedAccessPolicy: - description: An access policy association. - type: object - properties: - policyArn: - $ref: "#/components/schemas/String" - description: The ARN of the AccessPolicy. - accessScope: - $ref: "#/components/schemas/AccessScope" - description: The scope of the access policy. - associatedAt: - $ref: "#/components/schemas/Timestamp" - description: The date and time the AccessPolicy was associated with an AccessEntry. - modifiedAt: - $ref: "#/components/schemas/Timestamp" - description: The Unix epoch timestamp for the last modification to the object. - Timestamp: - type: string - format: date-time - EncryptionConfigList: - type: array - items: - $ref: "#/components/schemas/EncryptionConfig" - EncryptionConfig: - description: The encryption configuration for the cluster. - type: object - properties: - resources: - $ref: "#/components/schemas/StringList" - description: Specifies the resources to be encrypted. The only supported value is secrets. - provider: - $ref: "#/components/schemas/Provider" - description: Key Management Service (KMS) key. Either the ARN or the alias can be used. - Provider: - description: Identifies the Key Management Service (KMS) key used to encrypt the secrets. - type: object - properties: - keyArn: - $ref: "#/components/schemas/String" - description: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide. - AssociateEncryptionConfigResponse: + ActivateCertificateAuthorityResponse: type: object properties: update: $ref: "#/components/schemas/Update" + description: An object representing the asynchronous update that promotes the certificate authority to be the cluster's signer. + certificateAuthority: + $ref: "#/components/schemas/CertificateAuthoritySummary" + description: Summary information about the certificate authority that is being activated. Update: description: An object representing an asynchronous update. type: object @@ -2217,6 +2339,9 @@ components: errors: $ref: "#/components/schemas/ErrorDetails" description: Any errors associated with a Failed update. + cancellation: + $ref: "#/components/schemas/Cancellation" + description: The latest cancellation information for the update. This field is present only if any cancellation is attempted for the update. UpdateStatus: type: string enum: @@ -2242,8 +2367,13 @@ components: - AutoModeUpdate - RemoteNetworkConfigUpdate - DeletionProtectionUpdate + - CapabilityUpdate - ControlPlaneScalingConfigUpdate - VendedLogsUpdate + - ControlPlaneEgressUpdate + - VersionRollback + - ControlPlaneComponentConfigUpdate + - CertificateAuthorityUpdate UpdateParams: type: array items: @@ -2299,6 +2429,10 @@ components: - RemoteNetworkConfig - DeletionProtection - NodeRepairConfig + - RoleArn + - RoleMappingsToAddOrUpdate + - RoleMappingsToRemove + - NetworkAccess - VendedLogs - UpdatedTier - PreviousTier @@ -2307,6 +2441,17 @@ components: - WarmPoolMinSize - WarmPoolState - WarmPoolReuseOnScaleIn + - ControlPlaneEgressMode + - KubeApiServerConfig + - KubeSchedulerConfig + - KubeControllerManagerConfig + - ActiveCertificateAuthority + - TrustedCertificateAuthorities + - CertificateAuthorityId + - SigningStatus + Timestamp: + type: string + format: date-time ErrorDetails: type: array items: @@ -2344,6 +2489,143 @@ components: - AdmissionRequestDenied - UnsupportedAddonModification - K8sResourceNotFound + StringList: + type: array + items: + $ref: "#/components/schemas/String" + Cancellation: + description: Contains information about the latest cancellation of an update to an Amazon EKS cluster. + type: object + properties: + status: + $ref: "#/components/schemas/CancellationStatus" + description: The current status of the cancellation. Valid values are InProgress, Failed, and Successful. + reason: + $ref: "#/components/schemas/String" + description: A message providing additional details about the cancellation, such as the reason for the cancellation or failure details. + CancellationStatus: + type: string + enum: + - InProgress + - Failed + - Successful + CertificateAuthoritySummary: + description: Summary information about a certificate authority (CA) for an Amazon EKS cluster, returned by ListCertificateAuthorities and the certificate-authority write operations. + type: object + properties: + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the certificate authority. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for when the certificate authority was created. + createdBy: + $ref: "#/components/schemas/CertificateAuthorityCreatedBy" + description: The entity that created the certificate authority, either CUSTOMER or EKS. + activatedAt: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for when the certificate authority was last activated. This value is absent if the certificate authority has never been activated. + activatedBy: + $ref: "#/components/schemas/CertificateAuthorityActivatedBy" + description: The entity that most recently activated the certificate authority, either CUSTOMER or EKS. + signingStatus: + $ref: "#/components/schemas/CertificateAuthoritySigningStatus" + description: "The signing status of the certificate authority: IN_USE, ACTIVATING, or NOT_USED." + distributionStatus: + $ref: "#/components/schemas/CertificateAuthorityDistributionStatus" + description: "The distribution status of the certificate authority: IN_PROGRESS, COMPLETE, FAILED, or DELETING." + CertificateAuthorityCreatedBy: + type: string + enum: + - EKS + - CUSTOMER + CertificateAuthorityActivatedBy: + type: string + enum: + - EKS + - CUSTOMER + CertificateAuthoritySigningStatus: + type: string + enum: + - NOT_USED + - ACTIVATING + - IN_USE + CertificateAuthorityDistributionStatus: + type: string + enum: + - IN_PROGRESS + - COMPLETE + - FAILED + - DELETING + AccessScope: + description: The scope of an AccessPolicy that's associated to an AccessEntry. + type: object + properties: + type_: + $ref: "#/components/schemas/AccessScopeType" + description: The scope type of an access policy. + namespaces: + $ref: "#/components/schemas/StringList" + description: A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type. + AccessScopeType: + type: string + enum: + - cluster + - namespace + AssociateAccessPolicyResponse: + type: object + properties: + clusterName: + $ref: "#/components/schemas/String" + description: The name of your cluster. + principalArn: + $ref: "#/components/schemas/String" + description: The ARN of the IAM principal for the AccessEntry. + associatedAccessPolicy: + $ref: "#/components/schemas/AssociatedAccessPolicy" + description: The AccessPolicy and scope associated to the AccessEntry. + AssociatedAccessPolicy: + description: An access policy association. + type: object + properties: + policyArn: + $ref: "#/components/schemas/String" + description: The ARN of the AccessPolicy. + accessScope: + $ref: "#/components/schemas/AccessScope" + description: The scope of the access policy. + associatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time the AccessPolicy was associated with an AccessEntry. + modifiedAt: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp for the last modification to the object. + EncryptionConfigList: + type: array + items: + $ref: "#/components/schemas/EncryptionConfig" + EncryptionConfig: + description: The encryption configuration for the cluster. + type: object + properties: + resources: + $ref: "#/components/schemas/StringList" + description: Specifies the resources to be encrypted. The only supported value is secrets. + provider: + $ref: "#/components/schemas/Provider" + description: Key Management Service (KMS) key. Either the ARN or the alias can be used. + Provider: + description: Identifies the Key Management Service (KMS) key used to encrypt the secrets. + type: object + properties: + keyArn: + $ref: "#/components/schemas/String" + description: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide. + AssociateEncryptionConfigResponse: + type: object + properties: + update: + $ref: "#/components/schemas/Update" OidcIdentityProviderConfigRequest: description: An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OIDC identity provider in the Amazon EKS User Guide. type: object @@ -2390,6 +2672,12 @@ components: type: object properties: {} description: The tags for the resource. + CancelUpdateResponse: + type: object + properties: + update: + $ref: "#/components/schemas/Update" + description: The full description of the specified update. CreateAccessEntryResponse: type: object properties: @@ -2823,6 +3111,15 @@ components: enum: - AccessDenied - ClusterUnreachable + CreateCertificateAuthorityResponse: + type: object + properties: + update: + $ref: "#/components/schemas/Update" + description: An object representing the asynchronous update that adds the certificate authority to the cluster's trust bundle. + certificateAuthority: + $ref: "#/components/schemas/CertificateAuthoritySummary" + description: Summary information about the certificate authority that was created, including its ID and initial signing and distribution status. VpcConfigRequest: description: An object representing the VPC configuration to use for an Amazon EKS cluster. type: object @@ -2842,8 +3139,17 @@ components: publicAccessCidrs: $ref: "#/components/schemas/StringList" description: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack `IPv6` clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide . Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024. + controlPlaneEgressMode: + $ref: "#/components/schemas/ControlPlaneEgressModeType" + description: Specifies the control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane and you don't need to configure NAT gateways or other routing infrastructure for control plane traffic. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets. You are responsible for ensuring that the control plane can reach required endpoints such as webhook servers and OIDC providers. The default value is AWS_MANAGED. Once set to CUSTOMER_ROUTED, this setting cannot be changed back to AWS_MANAGED on the same cluster. Learn more about control plane egress routing in the Amazon EKS User Guide. BoxedBoolean: type: boolean + ControlPlaneEgressModeType: + type: string + enum: + - AWS_MANAGED + - CUSTOMER_ROUTED + - CUSTOMER_ISOLATED KubernetesNetworkConfigRequest: description: The Kubernetes network configuration for the cluster. type: object @@ -2911,10 +3217,16 @@ components: description: The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. Only a single Outpost ARN is supported. controlPlaneInstanceType: $ref: "#/components/schemas/String" - description: The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes that your cluster will have. For more information, see Capacity considerations in the Amazon EKS User Guide. The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS. + description: The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all control plane instances and cannot be changed after cluster creation. For more information, see Capacity considerations in the Amazon EKS User Guide. controlPlanePlacement: $ref: "#/components/schemas/ControlPlanePlacementRequest" description: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. + etcdInstanceType: + $ref: "#/components/schemas/String" + description: The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all etcd instances and cannot be changed after cluster creation. + etcdPlacement: + $ref: "#/components/schemas/EtcdPlacementRequest" + description: An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. required: - outpostArns - controlPlaneInstanceType @@ -2925,6 +3237,21 @@ components: groupName: $ref: "#/components/schemas/String" description: The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation. + spreadLevel: + $ref: "#/components/schemas/SpreadLevel" + description: Optional parameter to specify the placement group spread level for control plane instances. If not provided, Amazon EKS will deploy control plane instances without a placement group. + SpreadLevel: + type: string + enum: + - host + - rack + EtcdPlacementRequest: + description: The placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. + type: object + properties: + spreadLevel: + $ref: "#/components/schemas/SpreadLevel" + description: Optional parameter to specify the placement group spread level for etcd instances. If not provided, Amazon EKS will deploy etcd instances without a placement group. CreateAccessConfigRequest: description: The access configuration information for the cluster. type: object @@ -3016,24 +3343,115 @@ components: description: Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide. type: object properties: - enabled: - $ref: "#/components/schemas/BoxedBoolean" - description: Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. - ControlPlaneScalingConfig: - description: The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. + enabled: + $ref: "#/components/schemas/BoxedBoolean" + description: Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. + ControlPlaneScalingConfig: + description: The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. + type: object + properties: + tier: + $ref: "#/components/schemas/ProvisionedControlPlaneTier" + description: The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. + ProvisionedControlPlaneTier: + type: string + enum: + - standard + - tier-xl + - tier-2xl + - tier-4xl + - tier-8xl + KubeApiServerConfigRequest: + description: The configuration for the Kubernetes API server on an Amazon EKS cluster. + type: object + properties: + eventTtl: + $ref: "#/components/schemas/String" + description: The duration that Kubernetes events are retained. Valid values are single-unit durations such as 30m or 1h. + serviceNodePortRange: + $ref: "#/components/schemas/ServiceNodePortRange" + description: The port range for NodePort services. + ServiceNodePortRange: + description: The port range for Kubernetes NodePort services. + type: object + properties: + minPort: + $ref: "#/components/schemas/Integer" + description: The minimum port number in the range. + maxPort: + $ref: "#/components/schemas/Integer" + description: The maximum port number in the range. + Integer: + type: integer + KubeSchedulerConfigRequest: + description: The configuration for the Kubernetes scheduler on an Amazon EKS cluster. + type: object + properties: + nodeResourcesFit: + $ref: "#/components/schemas/NodeResourcesFitConfig" + description: The node resource fit scoring configuration for the scheduler. + NodeResourcesFitConfig: + description: The NodeResourcesFit plugin configuration for the Kubernetes scheduler. + type: object + properties: + scoringStrategy: + $ref: "#/components/schemas/ScoringStrategy" + description: The scoring strategy used to rank nodes during scheduling. + ScoringStrategy: + description: The scoring strategy configuration for the NodeResourcesFit scheduler plugin. + type: object + properties: + type_: + $ref: "#/components/schemas/ScoringStrategyType" + description: The scoring strategy type. Valid values are LeastAllocated or MostAllocated. + resources: + $ref: "#/components/schemas/ResourceWeightList" + description: The resource weights used for scoring nodes. + ScoringStrategyType: + description: The scoring strategy type for the NodeResourcesFit scheduler plugin. + type: string + enum: + - LeastAllocated + - MostAllocated + ResourceWeightList: + description: A list of resource weights for the scoring strategy. + type: array + items: + $ref: "#/components/schemas/ResourceWeight" + ResourceWeight: + description: A resource weight entry for the scheduler scoring strategy. + type: object + properties: + name: + $ref: "#/components/schemas/ResourceWeightName" + description: The name of the resource (for example, cpu or memory). + weight: + $ref: "#/components/schemas/ResourceWeightValue" + description: The weight assigned to the resource for scoring. Must be between 1 and 100. + ResourceWeightName: + description: The name of a resource used in the scheduler scoring strategy. + type: string + minLength: 1 + maxLength: 253 + ResourceWeightValue: + description: The weight value for a resource in the scheduler scoring strategy. Must be between 1 and 100. + type: integer + minimum: 1 + maximum: 100 + KubeControllerManagerConfigRequest: + description: The configuration for the Kubernetes controller manager on an Amazon EKS cluster. + type: object + properties: + horizontalPodAutoscalerControllerConfig: + $ref: "#/components/schemas/HorizontalPodAutoscalerControllerConfigRequest" + description: The horizontal pod autoscaler controller configuration. + HorizontalPodAutoscalerControllerConfigRequest: + description: The horizontal pod autoscaler controller configuration for the Kubernetes controller manager. type: object properties: - tier: - $ref: "#/components/schemas/ProvisionedControlPlaneTier" - description: The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. - ProvisionedControlPlaneTier: - type: string - enum: - - standard - - tier-xl - - tier-2xl - - tier-4xl - - tier-8xl + horizontalPodAutoscalerSyncPeriod: + $ref: "#/components/schemas/String" + description: The interval between each sync of the horizontal pod autoscaler. Valid values are single-unit durations such as 15s or 1m. CreateClusterResponse: type: object properties: @@ -3129,6 +3547,15 @@ components: controlPlaneScalingConfig: $ref: "#/components/schemas/ControlPlaneScalingConfig" description: The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. + kubeApiServerConfig: + $ref: "#/components/schemas/KubeApiServerConfigResponse" + description: The Kubernetes API server configuration for the cluster. + kubeSchedulerConfig: + $ref: "#/components/schemas/KubeSchedulerConfigResponse" + description: The Kubernetes scheduler configuration for the cluster. + kubeControllerManagerConfig: + $ref: "#/components/schemas/KubeControllerManagerConfigResponse" + description: The Kubernetes controller manager configuration for the cluster. VpcConfigResponse: description: An object representing an Amazon EKS cluster VPC configuration response. type: object @@ -3154,6 +3581,9 @@ components: publicAccessCidrs: $ref: "#/components/schemas/StringList" description: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack `IPv6` clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide . Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024. + controlPlaneEgressMode: + $ref: "#/components/schemas/ControlPlaneEgressModeType" + description: The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets. Learn more about control plane egress routing in the Amazon EKS User Guide. Boolean: type: boolean KubernetesNetworkConfigResponse: @@ -3202,6 +3632,19 @@ components: data: $ref: "#/components/schemas/String" description: The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster. + active: + $ref: "#/components/schemas/ActiveCertificateAuthority" + description: An object identifying the certificate authority that is currently signing certificates for the cluster. + ActiveCertificateAuthority: + description: Identifies the certificate authority that is currently signing certificates for the cluster. + type: object + properties: + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the certificate authority that is currently signing certificates for the cluster. + activatedBy: + $ref: "#/components/schemas/CertificateAuthorityActivatedBy" + description: The entity that activated the current signing certificate authority, either CUSTOMER or EKS. ConnectorConfigResponse: description: The full description of your connected cluster. type: object @@ -3276,10 +3719,16 @@ components: description: The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts. controlPlaneInstanceType: $ref: "#/components/schemas/String" - description: The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances. + description: The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances. controlPlanePlacement: $ref: "#/components/schemas/ControlPlanePlacementResponse" description: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. + etcdInstanceType: + $ref: "#/components/schemas/String" + description: The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances. + etcdPlacement: + $ref: "#/components/schemas/EtcdPlacementResponse" + description: An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. required: - outpostArns - controlPlaneInstanceType @@ -3290,6 +3739,16 @@ components: groupName: $ref: "#/components/schemas/String" description: The name of the placement group for the Kubernetes control plane instances. + spreadLevel: + $ref: "#/components/schemas/SpreadLevel" + description: The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts. + EtcdPlacementResponse: + description: The placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide. + type: object + properties: + spreadLevel: + $ref: "#/components/schemas/SpreadLevel" + description: The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts. AccessConfigResponse: description: The access configuration for the cluster. type: object @@ -3344,6 +3803,37 @@ components: blockStorage: $ref: "#/components/schemas/BlockStorage" description: Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. + KubeApiServerConfigResponse: + description: The Kubernetes API server configuration for an Amazon EKS cluster. + type: object + properties: + eventTtl: + $ref: "#/components/schemas/String" + description: The duration that Kubernetes events are retained. + serviceNodePortRange: + $ref: "#/components/schemas/ServiceNodePortRange" + description: The port range for NodePort services. + KubeSchedulerConfigResponse: + description: The Kubernetes scheduler configuration for an Amazon EKS cluster. + type: object + properties: + nodeResourcesFit: + $ref: "#/components/schemas/NodeResourcesFitConfig" + description: The node resource fit scoring configuration for the scheduler. + KubeControllerManagerConfigResponse: + description: The Kubernetes controller manager configuration for an Amazon EKS cluster. + type: object + properties: + horizontalPodAutoscalerControllerConfig: + $ref: "#/components/schemas/HorizontalPodAutoscalerControllerConfigResponse" + description: The horizontal pod autoscaler controller configuration. + HorizontalPodAutoscalerControllerConfigResponse: + description: The horizontal pod autoscaler controller configuration for the Kubernetes controller manager. + type: object + properties: + horizontalPodAutoscalerSyncPeriod: + $ref: "#/components/schemas/String" + description: The interval between each sync of the horizontal pod autoscaler. EksAnywhereSubscriptionName: type: string minLength: 1 @@ -3359,8 +3849,6 @@ components: unit: $ref: "#/components/schemas/EksAnywhereSubscriptionTermUnit" description: The term unit of the subscription. Valid value is MONTHS. - Integer: - type: integer EksAnywhereSubscriptionTermUnit: type: string enum: @@ -3983,6 +4471,15 @@ components: capability: $ref: "#/components/schemas/Capability" description: An object containing information about the deleted capability, including its final status and configuration. + DeleteCertificateAuthorityResponse: + type: object + properties: + update: + $ref: "#/components/schemas/Update" + description: An object representing the asynchronous update that removes the certificate authority from the cluster's trust bundle. + certificateAuthority: + $ref: "#/components/schemas/CertificateAuthoritySummary" + description: Summary information about the certificate authority that is being deleted. DeleteClusterResponse: type: object properties: @@ -4149,6 +4646,69 @@ components: capability: $ref: "#/components/schemas/Capability" description: An object containing detailed information about the capability, including its name, ARN, type, status, version, configuration, health status, and timestamps for when it was created and last modified. + DescribeCertificateAuthorityResponse: + type: object + properties: + certificateAuthority: + $ref: "#/components/schemas/CertificateAuthority" + description: An object containing detailed information about the certificate authority. + CertificateAuthority: + description: An object representing a certificate authority (CA) for an Amazon EKS cluster. + type: object + properties: + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the certificate authority. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for when the certificate authority was created. + createdBy: + $ref: "#/components/schemas/CertificateAuthorityCreatedBy" + description: The entity that created the certificate authority. Certificate authorities that you create are CUSTOMER; those that Amazon EKS provisions on your behalf, such as a cluster's initial certificate authority, are EKS. + activatedAt: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for when the certificate authority was last activated as the cluster's signer. This value is absent if the certificate authority has never been activated. + activatedBy: + $ref: "#/components/schemas/CertificateAuthorityActivatedBy" + description: The entity that most recently activated the certificate authority. A value of EKS indicates that Amazon EKS activated it automatically; CUSTOMER indicates that you activated it. + signingStatus: + $ref: "#/components/schemas/CertificateAuthoritySigningStatus" + description: The signing status of the certificate authority. IN_USE means the certificate authority is currently signing certificates for the cluster, ACTIVATING means it's being promoted to the signer, and NOT_USED means it's trusted by the cluster (for example, a successor CA during a rotation, or a retired outgoing CA) but isn't the signer. + distributionStatus: + $ref: "#/components/schemas/CertificateAuthorityDistributionStatus" + description: The distribution status of the certificate authority, which tracks whether Amazon EKS has distributed its trust to the Amazon Web Services managed components in your cluster (the control plane, Amazon EKS Auto Mode instances, and Amazon Web Services Fargate nodes). Valid values are IN_PROGRESS, COMPLETE, FAILED, and DELETING. A successor CA can only be activated after its distribution status is COMPLETE. + validity: + $ref: "#/components/schemas/CertificateAuthorityValidity" + description: The validity period of the certificate authority's certificate. + scheduledEvents: + $ref: "#/components/schemas/CertificateAuthorityScheduledEvents" + description: The scheduled auto-activation events for the certificate authority, computed from its validity period. + rollbackAvailable: + $ref: "#/components/schemas/BoxedBoolean" + description: Indicates whether CA rollback is still available for this certificate authority. After you activate a successor CA, rollback lets you revert to the outgoing CA for a limited period while you finish updating any worker nodes or clients that were missed. + data: + $ref: "#/components/schemas/String" + description: The Base64-encoded public certificate of the certificate authority. + CertificateAuthorityValidity: + description: The validity period of a certificate authority's certificate. + type: object + properties: + notBefore: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for the start of the certificate authority's validity period. + notAfter: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds for the end of the certificate authority's validity period. + CertificateAuthorityScheduledEvents: + description: The scheduled events during which Amazon EKS may automatically activate a certificate authority, computed from its validity period. These events help ensure that a cluster's signing certificate authority is rotated before its certificate expires. + type: object + properties: + firstAutoActivation: + $ref: "#/components/schemas/Timestamp" + description: The earliest Unix epoch timestamp in seconds at which Amazon EKS may automatically activate this certificate authority. + finalAutoActivation: + $ref: "#/components/schemas/Timestamp" + description: The Unix epoch timestamp in seconds by which Amazon EKS will automatically activate this certificate authority if you haven't already activated it. DescribeClusterResponse: type: object properties: @@ -4218,6 +4778,179 @@ components: kubernetesPatchVersion: $ref: "#/components/schemas/String" description: The patch version of Kubernetes for this cluster version. + controlPlaneScalingTiers: + $ref: "#/components/schemas/ControlPlaneScalingTierList" + description: The available provisioned control plane scaling tiers and their capabilities for this Kubernetes version. + controlPlaneComponentConfig: + $ref: "#/components/schemas/ControlPlaneConfigInfo" + description: The default control plane component configuration and constraints for this Kubernetes version. + ControlPlaneScalingTierList: + description: A list of available provisioned control plane scaling tiers. + type: array + items: + $ref: "#/components/schemas/ControlPlaneScalingTierInfo" + ControlPlaneScalingTierInfo: + description: Information about a provisioned control plane scaling tier. + type: object + properties: + tierName: + $ref: "#/components/schemas/String" + description: The name of the scaling tier. + apiRequestConcurrency: + $ref: "#/components/schemas/BoxedInteger" + description: The maximum API request concurrency supported by this tier. + podSchedulingRatePerSecond: + $ref: "#/components/schemas/BoxedInteger" + description: The maximum pod scheduling rate per second supported by this tier. + clusterDatabaseSizeGb: + $ref: "#/components/schemas/BoxedInteger" + description: The maximum cluster database size in GB supported by this tier. + controlPlaneComponentConfigOverrides: + $ref: "#/components/schemas/ControlPlaneConfigInfo" + description: The control plane component configuration overrides specific to this scaling tier. + ControlPlaneConfigInfo: + description: The control plane component configuration defaults and constraints. + type: object + properties: + kubeApiServerConfig: + $ref: "#/components/schemas/KubeApiServerVersionConfig" + description: The Kubernetes API server configuration defaults and constraints. + kubeSchedulerConfig: + $ref: "#/components/schemas/KubeSchedulerVersionConfig" + description: The Kubernetes scheduler configuration defaults and constraints. + kubeControllerManagerConfig: + $ref: "#/components/schemas/KubeControllerManagerVersionConfig" + description: The Kubernetes controller manager configuration defaults and constraints. + KubeApiServerVersionConfig: + description: The Kubernetes API server version-specific configuration defaults and constraints. + type: object + properties: + eventTtl: + $ref: "#/components/schemas/DurationParameterConfig" + description: The event TTL configuration with default value and constraints. + serviceNodePortRange: + $ref: "#/components/schemas/PortRangeParameterConfig" + description: The service node port range configuration with default value and constraints. + DurationParameterConfig: + description: A duration parameter configuration with default value and constraints. + type: object + properties: + defaultValue: + $ref: "#/components/schemas/String" + description: The default value for the duration parameter. + constraints: + $ref: "#/components/schemas/DurationConstraints" + description: The constraints for the duration parameter. + DurationConstraints: + description: Constraints for a duration parameter. + type: object + properties: + min: + $ref: "#/components/schemas/String" + description: The minimum allowed duration value. + max: + $ref: "#/components/schemas/String" + description: The maximum allowed duration value. + PortRangeParameterConfig: + description: A port range parameter configuration with default value and constraints. + type: object + properties: + defaultValue: + $ref: "#/components/schemas/ServiceNodePortRange" + description: The default port range value. + constraints: + $ref: "#/components/schemas/PortRangeConstraints" + description: The constraints for the port range parameter. + PortRangeConstraints: + description: Constraints for a port range parameter. + type: object + properties: + minPort: + $ref: "#/components/schemas/IntegerRangeConstraint" + description: The constraints for the minimum port value. + maxPort: + $ref: "#/components/schemas/IntegerRangeConstraint" + description: The constraints for the maximum port value. + IntegerRangeConstraint: + description: An integer range constraint specifying minimum and maximum allowed values. + type: object + properties: + min: + $ref: "#/components/schemas/BoxedInteger" + description: The minimum allowed value. + max: + $ref: "#/components/schemas/BoxedInteger" + description: The maximum allowed value. + KubeSchedulerVersionConfig: + description: The Kubernetes scheduler version-specific configuration defaults and constraints. + type: object + properties: + nodeResourcesFit: + $ref: "#/components/schemas/NodeResourcesFitVersionConfig" + description: The NodeResourcesFit configuration with default value and constraints. + NodeResourcesFitVersionConfig: + description: The NodeResourcesFit version configuration with default value and constraints. + type: object + properties: + scoringStrategy: + $ref: "#/components/schemas/ScoringStrategyConfig" + description: The scoring strategy configuration with default value and constraints. + ScoringStrategyConfig: + description: The scoring strategy configuration with default value and constraints. + type: object + properties: + defaultValue: + $ref: "#/components/schemas/ScoringStrategy" + description: The default scoring strategy. + constraints: + $ref: "#/components/schemas/ScoringStrategyConstraints" + description: The constraints for the scoring strategy. + ScoringStrategyConstraints: + description: Constraints for the scoring strategy configuration. + type: object + properties: + scoringStrategy: + $ref: "#/components/schemas/AllowedValuesConstraint" + description: The allowed values for the scoring strategy type. + resources: + $ref: "#/components/schemas/ResourceConstraints" + description: The constraints for resource weights. + AllowedValuesConstraint: + description: A constraint specifying the allowed values for a parameter. + type: object + properties: + allowedValues: + $ref: "#/components/schemas/AllowedValuesList" + description: The list of allowed values. + AllowedValuesList: + description: A list of allowed string values for a parameter constraint. + type: array + items: + $ref: "#/components/schemas/String" + ResourceConstraints: + description: Constraints for resource weight entries. + type: object + properties: + name: + $ref: "#/components/schemas/AllowedValuesConstraint" + description: The allowed values for resource names. + weight: + $ref: "#/components/schemas/IntegerRangeConstraint" + description: The allowed range for resource weight values. + KubeControllerManagerVersionConfig: + description: The Kubernetes controller manager version-specific configuration defaults and constraints. + type: object + properties: + horizontalPodAutoscalerControllerConfig: + $ref: "#/components/schemas/HorizontalPodAutoscalerControllerVersionConfig" + description: The horizontal pod autoscaler controller configuration with default value and constraints. + HorizontalPodAutoscalerControllerVersionConfig: + description: The horizontal pod autoscaler controller version configuration. + type: object + properties: + horizontalPodAutoscalerSyncPeriod: + $ref: "#/components/schemas/DurationParameterConfig" + description: The HPA sync period configuration with default value and constraints. DescribeEksAnywhereSubscriptionResponse: type: object properties: @@ -4356,6 +5089,7 @@ components: enum: - UPGRADE_READINESS - MISCONFIGURATION + - ROLLBACK_READINESS InsightStatus: description: The status of the insight. type: object @@ -4626,6 +5360,23 @@ components: modifiedAt: $ref: "#/components/schemas/Timestamp" description: The Unix epoch timestamp in seconds for when the capability was last modified. + CertificateAuthorityMaxResults: + type: integer + minimum: 1 + maximum: 100 + ListCertificateAuthoritiesResponse: + type: object + properties: + certificateAuthorities: + $ref: "#/components/schemas/CertificateAuthoritySummaryList" + description: A list of certificate authority summary objects, each containing basic information about a certificate authority, including its ID, signing status, and distribution status. + nextToken: + $ref: "#/components/schemas/String" + description: The nextToken value to include in a future ListCertificateAuthorities request. When the results of a ListCertificateAuthorities request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. + CertificateAuthoritySummaryList: + type: array + items: + $ref: "#/components/schemas/CertificateAuthoritySummary" ListClustersRequestMaxResults: type: integer minimum: 1 @@ -4964,6 +5715,13 @@ components: properties: update: $ref: "#/components/schemas/Update" + RollbackConfig: + description: The rollback configuration for the cluster version rollback. + type: object + properties: + timeoutMinutes: + $ref: "#/components/schemas/BoxedInteger" + description: "The length of time in minutes to wait before cancelling the update. Timeout is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. This value can be between 120 (2 hours) and 10080 (7 days). Default: 720 (12 hours) if not specified." UpdateClusterVersionResponse: type: object properties: @@ -5018,6 +5776,74 @@ components: $ref: "#/components/schemas/PodIdentityAssociation" description: The full description of the association that was updated. x-stackQL-resources: + certificate_authorities: + id: aws.eks.certificate_authorities + name: certificate_authorities + title: certificate_authorities + methods: + activate_certificate_authority: + operation: + $ref: "#/paths/~1clusters~1{name}~1certificate-authorities~1{certificate_authority_id}~1activate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_certificate_authority: + operation: + $ref: "#/paths/~1clusters~1{name}~1certificate-authorities/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_certificate_authorities: + operation: + $ref: "#/paths/~1clusters~1{name}~1certificate-authorities/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.certificateAuthorities + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_certificate_authority: + operation: + $ref: "#/paths/~1clusters~1{name}~1certificate-authorities~1{certificate_authority_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + describe_certificate_authority: + operation: + $ref: "#/paths/~1clusters~1{name}~1certificate-authorities~1{certificate_authority_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.certificateAuthority + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/certificate_authorities/methods/describe_certificate_authority" + - $ref: "#/components/x-stackQL-resources/certificate_authorities/methods/list_certificate_authorities" + insert: + - $ref: "#/components/x-stackQL-resources/certificate_authorities/methods/create_certificate_authority" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/certificate_authorities/methods/delete_certificate_authority" access_policies: id: aws.eks.access_policies name: access_policies @@ -5180,6 +6006,61 @@ components: - $ref: "#/components/x-stackQL-resources/identity_provider_configs/methods/associate_identity_provider_config" - $ref: "#/components/x-stackQL-resources/identity_provider_configs/methods/disassociate_identity_provider_config" delete: [] + updates: + id: aws.eks.updates + name: updates + title: updates + methods: + cancel_update: + operation: + $ref: "#/paths/~1clusters~1{name}~1updates~1{update_id}~1cancel-update/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + describe_update: + operation: + $ref: "#/paths/~1clusters~1{name}~1updates~1{update_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.update + request: + nativeCasing: pascal + list_updates: + operation: + $ref: "#/paths/~1clusters~1{name}~1updates/get" + response: + openAPIDocKey: "200" + mediaType: application/json + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ListUpdatesOutputDisplay" + transform: + type: golang_template_json_v0.3.0 + body: '{{- $lst := index . "updateIds" -}}{{- $tok := index . "nextToken" -}}{"line_items": [{{- if eq (kindOf $lst) "slice" -}}{{- range $i, $v := $lst -}}{{- if $i }},{{ end }}{"update_id": {{ toJson $v }}}{{- end -}}{{- end -}}]{{- if $tok }}, "nextToken": {{ toJson $tok }}{{- end }}}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/updates/methods/describe_update" + - $ref: "#/components/x-stackQL-resources/updates/methods/list_updates" + insert: [] + update: [] + delete: [] access_entries: id: aws.eks.access_entries name: access_entries @@ -5913,50 +6794,6 @@ components: insert: [] update: [] delete: [] - updates: - id: aws.eks.updates - name: updates - title: updates - methods: - describe_update: - operation: - $ref: "#/paths/~1clusters~1{name}~1updates~1{update_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.update - request: - nativeCasing: pascal - list_updates: - operation: - $ref: "#/paths/~1clusters~1{name}~1updates/get" - response: - openAPIDocKey: "200" - mediaType: application/json - overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/ListUpdatesOutputDisplay" - transform: - type: golang_template_json_v0.3.0 - body: '{{- $lst := index . "updateIds" -}}{{- $tok := index . "nextToken" -}}{"line_items": [{{- if eq (kindOf $lst) "slice" -}}{{- range $i, $v := $lst -}}{{- if $i }},{{ end }}{"update_id": {{ toJson $v }}}{{- end -}}{{- end -}}]{{- if $tok }}, "nextToken": {{ toJson $tok }}{{- end }}}' - objectKey: $.line_items - request: - nativeCasing: pascal - config: - pagination: - requestToken: - key: nextToken - location: query - responseToken: - key: $.nextToken - location: body - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/updates/methods/describe_update" - - $ref: "#/components/x-stackQL-resources/updates/methods/list_updates" - insert: [] - update: [] - delete: [] tags: id: aws.eks.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/elasticache.yaml b/providers/src/aws/v00.00.00000/services/elasticache.yaml index 089fbf6b..3bc49b6e 100644 --- a/providers/src/aws/v00.00.00000/services/elasticache.yaml +++ b/providers/src/aws/v00.00.00000/services/elasticache.yaml @@ -1034,7 +1034,7 @@ paths: - name: AtRestEncryptionEnabled in: query required: false - description: "A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using Valkey 7.2 and later, Redis OSS version 3.2.6, or Redis OSS 4.x and later. Default: true when using Valkey, false when using Redis OSS" + description: "A flag that enables encryption at-rest on the replication group when set to true. In some cases, encryption at-rest may be enabled even when this value is false. Use StorageEncryptionType to view the effective encryption state of a cluster. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. Default: true when using Valkey, false when using Redis OSS" schema: $ref: "#/components/schemas/BooleanOptional" - name: KmsKeyId @@ -1091,6 +1091,12 @@ paths: description: The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only. schema: $ref: "#/components/schemas/String" + - name: Durability + in: query + required: false + description: Specifies the durability setting for the replication group. When set to default, the service determines the effective durability based on the engine version, cluster mode, and other parameters. The resolved setting is reflected in the EffectiveDurability property of the replication group. For more information, see Durability. + schema: + $ref: "#/components/schemas/Durability" responses: "200": description: Success @@ -1208,7 +1214,7 @@ paths: - name: NetworkType in: query required: false - description: The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with ipv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6. + description: The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6. schema: $ref: "#/components/schemas/NetworkType" responses: @@ -3794,7 +3800,7 @@ paths: - name: ApplyImmediately in: query required: false - description: "If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false" + description: "If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. However, a pending node-count increase on Memcached clusters cannot be superseded by a request to add fewer nodes. To change a pending node addition, first cancel it by setting NumCacheNodes equal to the current number of nodes in the cluster, then submit the new request. See the NumCacheNodes parameter for details on node scaling behavior. Valid values: true | false Default: false" schema: $ref: "#/components/schemas/Boolean" - name: Engine @@ -4265,6 +4271,12 @@ paths: description: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. schema: $ref: "#/components/schemas/ClusterMode" + - name: Durability + in: query + required: false + description: Specifies the durability setting for the replication group. Use this parameter to change the durability mode of an existing replication group, for example from sync to async or vice versa. For more information, see Durability. + schema: + $ref: "#/components/schemas/Durability" responses: "200": description: Success @@ -5299,13 +5311,16 @@ components: description: "A flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false" AtRestEncryptionEnabled: type: boolean - description: "A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false" + description: "A flag that enables encryption at-rest on the cluster when set to true. In some cases, encryption at-rest may be enabled even when this value is false. Use StorageEncryptionType to view the effective encryption state of a cluster. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. Default: true when using Valkey, false when using Redis OSS" MemberClustersOutpostArns: type: string description: The outpost ARNs of the replication group's member clusters. KmsKeyId: type: string description: The ID of the KMS key used to encrypt the disk in the cluster. + StorageEncryptionType: + type: string + description: Indicates the type of encryption for data stored at rest in the replication group. The value is none if at-rest encryption is not enabled, sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used. ARN: type: string description: The ARN (Amazon Resource Name) of the replication group. @@ -5339,6 +5354,12 @@ components: Engine: type: string description: The engine used in a replication group. The options are valkey, memcached or redis. + Durability: + type: string + description: The durability setting of the replication group. For more information, see Durability. + EffectiveDurability: + type: string + description: The effective durability of the replication group. When Durability is set to default, the service resolves the actual durability based on the engine version, cluster mode, and other parameters. This field reflects the resolved value. For more information, see Configuring Durability. CompleteMigrationOutputDisplay: type: object properties: @@ -5499,6 +5520,9 @@ components: DataTiering: type: string description: Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering. + Durability: + type: string + description: The durability setting of the cluster when the snapshot was taken. When restoring from this snapshot, the cluster uses this durability setting unless overridden in the restore request. For more information, see Durability. CopySnapshotOutputDisplay: type: object properties: @@ -6085,6 +6109,13 @@ components: - enabled - disabled - compatible + Durability: + type: string + enum: + - default + - async + - sync + - disabled CreateReplicationGroupOutputDisplay: type: object properties: @@ -6185,7 +6216,7 @@ components: description: "A flag that enables in-transit encryption when set to true. This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup." AtRestEncryptionEnabled: $ref: "#/components/schemas/BooleanOptional" - description: "A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using Valkey 7.2 and later, Redis OSS version 3.2.6, or Redis OSS 4.x and later. Default: true when using Valkey, false when using Redis OSS" + description: "A flag that enables encryption at-rest on the replication group when set to true. In some cases, encryption at-rest may be enabled even when this value is false. Use StorageEncryptionType to view the effective encryption state of a cluster. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. Default: true when using Valkey, false when using Redis OSS" KmsKeyId: $ref: "#/components/schemas/String" description: The ID of the KMS key used to encrypt the disk in the cluster. @@ -6213,6 +6244,9 @@ components: ServerlessCacheSnapshotName: $ref: "#/components/schemas/String" description: The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only. + Durability: + $ref: "#/components/schemas/Durability" + description: Specifies the durability setting for the replication group. When set to default, the service determines the effective durability based on the engine version, cluster mode, and other parameters. The resolved setting is reflected in the EffectiveDurability property of the replication group. For more information, see Durability. required: - ReplicationGroupId - ReplicationGroupDescription @@ -6288,6 +6322,9 @@ components: KmsKeyId: type: string description: The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache. + StorageEncryptionType: + type: string + description: Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used. SecurityGroupIds: type: string description: The IDs of the EC2 security groups associated with the serverless cache. @@ -6366,7 +6403,7 @@ components: description: The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only. NetworkType: $ref: "#/components/schemas/NetworkType" - description: The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with ipv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6. + description: The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6. required: - ServerlessCacheName - Engine @@ -7914,7 +7951,7 @@ components: description: "The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive" ApplyImmediately: $ref: "#/components/schemas/Boolean" - description: "If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false" + description: "If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. However, a pending node-count increase on Memcached clusters cannot be superseded by a request to add fewer nodes. To change a pending node addition, first cancel it by setting NumCacheNodes equal to the current number of nodes in the cluster, then submit the new request. See the NumCacheNodes parameter for details on node scaling behavior. Valid values: true | false Default: false" Engine: $ref: "#/components/schemas/String" description: The engine type used by the cache cluster. The options are valkey, memcached or redis. @@ -8154,6 +8191,9 @@ components: ClusterMode: $ref: "#/components/schemas/ClusterMode" description: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. + Durability: + $ref: "#/components/schemas/Durability" + description: Specifies the durability setting for the replication group. Use this parameter to change the durability mode of an existing replication group, for example from sync to async or vice versa. For more information, see Durability. required: - ReplicationGroupId NodeGroupsToRemoveList: diff --git a/providers/src/aws/v00.00.00000/services/elbv2.yaml b/providers/src/aws/v00.00.00000/services/elbv2.yaml index 3d3dd0d8..e6e08afd 100644 --- a/providers/src/aws/v00.00.00000/services/elbv2.yaml +++ b/providers/src/aws/v00.00.00000/services/elbv2.yaml @@ -363,7 +363,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreateRule - description: Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, one or more conditions, and up to two optional transforms. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide. + description: Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer or a dual-stack Network Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide or Listener rules in the Network Load Balancers Guide. parameters: - name: ListenerArn in: query @@ -410,7 +410,7 @@ paths: $ref: "#/components/schemas/CreateRuleOutputDisplay" post: operationId: POST_CreateRule - description: Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, one or more conditions, and up to two optional transforms. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide. + description: Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer or a dual-stack Network Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide or Listener rules in the Network Load Balancers Guide. responses: "200": description: Success @@ -3654,12 +3654,12 @@ components: items: $ref: "#/components/schemas/RuleCondition" RuleCondition: - description: "Information about a condition for a rule. Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string. Note that the value for a condition can't be empty. For more information, see Quotas for your Application Load Balancers." + description: "Information about a condition for a rule. Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string. Note that the value for a condition can't be empty. For Network Load Balancer listener rules, the only supported condition is source-ip. Use SourceIpConfig with IpAddressType to match on the IP address type of the source traffic (ipv4 or ipv6). For more information, see Quotas for your Application Load Balancers." type: object properties: Field: $ref: "#/components/schemas/ConditionFieldName" - description: "The field in the HTTP request. The following are the possible values: http-header http-request-method host-header path-pattern query-string source-ip" + description: "The name of the field. The possible values are: http-header – [ALB] Matches on an HTTP header field. http-request-method – [ALB] Matches on the HTTP request method. host-header – [ALB] Matches on the host header. path-pattern – [ALB] Matches on the URL path of the request. query-string – [ALB] Matches on a query string parameter. source-ip – [ALB, NLB] Matches on the source IP address. For ALB, use SourceIpConfig with Values to specify CIDR ranges. For NLB, use SourceIpConfig with IpAddressType to match the IP address type (ipv4 or ipv6)." Values: $ref: "#/components/schemas/ListOfString" description: "The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig. If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 _ - . $ / ~ \" ' @ : + & (using &) * (matches 0 or more characters) ? (matches exactly 1 character)" @@ -3757,12 +3757,20 @@ components: $ref: "#/components/schemas/ListOfString" description: The name of the request method. The maximum length is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. SourceIpConditionConfig: - description: Information about a source IP condition. You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client. + description: Information about a source IP condition. You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client. For Application Load Balancers, use Values to specify CIDR ranges. For Network Load Balancers, use IpAddressType to match on the IP address type of the source traffic. type: object properties: Values: $ref: "#/components/schemas/ListOfString" description: The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use an HTTP header condition. The total number of values must be less than, or equal to five. + IpAddressType: + $ref: "#/components/schemas/SourceIpAddressTypeEnum" + description: "The IP address type for Network Load Balancers. The valid values are: ipv4 – IPv4 addresses only. ipv6 – IPv6 addresses only." + SourceIpAddressTypeEnum: + type: string + enum: + - ipv4 + - ipv6 RulePriority: type: integer minimum: 1 diff --git a/providers/src/aws/v00.00.00000/services/elementalinference.yaml b/providers/src/aws/v00.00.00000/services/elementalinference.yaml index f6084e08..894cfecf 100644 --- a/providers/src/aws/v00.00.00000/services/elementalinference.yaml +++ b/providers/src/aws/v00.00.00000/services/elementalinference.yaml @@ -19,7 +19,7 @@ paths: /v1/feed/{id}/associate: post: operationId: AssociateFeed - description: Associates a resource with the feed. The resource provides the input that Elemental Inference needs needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. + description: "Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed. AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation. Specifically: You can add more outputs to the existing outputs. New outputs will be appended. You can't modify an existing output (for example to change its name). Instead, use UpdateFeed. You can't delete an existing output. Instead, use UpdateFeed. Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed." parameters: - name: id in: path @@ -50,10 +50,40 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateFeedResponse" + /v1/dictionary: + post: + operationId: CreateDictionary + description: Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + language: + $ref: "#/components/schemas/DictionaryLanguage" + entries: + $ref: "#/components/schemas/DictionaryEntriesPayload" + tags: + $ref: "#/components/schemas/TagMap" + required: + - name + - language + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDictionaryResponse" /v1/feed: post: operationId: CreateFeed - description: Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed. + description: "Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs." parameters: [] requestBody: required: true @@ -64,6 +94,8 @@ paths: properties: name: $ref: "#/components/schemas/ResourceName" + accessRoleArn: + $ref: "#/components/schemas/IamRoleArn" outputs: $ref: "#/components/schemas/CreateOutputList" tags: @@ -78,10 +110,75 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateFeedResponse" + /v1/dictionary/{id}: + delete: + operationId: DeleteDictionary + description: Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary to delete. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDictionaryResponse" + get: + operationId: GetDictionary + description: Retrieves information about the specified dictionary. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDictionaryResponse" + patch: + operationId: UpdateDictionary + description: Updates the specified dictionary. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + language: + $ref: "#/components/schemas/DictionaryLanguage" + entries: + $ref: "#/components/schemas/DictionaryEntriesPayload" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDictionaryResponse" /v1/feed/{id}: delete: operationId: DeleteFeed - description: Deletes the specified feed. The feed can be deleted at any time. + description: Deletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide. parameters: - name: id in: path @@ -115,7 +212,7 @@ paths: $ref: "#/components/schemas/GetFeedResponse" put: operationId: UpdateFeed - description: Updates the name and/or outputs in a feed. + description: Updates the name and/or outputs in a feed. UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload. This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify. If you want to patch the array of outputs to make selective additions, use AssociateFeed. parameters: - name: id in: path @@ -132,6 +229,8 @@ paths: properties: name: $ref: "#/components/schemas/ResourceName" + accessRoleArn: + $ref: "#/components/schemas/IamRoleArn" outputs: $ref: "#/components/schemas/UpdateOutputList" required: @@ -147,7 +246,7 @@ paths: /v1/feed/{id}/disassociate: post: operationId: DisassociateFeed - description: Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled. + description: Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED. parameters: - name: id in: path @@ -175,6 +274,48 @@ paths: application/json: schema: $ref: "#/components/schemas/DisassociateFeedResponse" + /v1/dictionary/{id}/entries/export: + get: + operationId: ExportDictionaryEntries + description: Exports the entries from the specified dictionary. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary whose entries you want to export. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ExportDictionaryEntriesResponse" + /v1/dictionaries: + get: + operationId: ListDictionaries + description: Lists the dictionaries in your account. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListDictionariesRequestMaxResultsInteger" + description: "The maximum number of results to return per API request. Valid range: 1 to 100." + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token that identifies the next batch of results to return. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDictionariesResponse" /v1/feeds: get: operationId: ListFeeds @@ -191,7 +332,7 @@ paths: required: false schema: $ref: "#/components/schemas/String" - description: The token that identifies the batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value. + description: The token that identifies the batch of results that you want to see. For example, you submit a ListFeeds request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFeeds request a second time and specify the NextToken value. responses: "200": description: Success @@ -260,6 +401,40 @@ paths: responses: "204": description: Success + /v1/fixtures: + post: + operationId: SearchFixtures + description: "Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window. Each fixture in the response includes a fixtureId that you specify in the clipping output of a feed, so that Elemental Inference maps the event data for that fixture onto the clipping metadata. This operation is paginated: if there are more fixtures than fit in one page, the response includes a nextToken that you pass in a subsequent request." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sport: + $ref: "#/components/schemas/DataSourceSport" + startDate: + $ref: "#/components/schemas/FixtureDate" + endDate: + $ref: "#/components/schemas/FixtureDate" + filters: + $ref: "#/components/schemas/SearchFilterList" + maxResults: + $ref: "#/components/schemas/SearchFixturesRequestMaxResultsInteger" + nextToken: + $ref: "#/components/schemas/String" + required: + - sport + - startDate + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchFixturesResponse" components: parameters: X-Amz-Content-Sha256: @@ -326,7 +501,7 @@ components: description: A name for the output. outputConfig: $ref: "#/components/schemas/OutputConfig" - description: A typed property for an output in a feed. It is used in the CreateFeed and AssociateFeed actions. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. + description: A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. status: $ref: "#/components/schemas/OutputStatus" description: The status to assign to the output. @@ -350,21 +525,126 @@ components: clipping: $ref: "#/components/schemas/ClippingConfig" description: The output config type that applies to the clipping feature. + subtitling: + $ref: "#/components/schemas/SubtitlingConfig" + description: The output config type that applies to the smart subtitling feature. CroppingConfig: description: A type of OutputConfig, used when the output in a feed is for the crop feature. type: object + properties: + templateGroups: + $ref: "#/components/schemas/TemplateGroupList" + description: An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups. + TemplateGroupList: + type: array + items: + $ref: "#/components/schemas/TemplateGroup" + TemplateGroup: + description: A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig. + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + description: A name for the template group. + templateUris: + $ref: "#/components/schemas/TemplateUriList" + description: An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn. + required: + - name + - templateUris + TemplateUriList: + type: array + items: + $ref: "#/components/schemas/S3Uri" + S3Uri: + type: string + minLength: 10 + maxLength: 255 + pattern: s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+ ClippingConfig: description: A type of OutputConfig, used when the output in a feed is for the clip feature. type: object properties: callbackMetadata: $ref: "#/components/schemas/ResourceDescription" - description: The metadata that is the result of the clip request to Elemental Inference. + description: A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example. + dataSourceConfiguration: + $ref: "#/components/schemas/DataSourceConfiguration" + description: The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output. If you omit this parameter, Elemental Inference doesn't map a data source onto this output. ResourceDescription: type: string minLength: 0 maxLength: 1024 pattern: "[\\w \\-\\.',@:;]*" + DataSourceConfiguration: + description: Contains the data source configuration for a clipping output. It identifies the fixture whose event data Elemental Inference maps onto the clipping metadata. It is used in the dataSourceConfiguration property of a ClippingConfig. + type: object + properties: + fixtureId: + $ref: "#/components/schemas/FixtureId" + description: The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing. To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary. + required: + - fixtureId + FixtureId: + type: string + minLength: 1 + maxLength: 128 + SubtitlingConfig: + description: A type of OutputConfig, used when the output in a feed is for the smart subtitling feature. smart subtitling uses automatic speech recognition (ASR) to generate live TTML subtitles from the audio in your source media. + type: object + properties: + language: + $ref: "#/components/schemas/TranscriptionLanguage" + description: "The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por." + aspectRatio: + $ref: "#/components/schemas/AspectRatio" + description: The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths. + dictionary: + $ref: "#/components/schemas/DictionaryId" + description: The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary. + profanityFilter: + $ref: "#/components/schemas/ProfanityFilterMode" + description: "Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript)." + required: + - language + TranscriptionLanguage: + type: string + enum: + - eng + - eng-au + - eng-gb + - eng-us + - fra + - ita + - deu + - spa + - por + AspectRatio: + description: The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout. + type: object + properties: + width: + $ref: "#/components/schemas/Integer" + description: The width component of the aspect ratio (for example, 16 in a 16:9 ratio). + height: + $ref: "#/components/schemas/Integer" + description: The height component of the aspect ratio (for example, 9 in a 16:9 ratio). + required: + - width + - height + Integer: + type: integer + DictionaryId: + type: string + minLength: 1 + maxLength: 19 + pattern: "[a-zA-Z0-9]+" + ProfanityFilterMode: + type: string + enum: + - DISABLED + - CENSOR + - DROP OutputStatus: type: string enum: @@ -377,18 +657,81 @@ components: properties: arn: $ref: "#/components/schemas/FeedArn" - description: The AWS ARN for this association. + description: The ARN of the feed. id: $ref: "#/components/schemas/FeedId" - description: An ID for this response. It is unique in Elemental Inference for this AWS account. + description: The ID of the feed. required: - arn - id FeedArn: type: string + DictionaryLanguage: + type: string + enum: + - eng + - fra + - ita + - deu + - spa + - por + DictionaryEntriesPayload: + type: string + minLength: 0 + maxLength: 40960 TagMap: type: object properties: {} + CreateDictionaryResponse: + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + description: The name that you specified in the request. + arn: + $ref: "#/components/schemas/DictionaryArn" + description: The ARN of the dictionary. + id: + $ref: "#/components/schemas/DictionaryId" + description: A unique ID that Elemental Inference assigns to the dictionary. + language: + $ref: "#/components/schemas/DictionaryLanguage" + description: The language of the dictionary. + status: + $ref: "#/components/schemas/DictionaryStatus" + description: The current status of the dictionary. After creation succeeds, the status will be AVAILABLE. + references: + $ref: "#/components/schemas/FeedReferences" + description: A list of feed IDs that reference this dictionary. + tags: + type: object + properties: {} + description: Any tags that you included when you created the dictionary. + required: + - name + - arn + - id + - language + - status + DictionaryArn: + type: string + DictionaryStatus: + type: string + enum: + - CREATING + - AVAILABLE + - REFERENCED + - DELETING + - DELETED + FeedReferences: + type: array + items: + $ref: "#/components/schemas/FeedId" + IamRoleArn: + type: string + minLength: 32 + maxLength: 255 + pattern: arn:aws[a-z\-]*:iam::[0-9]{12}:role/.+ CreateFeedResponse: type: object properties: @@ -397,22 +740,22 @@ components: description: A unique ARN that Elemental Inference assigns to the feed. name: $ref: "#/components/schemas/ResourceName" - description: The name that you specified. + description: The name that you specified in the request. id: $ref: "#/components/schemas/FeedId" description: A unique ID that Elemental Inference assigns to the feed. dataEndpoints: $ref: "#/components/schemas/StringList" - description: A unique ARN that Elemental Inference assigns to the feed. + description: An array of endpoints for the feed. Typically, there is only one endpoint. The feed receives source media at this endpoint (when the calling application calls PutMedia) and returns the resulting metadata to this endpoint (when the calling application calls GetMetadata). outputs: $ref: "#/components/schemas/GetOutputList" - description: Data endpoints that Elemental Inference assigns to the feed. + description: Repeats the outputs that you specified in the request. status: $ref: "#/components/schemas/FeedStatus" description: The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE. association: $ref: "#/components/schemas/FeedAssociation" - description: The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed. + description: The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed or UpdateFeed. tags: type: object properties: {} @@ -435,15 +778,15 @@ components: items: $ref: "#/components/schemas/GetOutput" GetOutput: - description: Contains configuration information about one output in a feed. It is used in the GetFeed action. + description: Contains configuration information about one output in a feed. It is used in the GetFeed response. type: object properties: name: $ref: "#/components/schemas/ResourceName" - description: The ARN of the output. + description: The name of the output. outputConfig: $ref: "#/components/schemas/OutputConfig" - description: A typed property for an output in a feed. It is used in the GetFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. + description: A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. status: $ref: "#/components/schemas/OutputStatus" description: The status of the output. @@ -452,7 +795,7 @@ components: description: The description of the output. fromAssociation: $ref: "#/components/schemas/Boolean" - description: True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed. + description: True means that the output was originally created in the feed using AssociateFeed. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use UpdateFeed to modify the list of outputs in the feed. required: - name - outputConfig @@ -476,6 +819,22 @@ components: description: The name of the associated resource. required: - associatedResourceName + DeleteDictionaryResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/DictionaryArn" + description: The ARN of the deleted dictionary. + id: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the deleted dictionary. + status: + $ref: "#/components/schemas/DictionaryStatus" + description: The status of the dictionary after deletion. + required: + - arn + - id + - status DeleteFeedResponse: type: object properties: @@ -497,13 +856,50 @@ components: properties: arn: $ref: "#/components/schemas/FeedArn" - description: The ID of the feed where you deleted the associated resource. + description: The ARN of the feed. id: $ref: "#/components/schemas/FeedId" - description: The ARN of the resource that you deleted. + description: The ID of the feed. required: - arn - id + ExportDictionaryEntriesResponse: + type: object + properties: + entries: + $ref: "#/components/schemas/DictionaryEntriesPayload" + description: The dictionary entries payload. + GetDictionaryResponse: + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + description: The name of the dictionary. + arn: + $ref: "#/components/schemas/DictionaryArn" + description: The ARN of the dictionary. + id: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary. + language: + $ref: "#/components/schemas/DictionaryLanguage" + description: The language of the dictionary. + status: + $ref: "#/components/schemas/DictionaryStatus" + description: The current status of the dictionary. + references: + $ref: "#/components/schemas/FeedReferences" + description: A list of feed IDs that reference this dictionary. + tags: + type: object + properties: {} + description: The tags associated with the dictionary. + required: + - name + - arn + - id + - language + - status GetFeedResponse: type: object properties: @@ -512,26 +908,26 @@ components: description: The ARN of the feed. name: $ref: "#/components/schemas/ResourceName" - description: The name of the feed being queried. + description: The name of the feed. id: $ref: "#/components/schemas/FeedId" - description: The ID of the feed being queried. + description: The ID of the feed. dataEndpoints: $ref: "#/components/schemas/StringList" - description: The dataEndpoints of the feed being queried. + description: The dataEndpoints of the feed. outputs: $ref: "#/components/schemas/GetOutputList" - description: An array of the outputs in the feed being queried. + description: An array of the outputs in the feed. status: $ref: "#/components/schemas/FeedStatus" - description: The status of the feed being queried. + description: The status of the feed. association: $ref: "#/components/schemas/FeedAssociation" - description: Information about the resource, if any, associated with the feed being queried. + description: Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error. tags: type: object properties: {} - description: A list of the tags, if any, for the feed being queried. + description: A list of the tags, if any, for the feed. required: - arn - name @@ -539,6 +935,50 @@ components: - dataEndpoints - outputs - status + ListDictionariesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListDictionariesResponse: + type: object + properties: + dictionaries: + $ref: "#/components/schemas/DictionarySummaryList" + description: A list of DictionarySummary objects. + nextToken: + $ref: "#/components/schemas/String" + description: The token to use to retrieve the next batch of results. + required: + - dictionaries + DictionarySummaryList: + type: array + items: + $ref: "#/components/schemas/DictionarySummary" + DictionarySummary: + description: Contains summary information about a dictionary. Used in the ListDictionaries response. + type: object + properties: + arn: + $ref: "#/components/schemas/DictionaryArn" + description: The ARN of the dictionary. + id: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary. + name: + $ref: "#/components/schemas/ResourceName" + description: The name of the dictionary. + language: + $ref: "#/components/schemas/DictionaryLanguage" + description: The language of the dictionary. + status: + $ref: "#/components/schemas/DictionaryStatus" + description: The status of the dictionary. + required: + - arn + - id + - name + - language + - status ListFeedsRequestMaxResultsInteger: type: integer minimum: 1 @@ -548,7 +988,7 @@ components: properties: feeds: $ref: "#/components/schemas/FeedSummaryList" - description: A list of feed summaries. + description: A list of FeedSummary objects. nextToken: $ref: "#/components/schemas/String" description: The token that identifies the batch of results that you want to see. For example, you submit a list request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the list request a second time and specify the NextToken value. @@ -559,7 +999,7 @@ components: items: $ref: "#/components/schemas/FeedSummary" FeedSummary: - description: Contains configuration information about a feed. It is used in the ListFeeds action. + description: Contains configuration information about a feed. It is used in the ListFeeds response. type: object properties: arn: @@ -584,6 +1024,7 @@ components: - status ResourceArn: type: string + pattern: arn:aws[a-z\-]*:elemental-inference[a-z\-]*:[a-z0-9\-]+:[0-9]{12}:(feed|dictionary)/[a-zA-Z0-9]{1,19} ListTagsForResourceResponse: type: object properties: @@ -591,6 +1032,106 @@ components: type: object properties: {} description: A list of the tags that belong to this resource. + DataSourceSport: + type: string + enum: + - basketball + - american-football + FixtureDate: + type: string + pattern: \d{4}-\d{2}-\d{2} + SearchFilterList: + type: array + items: + $ref: "#/components/schemas/SearchFilter" + SearchFilter: + description: A filter for a fixture search. It is used in the filters array of a SearchFixtures request. + type: object + properties: + name: + $ref: "#/components/schemas/FilterName" + description: "The dimension of the fixture to filter on. Valid values: COMPETITOR." + values: + $ref: "#/components/schemas/FilterValueList" + description: An array of values to match in the dimension that you specified in name. You can specify up to 10 values. A fixture appears in the results if it matches at least one of these values. + required: + - name + - values + FilterName: + type: string + enum: + - COMPETITOR + FilterValueList: + type: array + items: + $ref: "#/components/schemas/FilterValue" + FilterValue: + type: string + minLength: 1 + maxLength: 256 + SearchFixturesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + SearchFixturesResponse: + type: object + properties: + fixtures: + $ref: "#/components/schemas/FixtureSummaryList" + description: An array of FixtureSummary objects, one for each fixture that matches the search. The array is empty if no fixtures match. + nextToken: + $ref: "#/components/schemas/String" + description: The token that identifies the next batch of results. To see the next batch, submit the SearchFixtures request again, with the same search criteria, and specify this value in nextToken. This parameter is absent when there are no more results to return. + required: + - fixtures + FixtureSummaryList: + type: array + items: + $ref: "#/components/schemas/FixtureSummary" + FixtureSummary: + description: Contains information about one fixture. It is used in the SearchFixtures response. Elemental Inference relays the information in this structure from the data source, so that you can identify the fixture that matches your source media. + type: object + properties: + fixtureId: + $ref: "#/components/schemas/FixtureId" + description: The ID of the fixture. Specify this ID in the clipping output of a feed, to identify the fixture whose event data you want Elemental Inference to map onto the clipping metadata. + name: + $ref: "#/components/schemas/String" + description: The name of the fixture, as provided by the data source. For example, the names of the two competing teams. + fixtureGroup: + $ref: "#/components/schemas/String" + description: The group that the fixture belongs to, such as the competition, league, or tournament. The data source doesn't provide this information for every fixture. + scheduledStart: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The scheduled start time of the fixture, as provided by the data source. The actual start time might differ. + status: + $ref: "#/components/schemas/String" + description: The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed. + competitors: + $ref: "#/components/schemas/CompetitorList" + description: An array of the competitors (the teams or individuals) in the fixture. + required: + - fixtureId + - name + - status + - competitors + SyntheticTimestamp_date_time: + type: string + format: date-time + CompetitorList: + type: array + items: + $ref: "#/components/schemas/Competitor" + Competitor: + description: Contains information about one competitor in a fixture. It is used in the FixtureSummary that is in the SearchFixtures response. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the competitor, as provided by the data source. + isHome: + $ref: "#/components/schemas/Boolean" + description: Specifies whether this competitor is the home side in the fixture. If true, this competitor is the home side. If false, this competitor is the away side. TagKeyList: type: array items: @@ -599,6 +1140,37 @@ components: type: string minLength: 1 maxLength: 128 + UpdateDictionaryResponse: + type: object + properties: + name: + $ref: "#/components/schemas/ResourceName" + description: The updated or original name of the dictionary. + arn: + $ref: "#/components/schemas/DictionaryArn" + description: The ARN of the dictionary. + id: + $ref: "#/components/schemas/DictionaryId" + description: The ID of the dictionary. + language: + $ref: "#/components/schemas/DictionaryLanguage" + description: The updated or original language of the dictionary. + status: + $ref: "#/components/schemas/DictionaryStatus" + description: The current status of the dictionary. + references: + $ref: "#/components/schemas/FeedReferences" + description: A list of feed IDs that reference this dictionary. + tags: + type: object + properties: {} + description: Any tags associated with the dictionary. + required: + - name + - arn + - id + - language + - status UpdateOutputList: type: array items: @@ -609,10 +1181,10 @@ components: properties: name: $ref: "#/components/schemas/ResourceName" - description: The name start here + description: The name of the output. outputConfig: $ref: "#/components/schemas/OutputConfig" - description: A typed property for an output in a feed. It is used in the UpdateFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. + description: A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. status: $ref: "#/components/schemas/OutputStatus" description: The status of the output. @@ -621,7 +1193,7 @@ components: description: A description of the output. fromAssociation: $ref: "#/components/schemas/Boolean" - description: This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here. + description: Elemental Inference originally sets this parameter to True if this output was created by AssociateFeed or to False if this output was created by CreateFeed or UpdateFeed. You must not change this value. Therefore, use GetFeed to determine the current value. Then in the UpdateFeed request, if the current value is True, include this parameter with a value of True. If it's False, omit the parameter. required: - name - outputConfig @@ -646,14 +1218,14 @@ components: description: The array of outputs in the feed. You might have left this array unchanged, or you might have changed it. status: $ref: "#/components/schemas/FeedStatus" - description: The status of the output. + description: The status of the feed. association: $ref: "#/components/schemas/FeedAssociation" - description: True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed. + description: Information about the resource that is associated with the feed, if any. tags: type: object properties: {} - description: The name of the resource currently associated with the feed, if any. + description: The tags associated with the feed. required: - arn - name @@ -752,6 +1324,78 @@ components: - $ref: "#/components/x-stackQL-resources/feeds/methods/disassociate_feed" delete: - $ref: "#/components/x-stackQL-resources/feeds/methods/delete_feed" + dictionaries: + id: aws.elementalinference.dictionaries + name: dictionaries + title: dictionaries + methods: + create_dictionary: + operation: + $ref: "#/paths/~1v1~1dictionary/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_dictionary: + operation: + $ref: "#/paths/~1v1~1dictionary~1{id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + get_dictionary: + operation: + $ref: "#/paths/~1v1~1dictionary~1{id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_dictionary: + operation: + $ref: "#/paths/~1v1~1dictionary~1{id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + export_dictionary_entries: + operation: + $ref: "#/paths/~1v1~1dictionary~1{id}~1entries~1export/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_dictionaries: + operation: + $ref: "#/paths/~1v1~1dictionaries/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.dictionaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dictionaries/methods/get_dictionary" + - $ref: "#/components/x-stackQL-resources/dictionaries/methods/list_dictionaries" + insert: + - $ref: "#/components/x-stackQL-resources/dictionaries/methods/create_dictionary" + update: + - $ref: "#/components/x-stackQL-resources/dictionaries/methods/update_dictionary" + delete: + - $ref: "#/components/x-stackQL-resources/dictionaries/methods/delete_dictionary" tags: id: aws.elementalinference.tags name: tags @@ -788,3 +1432,33 @@ components: - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" delete: [] + fixtures: + id: aws.elementalinference.fixtures + name: fixtures + title: fixtures + methods: + search_fixtures: + operation: + $ref: "#/paths/~1v1~1fixtures/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.fixtures + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/fixtures/methods/search_fixtures" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/emr.yaml b/providers/src/aws/v00.00.00000/services/emr.yaml index 4d68fe01..c398413b 100644 --- a/providers/src/aws/v00.00.00000/services/emr.yaml +++ b/providers/src/aws/v00.00.00000/services/emr.yaml @@ -159,6 +159,9 @@ paths: Tags: $ref: "#/components/schemas/TagList" description: A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters. + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that scopes the tag operation. Required when the resource being tagged is a session-scoped resource. required: - ResourceId - Tags @@ -1017,6 +1020,80 @@ paths: application/json: schema: $ref: "#/components/schemas/GetPersistentAppUIPresignedURLOutput" + /GetSession: + post: + operationId: GetSession + description: Returns detailed information about a session. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - ElasticMapReduce.GetSession + default: ElasticMapReduce.GetSession + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session belongs to. + SessionId: + $ref: "#/components/schemas/SessionId" + description: The ID of the session. + required: + - ClusterId + - SessionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSessionOutput" + /GetSessionEndpoint: + post: + operationId: GetSessionEndpoint + description: Returns the Spark Connect endpoint URL and a time-limited authentication token for the specified session. Use the endpoint and token to connect a PySpark client to the session. Call this operation again when the token expires to obtain a new one. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - ElasticMapReduce.GetSessionEndpoint + default: ElasticMapReduce.GetSessionEndpoint + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session belongs to. + SessionId: + $ref: "#/components/schemas/SessionId" + description: The ID of the session. + required: + - ClusterId + - SessionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSessionEndpointOutput" /GetStudioSessionMapping: post: operationId: GetStudioSessionMapping @@ -1373,6 +1450,48 @@ paths: application/json: schema: $ref: "#/components/schemas/ListSecurityConfigurationsOutput" + /ListSessions: + post: + operationId: ListSessions + description: Lists the sessions on a cluster. You can filter the results by session state. Newer sessions are returned first. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - ElasticMapReduce.ListSessions + default: ElasticMapReduce.ListSessions + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster to list sessions for. + SessionStates: + $ref: "#/components/schemas/SessionStateList" + description: An optional filter that limits the results to sessions in the specified states. + NextToken: + $ref: "#/components/schemas/String" + description: The pagination token returned by a previous ListSessions call. Use it to retrieve the next page of results. + MaxResults: + $ref: "#/components/schemas/MaxResultsNumber" + description: The maximum number of sessions to return in each page of results. + required: + - ClusterId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSessionsOutput" /ListSteps: post: operationId: ListSteps @@ -1898,6 +2017,9 @@ paths: TagKeys: $ref: "#/components/schemas/StringList" description: A list of tag keys to remove from the resource. + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that scopes the tag operation. Required when the resource being untagged is a session-scoped resource. required: - ResourceId - TagKeys @@ -2030,6 +2152,9 @@ paths: MonitoringConfiguration: $ref: "#/components/schemas/MonitoringConfiguration" description: Contains CloudWatch log configuration metadata and settings. + SessionEnabled: + $ref: "#/components/schemas/BooleanObject" + description: Indicates whether Spark Connect sessions are enabled on the cluster. When set to true, you can start Spark Connect sessions using the StartSession operation. required: - Name - Instances @@ -2239,6 +2364,60 @@ paths: application/json: schema: $ref: "#/components/schemas/StartNotebookExecutionOutput" + /StartSession: + post: + operationId: StartSession + description: Creates and starts a new Spark Connect session on the specified cluster. The cluster must be in the RUNNING or WAITING state and have sessions enabled. This operation is supported in Amazon EMR Spark 8.0.0 and later. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - ElasticMapReduce.StartSession + default: ElasticMapReduce.StartSession + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/XmlStringMaxLen256" + description: An optional name for the session. + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster on which to start the session. + ExecutionRoleArn: + $ref: "#/components/schemas/IAMRoleArn" + description: The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution. + EngineConfigurations: + $ref: "#/components/schemas/ConfigurationList" + description: The configuration overrides for the session. Only runtime configuration overrides are supported. + MonitoringConfiguration: + $ref: "#/components/schemas/SessionMonitoringConfiguration" + description: The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging. + SessionIdleTimeoutInMinutes: + $ref: "#/components/schemas/Long" + description: The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it. + ClientRequestToken: + $ref: "#/components/schemas/ClientRequestToken" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again. + Tags: + $ref: "#/components/schemas/TagList" + description: The tags to assign to the session. + required: + - ClusterId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartSessionOutput" /StopNotebookExecution: post: operationId: StopNotebookExecution @@ -2297,6 +2476,43 @@ paths: responses: "200": description: Success + /TerminateSession: + post: + operationId: TerminateSession + description: Terminates an active session. After you call this operation, the session enters the TERMINATING state and then transitions to TERMINATED. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - ElasticMapReduce.TerminateSession + default: ElasticMapReduce.TerminateSession + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session belongs to. + SessionId: + $ref: "#/components/schemas/SessionId" + description: The ID of the session to terminate. + required: + - ClusterId + - SessionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TerminateSessionOutput" /UpdateStudio: post: operationId: UpdateStudio @@ -2715,6 +2931,7 @@ components: description: The Amazon Resource Name of the cluster. InstanceFleetId: type: string + maxLength: 256 ArnType: type: string minLength: 20 @@ -3091,6 +3308,9 @@ components: Value: $ref: "#/components/schemas/String" description: A user-defined value, which is optional in a tag. For more information, see Tag Clusters. + ClusterId: + type: string + maxLength: 256 AddTagsOutput: description: This output indicates the result of adding tags to a resource. type: object @@ -3199,8 +3419,6 @@ components: - GROUP DeleteSecurityConfigurationOutput: type: object - ClusterId: - type: string DescribeClusterOutput: description: This output contains the description of the cluster. type: object @@ -3320,6 +3538,9 @@ components: MonitoringConfiguration: $ref: "#/components/schemas/MonitoringConfiguration" description: Contains Cloudwatch log configuration metadata and settings. + SessionEnabled: + $ref: "#/components/schemas/BooleanObject" + description: Indicates whether Spark Connect sessions are enabled on the cluster. ClusterStatus: description: The detailed status of the cluster. type: object @@ -3573,7 +3794,7 @@ components: LogTypeUploadPolicy: type: object properties: {} - description: "A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy. Valid log types: system-logs: System-level logs including daemon logs, bootstrap logs, and other infrastructure logs. application-logs: Application-level logs from frameworks like Hadoop, Spark, Hive, etc. persistent-ui-logs: Logs for persistent application UIs like Spark History Server. Valid upload policies: emr-managed: Logs are uploaded to both the EMR-managed S3 bucket and the customer-specified S3 bucket (if LogUri is provided). on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. Requires LogUri to be specified in the cluster configuration. disabled: Log upload is disabled for this log type." + description: "A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy. Valid log types: system-logs: EMR Daemon logs. application-logs: Framework logs from Hadoop, Spark, Hive and other applications running on the cluster. persistent-ui-logs: Logs required for persistent application UIs such as Spark History Server and Tez UI. Valid upload policies: emr-managed: Standard behavior. Logs are uploaded to S3 bucket as configured in your LogUri, with certain logs retained by the service for operational support and troubleshooting purposes. on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. This requires you to specify a LogUri when creating the cluster. Persistent-ui-logs cannot have on-customer-s3only policy. Allowed policies for persistent-ui-logs are emr-managed and disabled. disabled: No S3 upload for this log type." JobFlowExecutionStateList: type: array items: @@ -4509,6 +4730,176 @@ components: PresignedURL: $ref: "#/components/schemas/XmlString" description: The returned presigned URL. + SessionId: + type: string + minLength: 0 + maxLength: 256 + GetSessionOutput: + description: Output of the GetSession operation. + type: object + properties: + Session: + $ref: "#/components/schemas/Session" + description: The output displays information about the session. + required: + - Session + Session: + description: Detailed information about a Spark Connect session. + type: object + properties: + Id: + $ref: "#/components/schemas/SessionId" + description: The ID of the session. + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session belongs to. + Name: + $ref: "#/components/schemas/XmlStringMaxLen256" + description: The name of the session, if one was provided at creation time. + Arn: + $ref: "#/components/schemas/ArnType" + description: The Amazon Resource Name (ARN) of the session. + State: + $ref: "#/components/schemas/SessionState" + description: The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED. + StateChangeReason: + $ref: "#/components/schemas/XmlString" + description: A human-readable message describing the most recent state change. + ReleaseLabel: + $ref: "#/components/schemas/XmlStringMaxLen256" + description: The Amazon EMR release label of the cluster that the session is running on. + ExecutionRoleArn: + $ref: "#/components/schemas/IAMRoleArn" + description: The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution. + AccountId: + $ref: "#/components/schemas/XmlStringMaxLen256" + description: The Amazon Web Services account ID that owns the session. + CreatedAt: + $ref: "#/components/schemas/Date" + description: The date and time that the session was created. + UpdatedAt: + $ref: "#/components/schemas/Date" + description: The date and time that the session was last updated. + StartedAt: + $ref: "#/components/schemas/Date" + description: The date and time that the session entered the STARTED state. + EndedAt: + $ref: "#/components/schemas/Date" + description: The date and time that the session was terminated or failed. + IdleSince: + $ref: "#/components/schemas/Date" + description: The date and time that the session last entered the IDLE state. + EngineConfigurations: + $ref: "#/components/schemas/ConfigurationList" + description: The configuration overrides for the session. Only runtime configuration overrides are supported. + MonitoringConfiguration: + $ref: "#/components/schemas/SessionMonitoringConfiguration" + description: The monitoring configuration for the session. + SessionIdleTimeoutInMinutes: + $ref: "#/components/schemas/Long" + description: The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it. + ServerUrl: + $ref: "#/components/schemas/XmlString" + description: The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering. + Tags: + $ref: "#/components/schemas/TagList" + description: The tags associated with the session. + required: + - Id + - ClusterId + - Arn + - State + SessionState: + type: string + enum: + - SUBMITTED + - STARTING + - STARTED + - IDLE + - BUSY + - TERMINATING + - TERMINATED + - FAILED + SessionMonitoringConfiguration: + description: The monitoring configuration for a session. Controls where session logs are published. + type: object + properties: + CloudWatchLoggingConfiguration: + $ref: "#/components/schemas/SessionCloudWatchLoggingConfiguration" + description: The CloudWatch Logs configuration for the session. + ManagedLoggingConfiguration: + $ref: "#/components/schemas/SessionManagedLoggingConfiguration" + description: The Amazon EMR-managed logging configuration for the session. + S3LoggingConfiguration: + $ref: "#/components/schemas/SessionS3LoggingConfiguration" + description: The Amazon S3 logging configuration for the session. + SessionCloudWatchLoggingConfiguration: + description: The CloudWatch Logs configuration for a session. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Whether CloudWatch Logs is enabled for the session. + LogGroup: + $ref: "#/components/schemas/XmlString" + description: The name of the log group where session logs are published. + LogStreamNamePrefix: + $ref: "#/components/schemas/XmlString" + description: The prefix applied to the log stream name where session logs are published. + EncryptionKeyArn: + $ref: "#/components/schemas/XmlString" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs. + LogTypes: + type: object + properties: {} + description: A map of log component names (for example, SPARK_DRIVER, SPARK_EXECUTOR) to the list of log types to publish for that component (for example, stdout, stderr). + SessionManagedLoggingConfiguration: + description: The Amazon EMR-managed logging configuration for a session. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Whether Amazon EMR-managed logging is enabled for the session. + EncryptionKeyArn: + $ref: "#/components/schemas/XmlString" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the managed logs. + SessionS3LoggingConfiguration: + description: The Amazon S3 logging configuration for a session. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Whether Amazon S3 logging is enabled for the session. + LogUri: + $ref: "#/components/schemas/XmlString" + description: The Amazon S3 destination URI where session logs are published. + EncryptionKeyArn: + $ref: "#/components/schemas/XmlString" + description: The Amazon Resource Name (ARN) of the KMS key used to encrypt logs published to Amazon S3. + LogTypes: + type: object + properties: {} + description: A map of log component names (for example, SPARK_DRIVER, SPARK_EXECUTOR) to the list of log types to publish for that component (for example, stdout, stderr). + GetSessionEndpointOutput: + description: Output of the GetSessionEndpoint operation. + type: object + properties: + Endpoint: + $ref: "#/components/schemas/XmlString" + description: The Spark Connect endpoint URL to use in the PySpark client. + AuthToken: + $ref: "#/components/schemas/SensitiveString" + description: A time-limited authentication token used to connect to the Spark Connect endpoint. + AuthTokenExpirationTime: + $ref: "#/components/schemas/Date" + description: The time at which the authentication token expires. After this time, call GetSessionEndpoint again to obtain a new token. + Credentials: + $ref: "#/components/schemas/Credentials" + description: Username and password used to authenticate with the Spark Connect server when connecting directly over VPC peering. + required: + - Endpoint + SensitiveString: + type: string GetStudioSessionMappingOutput: type: object properties: @@ -4839,6 +5230,7 @@ components: description: The custom AMI ID to use for the provisioned instance group. InstanceGroupId: type: string + maxLength: 256 InstanceGroupType: type: string enum: @@ -5180,6 +5572,24 @@ components: CreationDateTime: $ref: "#/components/schemas/Date" description: The date and time the security configuration was created. + SessionStateList: + type: array + items: + $ref: "#/components/schemas/SessionState" + ListSessionsOutput: + description: Output of the ListSessions operation. + type: object + properties: + Sessions: + $ref: "#/components/schemas/SessionList" + description: The sessions that match the request. + NextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent ListSessions call to retrieve the next page of results. This field is absent when there are no more results. + SessionList: + type: array + items: + $ref: "#/components/schemas/Session" StepStateList: type: array items: @@ -5572,6 +5982,48 @@ components: NotebookExecutionId: $ref: "#/components/schemas/XmlStringMaxLen256" description: The unique identifier of the notebook execution. + ClientRequestToken: + type: string + minLength: 1 + maxLength: 36 + StartSessionOutput: + description: Output of the StartSession operation. + type: object + properties: + Id: + $ref: "#/components/schemas/SessionId" + description: The output contains the ID of the session. + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session was started on. + Arn: + $ref: "#/components/schemas/ArnType" + description: The output contains the ARN of the session. + AccountId: + $ref: "#/components/schemas/XmlStringMaxLen256" + description: The Amazon Web Services account ID that owns the session. + State: + $ref: "#/components/schemas/SessionState" + description: The state of the session at the time the request returned. When a session is first created, it enters the SUBMITTED state. + required: + - Id + TerminateSessionOutput: + description: Output of the TerminateSession operation. + type: object + properties: + ClusterId: + $ref: "#/components/schemas/ClusterId" + description: The ID of the cluster that the session belonged to. + SessionId: + $ref: "#/components/schemas/SessionId" + description: The ID of the terminated session. + State: + $ref: "#/components/schemas/SessionState" + description: The state of the session after the terminate request has been accepted. + required: + - ClusterId + - SessionId + - State x-stackQL-resources: instance_fleets: id: aws.emr.instance_fleets @@ -6182,6 +6634,19 @@ components: config: requestBodyTranslate: algorithm: naive + start_session: + operation: + $ref: "#/paths/~1StartSession/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/clusters/methods/describe_cluster" @@ -6577,6 +7042,91 @@ components: insert: [] update: [] delete: [] + sessions: + id: aws.emr.sessions + name: sessions + title: sessions + methods: + get_session: + operation: + $ref: "#/paths/~1GetSession/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Session + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_sessions: + operation: + $ref: "#/paths/~1ListSessions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Sessions + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + terminate_session: + operation: + $ref: "#/paths/~1TerminateSession/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/sessions/methods/get_session" + - $ref: "#/components/x-stackQL-resources/sessions/methods/list_sessions" + insert: [] + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/sessions/methods/terminate_session" + session_endpoints: + id: aws.emr.session_endpoints + name: session_endpoints + title: session_endpoints + methods: + get_session_endpoint: + operation: + $ref: "#/paths/~1GetSessionEndpoint/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/session_endpoints/methods/get_session_endpoint" + insert: [] + update: [] + delete: [] bootstrap_actions: id: aws.emr.bootstrap_actions name: bootstrap_actions diff --git a/providers/src/aws/v00.00.00000/services/emr_containers.yaml b/providers/src/aws/v00.00.00000/services/emr_containers.yaml index 9600e8cd..f553ed8f 100644 --- a/providers/src/aws/v00.00.00000/services/emr_containers.yaml +++ b/providers/src/aws/v00.00.00000/services/emr_containers.yaml @@ -166,6 +166,8 @@ paths: $ref: "#/components/schemas/ClientToken" tags: $ref: "#/components/schemas/TagMap" + sessionIdleTimeoutInMinutes: + $ref: "#/components/schemas/SessionIdleTimeoutInMinutes" required: - name - type @@ -303,7 +305,7 @@ paths: /virtualclusters: post: operationId: CreateVirtualCluster - description: Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. + description: Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. parameters: [] requestBody: required: true @@ -322,6 +324,10 @@ paths: $ref: "#/components/schemas/TagMap" securityConfigurationId: $ref: "#/components/schemas/ResourceIdString" + sessionEnabled: + $ref: "#/components/schemas/Boolean" + schedulerConfiguration: + $ref: "#/components/schemas/SchedulerConfiguration" required: - name - containerProvider @@ -335,7 +341,7 @@ paths: $ref: "#/components/schemas/CreateVirtualClusterResponse" get: operationId: ListVirtualClusters - description: Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. + description: Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. parameters: - name: containerProviderId in: query @@ -474,10 +480,45 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeManagedEndpointResponse" + /securityconfigurations/{security_configuration_id}: + delete: + operationId: DeleteSecurityConfiguration + description: Deletes a security configuration. + parameters: + - name: security_configuration_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceIdString" + description: The ID of the security configuration to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSecurityConfigurationResponse" + get: + operationId: DescribeSecurityConfiguration + description: Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster. + parameters: + - name: security_configuration_id + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceIdString" + description: The ID of the security configuration. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeSecurityConfigurationResponse" /virtualclusters/{virtual_cluster_id}: delete: operationId: DeleteVirtualCluster - description: Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. + description: Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. parameters: - name: virtual_cluster_id in: path @@ -494,7 +535,7 @@ paths: $ref: "#/components/schemas/DeleteVirtualClusterResponse" get: operationId: DescribeVirtualCluster - description: Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. + description: Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. parameters: - name: virtual_cluster_id in: path @@ -509,24 +550,36 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeVirtualClusterResponse" - /securityconfigurations/{security_configuration_id}: - get: - operationId: DescribeSecurityConfiguration - description: Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster. + patch: + operationId: UpdateVirtualCluster + description: Updates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. parameters: - - name: security_configuration_id + - name: virtual_cluster_id in: path required: true schema: $ref: "#/components/schemas/ResourceIdString" - description: The ID of the security configuration. + description: The ID of the virtual cluster to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schedulerConfiguration: + $ref: "#/components/schemas/SchedulerConfiguration" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - clientToken responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DescribeSecurityConfigurationResponse" + $ref: "#/components/schemas/UpdateVirtualClusterResponse" /virtualclusters/{virtual_cluster_id}/endpoints/{endpoint_id}/credentials: post: operationId: GetManagedEndpointSessionCredentials @@ -1109,6 +1162,9 @@ components: logUri: $ref: "#/components/schemas/UriString" description: Amazon S3 destination URI for log publishing. + encryptionKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the encryption key for logs. required: - logUri ContainerLogRotationConfiguration: @@ -1133,6 +1189,8 @@ components: type: integer minimum: 1 maximum: 50 + SessionIdleTimeoutInMinutes: + type: integer CreateManagedEndpointResponse: type: object properties: @@ -1193,13 +1251,18 @@ components: $ref: "#/components/schemas/KubernetesNamespace" description: The namespaces of the Amazon EKS cluster. nodeLabel: - $ref: "#/components/schemas/ResourceNameString" + $ref: "#/components/schemas/NodeLabelString" description: The nodeLabel of the nodes where the resources of this virtual cluster can get scheduled. It requires relevant scaling and policy engine addons. KubernetesNamespace: type: string minLength: 1 maxLength: 63 pattern: "[a-z0-9]([-a-z0-9]*[a-z0-9])?" + NodeLabelString: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ SecurityConfigurationData: description: Configurations related to the security configuration for the request. type: object @@ -1207,6 +1270,9 @@ components: authorizationConfiguration: $ref: "#/components/schemas/AuthorizationConfiguration" description: Authorization-related configuration input for the security configuration. + authenticationConfiguration: + $ref: "#/components/schemas/AuthenticationConfiguration" + description: Authentication-related configuration input for the security configuration. AuthorizationConfiguration: description: Authorization-related configuration inputs for the security configuration. type: object @@ -1281,6 +1347,49 @@ components: minLength: 3 maxLength: 2048 pattern: ^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$ + AuthenticationConfiguration: + description: Contains the authentication settings for a security configuration, including Identity Center and IAM configuration options. + type: object + properties: + identityCenterConfiguration: + $ref: "#/components/schemas/IdentityCenterConfiguration" + description: The IAM Identity Center configuration to use for authentication. + iamConfiguration: + $ref: "#/components/schemas/IAMConfiguration" + description: The IAM configuration to use for authentication. + IdentityCenterConfiguration: + description: Contains the IAM Identity Center settings for a security configuration, including instance ARN, application assignment requirements, and application ARN. + type: object + properties: + enableIdentityCenter: + $ref: "#/components/schemas/Boolean" + description: Specifies whether Identity Center is enabled for the security configuration. + identityCenterApplicationAssignmentRequired: + $ref: "#/components/schemas/Boolean" + description: Specifies whether user assignment is required for the Identity Center application. + identityCenterInstanceARN: + $ref: "#/components/schemas/IdentityCenterInstanceARN" + description: The Amazon Resource Name (ARN) of the Identity Center instance. + emrIdentityCenterApplicationARN: + $ref: "#/components/schemas/EmrIdentityCenterApplicationARN" + description: The Amazon Resource Name (ARN) of the Amazon EMR Identity Center application. + Boolean: + type: boolean + IdentityCenterInstanceARN: + type: string + minLength: 10 + maxLength: 1224 + pattern: ^arn:(aws[a-zA-Z0-9-]*):sso:::instance/ssoins-[0-9a-zA-Z/\\-_]+ + EmrIdentityCenterApplicationARN: + type: string + pattern: ^arn:(aws[a-zA-Z0-9-]*):sso:::application/ssoins-[0-9a-zA-Z/\\-_]+/apl-[0-9a-zA-Z/\\-_]+ + IAMConfiguration: + description: Contains the IAM settings for a security configuration, including the system role used for authentication. + type: object + properties: + systemRole: + $ref: "#/components/schemas/IAMRoleArn" + description: The Amazon Resource Name (ARN) of the system role used by the security configuration. CreateSecurityConfigurationResponse: type: object properties: @@ -1298,6 +1407,24 @@ components: minLength: 60 maxLength: 1024 pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):\/securityconfigurations\/[0-9a-zA-Z]+$ + SchedulerConfiguration: + description: The scheduler configuration for a virtual cluster on Amazon EMR on EKS. It controls how many job runs can run concurrently and how many can wait in the queue. When not set, no concurrency or queue limits are applied. + type: object + properties: + maxInQueueJobRuns: + $ref: "#/components/schemas/InQueueJobLimitInteger" + description: The maximum number of job runs that can be in the PENDING or SUBMITTED state at any time for the virtual cluster. When the queue is full, the service rejects StartJobRun requests with a ValidationException. If you omit this field, the service applies no queue-depth limit. + maxConcurrentJobRuns: + $ref: "#/components/schemas/JobLimitInteger" + description: The maximum number of job runs that can be in the RUNNING state at any time for the virtual cluster. As running slots free up, queued job runs start automatically. If you omit this field, the service applies no concurrency limit. + InQueueJobLimitInteger: + type: integer + minimum: 100 + maximum: 10000 + JobLimitInteger: + type: integer + minimum: 1 + maximum: 10000 CreateVirtualClusterResponse: type: object properties: @@ -1330,6 +1457,12 @@ components: virtualClusterId: $ref: "#/components/schemas/ResourceIdString" description: The output displays the ID of the endpoint's virtual cluster. + DeleteSecurityConfigurationResponse: + type: object + properties: + id: + $ref: "#/components/schemas/ResourceIdString" + description: The ID of the deleted security configuration. DeleteVirtualClusterResponse: type: object properties: @@ -1539,6 +1672,9 @@ components: serverUrl: $ref: "#/components/schemas/UriString" description: The server URL of the endpoint. + authProxyUrl: + $ref: "#/components/schemas/UriString" + description: The authentication proxy URL of the endpoint. createdAt: $ref: "#/components/schemas/Date" description: The date and time when the endpoint was created. @@ -1651,6 +1787,15 @@ components: securityConfigurationId: $ref: "#/components/schemas/ResourceIdString" description: The ID of the security configuration. + sessionEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the virtual cluster has session support enabled. + schedulerConfiguration: + $ref: "#/components/schemas/SchedulerConfiguration" + description: The scheduler configuration (concurrency and queue limits) applied to the virtual cluster. The service does not return this field when no scheduler limits are configured. + schedulerStatus: + $ref: "#/components/schemas/SchedulerStatus" + description: The current in-queue and concurrent job-run counts for the virtual cluster. VirtualClusterState: type: string enum: @@ -1658,6 +1803,19 @@ components: - TERMINATING - TERMINATED - ARRESTED + SchedulerStatus: + description: The current job-run counts for a virtual cluster, reflecting how much of the configured scheduler capacity is in use. + type: object + properties: + currentInQueueJobRuns: + $ref: "#/components/schemas/NonNegativeInteger" + description: The number of job runs currently waiting in the queue (PENDING or SUBMITTED) for the virtual cluster. + currentConcurrentJobRuns: + $ref: "#/components/schemas/NonNegativeInteger" + description: The number of job runs currently in the RUNNING state for the virtual cluster. + NonNegativeInteger: + type: integer + minimum: 0 CredentialType: type: string minLength: 1 @@ -1677,6 +1835,9 @@ components: credentials: $ref: "#/components/schemas/Credentials" description: The structure containing the session credentials. + endpointCredentials: + $ref: "#/components/schemas/Credentials" + description: The session credentials that the operation returns. expiresAt: $ref: "#/components/schemas/Date" description: The date and time when the session token will expire. @@ -1776,8 +1937,6 @@ components: type: array items: $ref: "#/components/schemas/VirtualClusterState" - Boolean: - type: boolean ListVirtualClustersResponse: type: object properties: @@ -1822,6 +1981,13 @@ components: pattern: .*\S.* UntagResourceResponse: type: object + UpdateVirtualClusterResponse: + description: Contains the virtual cluster returned after a successful update request. + type: object + properties: + virtualCluster: + $ref: "#/components/schemas/VirtualCluster" + description: The updated virtual cluster. x-stackQL-resources: virtual_clusters: id: aws.emr_containers.virtual_clusters @@ -1875,6 +2041,17 @@ components: openAPIDocKey: "200" mediaType: application/json objectKey: $.virtualCluster + update_virtual_cluster: + operation: + $ref: "#/paths/~1virtualclusters~1{virtual_cluster_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive start_job_run: operation: $ref: "#/paths/~1virtualclusters~1{virtual_cluster_id}~1jobruns/post" @@ -1892,7 +2069,8 @@ components: - $ref: "#/components/x-stackQL-resources/virtual_clusters/methods/list_virtual_clusters" insert: - $ref: "#/components/x-stackQL-resources/virtual_clusters/methods/create_virtual_cluster" - update: [] + update: + - $ref: "#/components/x-stackQL-resources/virtual_clusters/methods/update_virtual_cluster" delete: - $ref: "#/components/x-stackQL-resources/virtual_clusters/methods/delete_virtual_cluster" job_runs: @@ -2074,6 +2252,12 @@ components: responseToken: key: $.nextToken location: body + delete_security_configuration: + operation: + $ref: "#/paths/~1securityconfigurations~1{security_configuration_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json describe_security_configuration: operation: $ref: "#/paths/~1securityconfigurations~1{security_configuration_id}/get" @@ -2088,7 +2272,8 @@ components: insert: - $ref: "#/components/x-stackQL-resources/security_configurations/methods/create_security_configuration" update: [] - delete: [] + delete: + - $ref: "#/components/x-stackQL-resources/security_configurations/methods/delete_security_configuration" managed_endpoint_session_credentials: id: aws.emr_containers.managed_endpoint_session_credentials name: managed_endpoint_session_credentials diff --git a/providers/src/aws/v00.00.00000/services/emr_serverless.yaml b/providers/src/aws/v00.00.00000/services/emr_serverless.yaml index bbc599f3..ae663686 100644 --- a/providers/src/aws/v00.00.00000/services/emr_serverless.yaml +++ b/providers/src/aws/v00.00.00000/services/emr_serverless.yaml @@ -916,6 +916,9 @@ components: imageUri: $ref: "#/components/schemas/ImageUri" description: The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration. + applicationLevelDigestResolution: + $ref: "#/components/schemas/Boolean" + description: Boolean value indicating if the digest resolution is application level or workload level. If true, a custom image URI is resolved at application start time and all workloads submitted will use that image digest. If false, the custom image URI is resolved at the workload submission time. ImageUri: type: string minLength: 1 @@ -1244,6 +1247,9 @@ components: resolvedImageDigest: $ref: "#/components/schemas/ImageDigest" description: The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started. + applicationLevelDigestResolution: + $ref: "#/components/schemas/Boolean" + description: Boolean value indicating if the digest resolution is application level or workload level. If true, a custom image URI is resolved at application start time and all workloads submitted will use that image digest. If false, the custom image URI is resolved at the workload submission time. required: - imageUri ImageDigest: @@ -1373,6 +1379,12 @@ components: queuedDurationMilliseconds: $ref: "#/components/schemas/Long" description: The total time for a job in the QUEUED state in milliseconds. + imageConfiguration: + $ref: "#/components/schemas/ImageConfiguration" + workerTypeSpecifications: + type: object + properties: {} + description: The specification applied to each worker type. Includes the JobRun-level ImageConfiguration when the applicationLevelDigestResolution is false for the application. required: - applicationId - jobRunId @@ -1485,8 +1497,7 @@ components: $ref: "#/components/schemas/EntryPointArgument" EntryPointArgument: type: string - minLength: 1 - pattern: .*\S.* + minLength: 0 SparkSubmitParameters: type: string minLength: 1 @@ -1721,7 +1732,7 @@ components: description: The endpoint URL for connecting to the session. authToken: $ref: "#/components/schemas/SessionAuthToken" - description: Authentication token for accessing the session endpoint. + description: The authentication token for connecting to the session endpoint. Call GetSessionEndpoint again to obtain a new token before it expires. authTokenExpiresAt: $ref: "#/components/schemas/Date" description: The expiration time of the authentication token. diff --git a/providers/src/aws/v00.00.00000/services/entityresolution.yaml b/providers/src/aws/v00.00.00000/services/entityresolution.yaml index 3417367c..ca3759ac 100644 --- a/providers/src/aws/v00.00.00000/services/entityresolution.yaml +++ b/providers/src/aws/v00.00.00000/services/entityresolution.yaml @@ -237,7 +237,7 @@ paths: /matchingworkflows: post: operationId: CreateMatchingWorkflow - description: Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported. + description: Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is PROVIDER, incremental processing is not supported. parameters: [] requestBody: required: true @@ -354,7 +354,7 @@ paths: /idmappingworkflows/{workflow_name}: delete: operationId: DeleteIdMappingWorkflow - description: Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist. + description: Deletes the IdMappingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist. parameters: - name: workflow_name in: path @@ -428,7 +428,7 @@ paths: /idnamespaces/{id_namespace_name}: delete: operationId: DeleteIdNamespace - description: Deletes the IdNamespace with a given name. + description: Deletes the IdNamespace with a given name. This operation returns a ResourceNotFoundException if an ID namespace with the given name does not exist. parameters: - name: id_namespace_name in: path @@ -495,7 +495,7 @@ paths: /matchingworkflows/{workflow_name}: delete: operationId: DeleteMatchingWorkflow - description: Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist. + description: Deletes the MatchingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist. parameters: - name: workflow_name in: path @@ -529,7 +529,7 @@ paths: $ref: "#/components/schemas/GetMatchingWorkflowOutput" put: operationId: UpdateMatchingWorkflow - description: Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported. + description: Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is PROVIDER, incremental processing is not supported. parameters: - name: workflow_name in: path @@ -571,7 +571,7 @@ paths: /schemas/{schema_name}: delete: operationId: DeleteSchemaMapping - description: Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig. + description: Deletes the SchemaMapping with a given name. This operation returns a ResourceNotFoundException if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig. parameters: - name: schema_name in: path @@ -1094,7 +1094,7 @@ components: type: string minLength: 12 maxLength: 64 - pattern: (\d{12})|([a-z0-9\.]+) + pattern: ((\d{12})|([a-z0-9\.]+)) StatementCondition: type: string minLength: 1 @@ -1656,6 +1656,9 @@ components: ruleConditionProperties: $ref: "#/components/schemas/RuleConditionProperties" description: An object containing the rules for a matching workflow. + enableRealTimeMatching: + $ref: "#/components/schemas/Boolean" + description: Specifies whether real-time matching is enabled for the rule-based matching workflow. When you enable real-time matching, you can use the GenerateMatchId operation with the workflow. providerProperties: $ref: "#/components/schemas/ProviderProperties" description: The properties of the provider service. @@ -1738,12 +1741,12 @@ components: $ref: "#/components/schemas/Boolean" description: Enables transitive matching for the rule-based matching workflow. When enabled, records that match through different rules are grouped together into the same match group. IncrementalRunConfig: - description: Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported. + description: Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console. For workflows where resolutionType is PROVIDER, incremental processing is not supported. type: object properties: incrementalRunType: $ref: "#/components/schemas/IncrementalRunType" - description: The type of incremental run. The only valid value is IMMEDIATE. This appears as "Automatic" in the console. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported. + description: The type of incremental run. The only valid value is IMMEDIATE. This appears as "Automatic" in the console. For workflows where resolutionType is PROVIDER, incremental processing is not supported. IncrementalRunType: type: string enum: diff --git a/providers/src/aws/v00.00.00000/services/es.yaml b/providers/src/aws/v00.00.00000/services/es.yaml index 80c29db6..fdfaeed5 100644 --- a/providers/src/aws/v00.00.00000/services/es.yaml +++ b/providers/src/aws/v00.00.00000/services/es.yaml @@ -206,6 +206,10 @@ paths: $ref: "#/components/schemas/DeploymentStrategyOptions" AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseRequestOptions" + UseCase: + $ref: "#/components/schemas/DomainUseCase" + EngineMode: + $ref: "#/components/schemas/DomainEngineMode" required: - DomainName responses: @@ -556,6 +560,10 @@ paths: $ref: "#/components/schemas/DeploymentStrategyOptions" AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseRequestOptions" + UseCase: + $ref: "#/components/schemas/DomainUseCase" + EngineMode: + $ref: "#/components/schemas/DomainEngineMode" responses: "200": description: Success @@ -2073,6 +2081,20 @@ components: UpdateTimestamp: type: string format: date-time + DomainUseCase: + description: The primary use case for the domain, which determines the default configuration and the engine modes that are available. Valid values are SEARCH (full-text search, e-commerce, content discovery, and hybrid and semantic search), VECTOR (k-NN and semantic search, and retrieval-augmented generation), OBSERVABILITY (logs, metrics, traces, and dashboards), and MIXED (a combination of search and analytics). If you don't specify a use case, MIXED is used. + type: string + enum: + - SEARCH + - VECTOR + - OBSERVABILITY + - MIXED + DomainEngineMode: + description: The engine mode for the domain. Valid values are GENERAL (the standard Elasticsearch/OpenSearch engine) and OPTIMIZED (the cost- and performance-optimized engine for observability and log-analytics workloads). If you don't specify an engine mode, GENERAL is used. OPTIMIZED requires OpenSearch 3.5 or later, OpenSearch Optimized instance types (OR1, OR2, OM2, or OI2) for the data tier, and encryption at rest, and is available only for the OBSERVABILITY and MIXED use cases. The engine mode can't be changed after the domain is created. + type: string + enum: + - GENERAL + - OPTIMIZED CreateElasticsearchDomainResponse: description: The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain. type: object @@ -2173,6 +2195,12 @@ components: AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseOptions" description: The current status of the Elasticsearch domain's automated snapshot pause options. + UseCase: + $ref: "#/components/schemas/DomainUseCase" + description: The primary use case for the domain. + EngineMode: + $ref: "#/components/schemas/DomainEngineMode" + description: The engine mode for the domain. required: - DomainId - DomainName @@ -2847,6 +2875,12 @@ components: AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseOptionsStatus" description: Specifies AutomatedSnapshotPauseOptions for the domain. + UseCase: + $ref: "#/components/schemas/UseCaseStatus" + description: The use case configured for the domain. + EngineMode: + $ref: "#/components/schemas/EngineModeStatus" + description: The engine mode configured for the domain. ElasticsearchVersionStatus: description: Status of the Elasticsearch version options for the specified Elasticsearch domain. type: object @@ -3129,6 +3163,32 @@ components: required: - Options - Status + UseCaseStatus: + description: The status of the use case for the domain. + type: object + properties: + Options: + $ref: "#/components/schemas/DomainUseCase" + description: The use case configured for the domain. + Status: + $ref: "#/components/schemas/OptionStatus" + description: The current status of the use case for the domain. + required: + - Options + - Status + EngineModeStatus: + description: The status of the engine mode for the domain. + type: object + properties: + Options: + $ref: "#/components/schemas/DomainEngineMode" + description: The engine mode configured for the domain. + Status: + $ref: "#/components/schemas/OptionStatus" + description: The current status of the engine mode for the domain. + required: + - Options + - Status DomainNameList: description: A list of Elasticsearch domain names. type: array diff --git a/providers/src/aws/v00.00.00000/services/evs.yaml b/providers/src/aws/v00.00.00000/services/evs.yaml index 1571bbec..5de7df93 100644 --- a/providers/src/aws/v00.00.00000/services/evs.yaml +++ b/providers/src/aws/v00.00.00000/services/evs.yaml @@ -113,7 +113,7 @@ paths: /CreateEnvironment: post: operationId: CreateEnvironment - description: Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server. During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF. It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs. When creating a new environment, the default ESX version for the selected VCF version will be used, you cannot choose a specific ESX version in CreateEnvironment action. When a host has been added with a specific ESX version, it can only be upgraded using vCenter Lifecycle Manager. You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response. + description: Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server. When you specify SELF_DEPLOYED for vcfVersion, Amazon EVS provisions only the VLAN subnets; no hosts are added and no VCF installation is performed. After the environment is created, you can add hosts with CreateEnvironmentHost and install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported in this mode. When you specify any other VCF version, Amazon EVS installs and configures VCF for you. For more information, see Self-deployed mode in the Amazon EVS User Guide. When Amazon EVS installs VCF, the default ESX version for the selected VCF version will be used. After a host is added with a specific ESX version, it can only be upgraded using vCenter Lifecycle Manager. You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response. parameters: - name: X-Amz-Target in: header @@ -151,42 +151,37 @@ paths: description: "A unique ID for the VPC that the environment is deployed inside. Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available. The VPC that you specify must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time. Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations. Ensure that you specify a VPC that is adequately sized to accommodate the Amazon EVS subnets." serviceAccessSubnetId: $ref: "#/components/schemas/SubnetId" - description: The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to validate mandatory DNS records for your VCF appliances and hosts and create the environment. + description: The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. The Amazon EVS control plane uses this subnet to interface with your environment. This includes validating DNS records and enabling Amazon EVS Connectors. vcfVersion: $ref: "#/components/schemas/VcfVersion" - description: The VCF version to use for the environment. + description: "The VCF version to use for the environment. SELF_DEPLOYED: You install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported. Any other valid value: Amazon EVS installs and configures VCF for you in the version you specify." termsAccepted: $ref: "#/components/schemas/Boolean" - description: Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal. - licenseInfo: - $ref: "#/components/schemas/LicenseInfoList" - description: "The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type. For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide. VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments. VCF license information can be retrieved from the Broadcom portal." + description: Confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal. initialVlans: $ref: "#/components/schemas/InitialVlans" description: The initial VLAN subnets for the Amazon EVS environment. For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. - hosts: - $ref: "#/components/schemas/HostInfoForCreateList" - description: The ESX hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation. For each host, you must provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts. connectivityInfo: $ref: "#/components/schemas/ConnectivityInfo" - description: The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks. + description: The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks. Not supported when vcfVersion is SELF_DEPLOYED. + licenseInfo: + $ref: "#/components/schemas/LicenseInfoList" + description: "The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type. For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide. VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments. VCF license information can be retrieved from the Broadcom portal. Not supported when vcfVersion is SELF_DEPLOYED." + hosts: + $ref: "#/components/schemas/HostInfoForCreateList" + description: The ESX hosts to add to the environment. For each host, provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, provide a partition or cluster placement group, or use Amazon EC2 Dedicated Hosts. Not supported when vcfVersion is SELF_DEPLOYED. In that case, you can add hosts using CreateEnvironmentHost after the environment is created. vcfHostnames: $ref: "#/components/schemas/VcfHostnames" - description: "The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder." + description: The DNS hostnames for the virtual machines that host the VCF management appliances. Provide hostnames for vCenter, NSX Manager, SDDC Manager, and Cloud Builder. Not supported when vcfVersion is SELF_DEPLOYED. siteId: $ref: "#/components/schemas/String" - description: The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS. + description: The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS. Not supported when vcfVersion is SELF_DEPLOYED. required: - vpcId - serviceAccessSubnetId - vcfVersion - termsAccepted - - licenseInfo - initialVlans - - hosts - - connectivityInfo - - vcfHostnames - - siteId responses: "200": description: Success @@ -197,7 +192,7 @@ paths: /CreateEnvironmentConnector: post: operationId: CreateEnvironmentConnector - description: Creates a connector for an Amazon EVS environment. A connector establishes a connection to a VCF appliance, such as vCenter, using a fully qualified domain name and an Amazon Web Services Secrets Manager secret that stores the appliance credentials. + description: Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name. You can create only one connector of each type per environment. For environments where Amazon EVS installs VCF, the SDDC_MANAGER connector is created automatically. Amazon EVS requires an active connector to SDDC Manager or VCF Operations Manager to monitor environment health and license compliance. parameters: - name: X-Amz-Target in: header @@ -223,13 +218,13 @@ paths: description: A unique ID for the environment to create the connector in. type: $ref: "#/components/schemas/ConnectorType" - description: The type of connector to create. + description: "The type of connector to create. OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments. SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments. VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included." applianceFqdn: $ref: "#/components/schemas/ApplianceFqdn" description: The fully qualified domain name (FQDN) of the VCF appliance that the connector targets. secretIdentifier: $ref: "#/components/schemas/SecretIdentifier" - description: The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions. + description: The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields. Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions. required: - environmentId - type @@ -245,7 +240,7 @@ paths: /CreateEnvironmentHost: post: operationId: CreateEnvironmentHost - description: Creates an ESX host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment. This action can only be used after the Amazon EVS environment is deployed. You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESX host creation. You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into. If you don't specify an ESX version when adding hosts using CreateEnvironmentHost action, Amazon EVS automatically uses the default ESX version associated with your environment's VCF version. To find the default ESX version for a particular VCF version, use the GetVersions action. You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response. + description: Creates an ESX host and adds it to an Amazon EVS environment. This action can only be used after the Amazon EVS environment is deployed. You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESX host creation. You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into. If you don't specify an ESX version when adding hosts using CreateEnvironmentHost action, Amazon EVS automatically uses the default ESX version for your environment's VCF version. To find the available ESX versions for a particular VCF version, use the GetVersions action. You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response. parameters: - name: X-Amz-Target in: header @@ -493,6 +488,42 @@ paths: application/json: schema: $ref: "#/components/schemas/DisassociateEipFromVlanResponse" + /GetDepotUrl: + post: + operationId: GetDepotUrl + description: Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon. The depot URL remains active until you rotate the authentication token by calling this action with rotate set to true. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonElasticVMwareService.GetDepotUrl + default: AmazonElasticVMwareService.GetDepotUrl + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + environmentId: + $ref: "#/components/schemas/EnvironmentId" + description: The unique ID of the Amazon EVS environment to get the depot URL for. + rotate: + $ref: "#/components/schemas/Boolean" + description: Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation. + required: + - environmentId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDepotUrlResponse" /GetEnvironment: post: operationId: GetEnvironment @@ -1191,29 +1222,7 @@ components: enum: - VCF-5.2.1 - VCF-5.2.2 - LicenseInfoList: - type: array - items: - $ref: "#/components/schemas/LicenseInfo" - LicenseInfo: - description: "The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key." - type: object - properties: - solutionKey: - $ref: "#/components/schemas/SolutionKey" - description: The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements. - vsanKey: - $ref: "#/components/schemas/VSanLicenseKey" - description: The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements. - required: - - solutionKey - - vsanKey - SolutionKey: - type: string - pattern: "[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}" - VSanLicenseKey: - type: string - pattern: "[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}" + - SELF_DEPLOYED InitialVlans: description: The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC. type: object @@ -1274,6 +1283,46 @@ components: description: The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC. required: - cidr + ConnectivityInfo: + description: The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network. Not supported when vcfVersion is SELF_DEPLOYED. + type: object + properties: + privateRouteServerPeerings: + $ref: "#/components/schemas/RouteServerPeeringList" + description: The unique IDs for private route server peers. + required: + - privateRouteServerPeerings + RouteServerPeeringList: + type: array + items: + $ref: "#/components/schemas/RouteServerPeering" + RouteServerPeering: + type: string + minLength: 3 + maxLength: 21 + LicenseInfoList: + type: array + items: + $ref: "#/components/schemas/LicenseInfo" + LicenseInfo: + description: "The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key." + type: object + properties: + solutionKey: + $ref: "#/components/schemas/SolutionKey" + description: The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements. + vsanKey: + $ref: "#/components/schemas/VSanLicenseKey" + description: The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements. + required: + - solutionKey + - vsanKey + SolutionKey: + type: string + pattern: "[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}" + VSanLicenseKey: + type: string + pattern: "[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}" HostInfoForCreateList: type: array items: @@ -1324,25 +1373,8 @@ components: minLength: 1 maxLength: 25 pattern: h-[a-f0-9]{8}([a-f0-9]{9})? - ConnectivityInfo: - description: The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network. - type: object - properties: - privateRouteServerPeerings: - $ref: "#/components/schemas/RouteServerPeeringList" - description: The unique IDs for private route server peers. - required: - - privateRouteServerPeerings - RouteServerPeeringList: - type: array - items: - $ref: "#/components/schemas/RouteServerPeering" - RouteServerPeering: - type: string - minLength: 3 - maxLength: 21 VcfHostnames: - description: The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed. VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines. + description: The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed. VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines. Not supported when vcfVersion is SELF_DEPLOYED. type: object properties: vCenter: @@ -1350,7 +1382,7 @@ components: description: The VMware vCenter hostname. nsx: $ref: "#/components/schemas/HostName" - description: The VMware NSX hostname. + description: The VMware NSX Virtual IP (VIP) hostname. nsxManager1: $ref: "#/components/schemas/HostName" description: The hostname for the first VMware NSX Manager virtual machine (VM). @@ -1436,7 +1468,7 @@ components: description: Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability. checks: $ref: "#/components/schemas/ChecksList" - description: A check on the environment to identify instance health and VMware VCF licensing issues. + description: A check on the environment to identify connector health. connectivityInfo: $ref: "#/components/schemas/ConnectivityInfo" description: The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network. @@ -1481,7 +1513,10 @@ components: properties: type_: $ref: "#/components/schemas/CheckType" - description: "The check type. Amazon EVS performs the following checks. KEY_REUSE: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment. KEY_COVERAGE: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys. REACHABILITY: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails. HOST_COUNT: Checks that your environment has a minimum of 4 hosts. If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts." + description: "The check type. Amazon EVS performs the following checks: KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment. KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts. REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager. HOST_COUNT: Verifies that the environment meets the minimum host count. VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector. VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server. VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server. OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector. SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector. SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements. SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts. SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment. CONNECTOR_HEALTH: Aggregate health across all connectors in the environment." + id: + $ref: "#/components/schemas/String" + description: A unique ID for the check. result: $ref: "#/components/schemas/CheckResult" description: The check result. @@ -1498,6 +1533,12 @@ components: - VCENTER_REACHABILITY - VCENTER_VM_SYNC - VCENTER_VM_EVENT + - OPERATIONS_MANAGER_REACHABILITY + - SDDC_MANAGER_REACHABILITY + - SDDC_MANAGER_HOST_COUNT + - SDDC_MANAGER_KEY_COVERAGE + - SDDC_MANAGER_KEY_REUSE + - CONNECTOR_HEALTH SecretList: type: array items: @@ -1512,6 +1553,8 @@ components: ConnectorType: type: string enum: + - OPERATIONS_MANAGER + - SDDC_MANAGER - VCENTER ApplianceFqdn: type: string @@ -1530,7 +1573,7 @@ components: $ref: "#/components/schemas/Connector" description: A description of the created connector. Connector: - description: An object that represents a connector for an Amazon EVS environment. A connector establishes a vCenter connection using the credentials stored in Amazon Web Services Secrets Manager. + description: An object that represents a connector for an Amazon EVS environment. A connector establishes a connection to the given appliance type using the credentials stored in Amazon Web Services Secrets Manager. type: object properties: environmentId: @@ -1638,7 +1681,7 @@ components: $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) that is associated with the environment. Host: - description: An ESX host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the CreateEnvironmentHost operation. Amazon EVS supports 4-16 hosts per environment. + description: An ESX host that runs on an Amazon EC2 bare metal instance. type: object properties: hostName: @@ -1741,6 +1784,18 @@ components: properties: vlan: $ref: "#/components/schemas/Vlan" + GetDepotUrlResponse: + type: object + properties: + depotUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the Amazon EVS Custom Addon depot. This URL includes the authentication token as a path component. + token: + $ref: "#/components/schemas/String" + description: The authentication token for depot access. This token is included in the depot URL and is used to authenticate requests. + required: + - depotUrl + - token GetEnvironmentResponse: type: object properties: @@ -2172,6 +2227,30 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/environment_hosts/methods/delete_environment_host" + depot_urls: + id: aws.evs.depot_urls + name: depot_urls + title: depot_urls + methods: + get_depot_url: + operation: + $ref: "#/paths/~1GetDepotUrl/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/depot_urls/methods/get_depot_url" + insert: [] + update: [] + delete: [] versions: id: aws.evs.versions name: versions diff --git a/providers/src/aws/v00.00.00000/services/firehose.yaml b/providers/src/aws/v00.00.00000/services/firehose.yaml index 8d11f7fa..4ad8c441 100644 --- a/providers/src/aws/v00.00.00000/services/firehose.yaml +++ b/providers/src/aws/v00.00.00000/services/firehose.yaml @@ -637,18 +637,18 @@ components: type: object properties: KeyARN: - $ref: "#/components/schemas/AWSKMSKeyARN" + $ref: "#/components/schemas/AWSKMSKeyARNForSSE" description: If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Firehose uses a service-account CMK. KeyType: $ref: "#/components/schemas/KeyType" description: Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant. When you invoke StartDeliveryStreamEncryption to change the CMK for a Firehose stream that is encrypted with a customer managed CMK, Firehose schedules the grant it had on the old CMK for retirement. You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 Firehose streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a LimitExceededException. To encrypt your Firehose stream, use symmetric CMKs. Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide. required: - KeyType - AWSKMSKeyARN: + AWSKMSKeyARNForSSE: type: string minLength: 1 maxLength: 512 - pattern: arn:.*:kms:[a-zA-Z0-9\-]+:\d{12}:(key|alias)/[a-zA-Z_0-9+=,.@\-_/]+ + pattern: arn:.*:kms:[a-zA-Z0-9\-]+:\d{12}:key/[a-zA-Z_0-9+=,.@\-_/]+ KeyType: type: string enum: @@ -749,6 +749,11 @@ components: description: The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. required: - AWSKMSKeyARN + AWSKMSKeyARN: + type: string + minLength: 1 + maxLength: 512 + pattern: arn:.*:kms:[a-zA-Z0-9\-]+:\d{12}:(key|alias)/[a-zA-Z_0-9+=,.@\-_/]+ CloudWatchLoggingOptions: description: Describes the Amazon CloudWatch logging options for your Firehose stream. type: object @@ -2495,7 +2500,7 @@ components: type: object properties: KeyARN: - $ref: "#/components/schemas/AWSKMSKeyARN" + $ref: "#/components/schemas/AWSKMSKeyARNForSSE" description: If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN. KeyType: $ref: "#/components/schemas/KeyType" diff --git a/providers/src/aws/v00.00.00000/services/gamelift.yaml b/providers/src/aws/v00.00.00000/services/gamelift.yaml index 1ee97433..d85bb272 100644 --- a/providers/src/aws/v00.00.00000/services/gamelift.yaml +++ b/providers/src/aws/v00.00.00000/services/gamelift.yaml @@ -225,16 +225,16 @@ paths: description: The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number. Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource. InstanceConnectionPortRange: $ref: "#/components/schemas/ConnectionPortRange" - description: "The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are: Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition] You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range. If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings. The port range must not overlap with the Amazon GameLift Servers reserved port range 4092-4191. This range is reserved for internal Amazon GameLift Servers services." + description: "The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are: Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the per instance container group definition] You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range. If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings. The port range must not overlap with the Amazon GameLift Servers reserved port range 4092-4191. This range is reserved for internal Amazon GameLift Servers services." InstanceInboundPermissions: $ref: "#/components/schemas/IpPermissionsList" - description: "The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are: Protocol: UDP Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition] You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range. If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings. The port range must not overlap with the Amazon GameLift Servers reserved port range 4092-4191. This range is reserved for internal Amazon GameLift Servers services." + description: "The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are: Protocol: UDP Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the per instance container group definition] You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range. If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings. The port range must not overlap with the Amazon GameLift Servers reserved port range 4092-4191. This range is reserved for internal Amazon GameLift Servers services." GameServerContainerGroupsPerInstance: $ref: "#/components/schemas/GameServerContainerGroupsPerInstance" description: The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum. InstanceType: $ref: "#/components/schemas/NonZeroAndMaxString" - description: The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types. You can't update this fleet property later. + description: The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. By default, Amazon GameLift Servers uses the c5.large instance type. If this instance type does not have sufficient resources for your container groups, you can choose a different instance type that better fits your needs. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types. You can't update this fleet property later. BillingType: $ref: "#/components/schemas/ContainerFleetBillingType" description: Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created. By default, this property is set to ON_DEMAND. You can't update this fleet property later. @@ -271,7 +271,7 @@ paths: /CreateContainerGroupDefinition: post: operationId: CreateContainerGroupDefinition - description: "This API works with the following fleet types: Container Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet. A container group definition determines how Amazon GameLift Servers deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition. There are two types of container groups: A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types: Game server container. This container runs your game server. You can define one game server container in a game server container group. Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group. When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers. On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together. A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers. This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift Servers for help setting the appropriate permissions. Request options Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later. Create a game server container group definition. Provide the following required parameter values: Name ContainerGroupType (GAME_SERVER) OperatingSystem (omit to use default value) TotalMemoryLimitMebibytes (omit to use default value) TotalVcpuLimit (omit to use default value) At least one GameServerContainerDefinition ContainerName ImageUrl PortConfiguration ServerSdkVersion (omit to use default value) Create a per-instance container group definition. Provide the following required parameter values: Name ContainerGroupType (PER_INSTANCE) OperatingSystem (omit to use default value) TotalMemoryLimitMebibytes (omit to use default value) TotalVcpuLimit (omit to use default value) At least one SupportContainerDefinition ContainerName ImageUrl Results If successful, this request creates a ContainerGroupDefinition resource and assigns a unique ARN value. You can update most properties of a container group definition by calling UpdateContainerGroupDefinition, and optionally save the update as a new version." + description: "This API works with the following fleet types: Container Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet. A container group definition determines how Amazon GameLift Servers deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition. There are two types of container groups: A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types: Game server container. This container runs your game server. You can define one game server container in a game server container group. Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group. When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers. On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together. A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers. This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift Servers for help setting the appropriate permissions. Request options Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later. Create a game server container group definition. Provide the following required parameter values: Name ContainerGroupType (GAME_SERVER) OperatingSystem TotalMemoryLimitMebibytes TotalVcpuLimit At least one GameServerContainerDefinition ContainerName ImageUrl PortConfiguration ServerSdkVersion Create a per-instance container group definition. Provide the following required parameter values: Name ContainerGroupType (PER_INSTANCE) OperatingSystem TotalMemoryLimitMebibytes TotalVcpuLimit At least one SupportContainerDefinition ContainerName ImageUrl Results If successful, this request creates a ContainerGroupDefinition resource and assigns a unique ARN value. You can update most properties of a container group definition by calling UpdateContainerGroupDefinition, and optionally save the update as a new version." parameters: - name: X-Amz-Target in: header @@ -435,7 +435,7 @@ paths: /CreateFleetLocations: post: operationId: CreateFleetLocations - description: "This API works with the following fleet types: EC2, Container Adds remote locations to an EC2 and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations. To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift Servers initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Learn more Setting up fleets Update fleet locations Amazon GameLift Servers service locations for managed hosting." + description: "This API works with the following fleet types: EC2, Anywhere, Container Adds remote locations to an EC2 and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations. To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift Servers initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Learn more Setting up fleets Update fleet locations Amazon GameLift Servers service locations for managed hosting." parameters: - name: X-Amz-Target in: header @@ -581,7 +581,7 @@ paths: description: This parameter is deprecated. Use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. IdempotencyToken: $ref: "#/components/schemas/IdStringModel" - description: "Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted." + description: "Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted." GameSessionData: $ref: "#/components/schemas/LargeGameSessionData" description: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session. @@ -828,7 +828,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." PlayerId: $ref: "#/components/schemas/PlayerId" description: A unique identifier for a player. Player IDs are developer-defined. @@ -868,7 +868,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to add players to. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to add players to. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." PlayerIds: $ref: "#/components/schemas/PlayerIdList" description: List of unique identifiers for the players to be added. @@ -934,7 +934,7 @@ paths: /CreateVpcPeeringAuthorization: post: operationId: CreateVpcPeeringAuthorization - description: "This API works with the following fleet types: EC2 Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift Servers fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Servers Fleets. You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift Servers fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift Servers fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. Related actions All APIs by task" + description: "This API works with the following fleet types: EC2 Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift Servers fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Servers Fleets. You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift Servers fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift Servers fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. Amazon GameLift Servers uses the caller's credentials to update peer-VPC resources. The IAM user that calls this operation must have the following Amazon EC2 permissions enabled: ec2:AcceptVpcPeeringConnection ec2:AuthorizeSecurityGroupEgress ec2:AuthorizeSecurityGroupIngress ec2:CreateRoute ec2:DescribeRouteTables ec2:DescribeSecurityGroups Related actions All APIs by task" parameters: - name: X-Amz-Target in: header @@ -971,7 +971,7 @@ paths: /CreateVpcPeeringConnection: post: operationId: CreateVpcPeeringConnection - description: "This API works with the following fleet types: EC2 Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift Servers fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Servers Fleets. Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift Servers fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents . Related actions All APIs by task" + description: "This API works with the following fleet types: EC2 Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift Servers fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Servers Fleets. Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift Servers fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents . Amazon GameLift Servers uses the caller's credentials to update peer-VPC resources. The IAM user that calls this operation must have the following Amazon EC2 permissions enabled: ec2:AcceptVpcPeeringConnection ec2:AuthorizeSecurityGroupEgress ec2:AuthorizeSecurityGroupIngress ec2:CreateRoute ec2:DescribeRouteTables ec2:DescribeSecurityGroups Related actions All APIs by task" parameters: - name: X-Amz-Target in: header @@ -1140,7 +1140,7 @@ paths: /DeleteFleet: post: operationId: DeleteFleet - description: "This API works with the following fleet types: EC2, Anywhere, Container Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations. If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the VPC peering connection. To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is emitted. Learn more Setting up Amazon GameLift Servers Fleets" + description: "This API works with the following fleet types: EC2, Anywhere Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations. If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the VPC peering connection. To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is emitted. Learn more Setting up Amazon GameLift Servers Fleets" parameters: - name: X-Amz-Target in: header @@ -1169,7 +1169,7 @@ paths: /DeleteFleetLocations: post: operationId: DeleteFleetLocations - description: "This API works with the following fleet types: EC2, Container Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down. To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted. If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED. Learn more Setting up Amazon GameLift Servers fleets" + description: "This API works with the following fleet types: EC2, Anywhere, Container Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down. To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted. If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED. Learn more Setting up Amazon GameLift Servers fleets" parameters: - name: X-Amz-Target in: header @@ -1370,7 +1370,7 @@ paths: /DeleteScalingPolicy: post: operationId: DeleteScalingPolicy - description: "This API works with the following fleet types: EC2 Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift Servers removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet." + description: "This API works with the following fleet types: EC2, Container Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift Servers removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet." parameters: - name: X-Amz-Target in: header @@ -1745,7 +1745,7 @@ paths: /DescribeContainerGroupPortMappings: post: operationId: DescribeContainerGroupPortMappings - description: "This API works with the following fleet types: Container Retrieves the port mappings for a container group running on a container fleet. Port mappings show how container ports are mapped to connection ports on the fleet instance. Use this operation to find the connection port for a specific container on a fleet instance. Request options Get port mappings for a game server container group. Provide the fleet ID, set ContainerGroupType to GAME_SERVER, and specify the ComputeName for the game server container group. Get port mappings for a per-instance container group. Provide the fleet ID, set ContainerGroupType to PER_INSTANCE, and specify the InstanceId for the instance. Optionally filter results to a single container by providing a ContainerName. Results This operation returns the fleet ID, location, container group definition ARN, container group type, compute name (for game server container groups), instance ID, and a list of ContainerGroupPortMapping objects. Each object contains the container name, runtime ID, and a list of port mappings that show how container ports map to connection ports on the instance. Learn more Connect to containers Create a container group definition" + description: "This API works with the following fleet types: Container Retrieves the port mappings for a container group running on a container fleet. Port mappings show how container ports are mapped to connection ports on the fleet instance. Use this operation to find the connection port for a specific container on a fleet instance. Request options Get port mappings for a game server container group. Provide the fleet ID, set ContainerGroupType to GAME_SERVER, and specify the ComputeName for the game server container group. Get port mappings for a per-instance container group. Provide the fleet ID, set ContainerGroupType to PER_INSTANCE, and specify the InstanceId for the instance. Optionally filter results to a single container by providing a ContainerName. Results This operation returns the fleet ID, fleet ARN, location, container group definition ARN, container group type, compute name (for game server container groups), instance ID, and a list of ContainerGroupPortMapping objects. Each object contains the container name, runtime ID, and a list of port mappings that show how container ports map to connection ports on the instance. Learn more Connect to containers Create a container group definition" parameters: - name: X-Amz-Target in: header @@ -1776,7 +1776,7 @@ paths: $ref: "#/components/schemas/InstanceId" description: A unique identifier for the fleet instance to retrieve port mappings for. When ContainerGroupType is PER_INSTANCE, this parameter is required. When ContainerGroupType is GAME_SERVER, this parameter is optional. If you provide an instance ID, it must match the instance that's running the specified compute. If the instance ID doesn't match, the request fails with an InvalidRequestException. ContainerName: - $ref: "#/components/schemas/NonZeroAnd128MaxAsciiString" + $ref: "#/components/schemas/ContainerNameQueryFilter" description: A container name to filter the results. When provided, the operation returns port mappings for the specified container only. If no container with the specified name exists in the container group, the request fails with a NotFoundException. If not provided, the operation returns port mappings for all containers in the container group. required: - FleetId @@ -1980,7 +1980,7 @@ paths: /DescribeFleetLocationAttributes: post: operationId: DescribeFleetLocationAttributes - description: "This API works with the following fleet types: EC2, Container Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. This operation can be used in the following ways: To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting" + description: "This API works with the following fleet types: EC2, Anywhere, Container Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. This operation can be used in the following ways: To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting" parameters: - name: X-Amz-Target in: header @@ -2022,7 +2022,7 @@ paths: /DescribeFleetLocationCapacity: post: operationId: DescribeFleetLocationCapacity - description: "This API works with the following fleet types: EC2, Container Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a managed container fleet, this operation also returns counts for game server container groups. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity). To retrieve capacity data, identify a fleet and location. If successful, a FleetCapacity object is returned for the requested fleet location. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting GameLift metrics for fleets" + description: "This API works with the following fleet types: EC2, Anywhere, Container Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a managed container fleet, this operation also returns counts for game server container groups. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity). To retrieve capacity data, identify a fleet and location. If successful, a FleetCapacity object is returned for the requested fleet location. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting GameLift metrics for fleets" parameters: - name: X-Amz-Target in: header @@ -2059,7 +2059,7 @@ paths: /DescribeFleetLocationUtilization: post: operationId: DescribeFleetLocationUtilization - description: "This API works with the following fleet types: EC2, Anywhere, Container Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization). To retrieve utilization data, identify a fleet and location. If successful, a FleetUtilization object is returned for the requested fleet location. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting GameLift metrics for fleets" + description: "This API works with the following fleet types: EC2, Anywhere Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization). To retrieve utilization data, identify a fleet and location. If successful, a FleetUtilization object is returned for the requested fleet location. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting GameLift metrics for fleets" parameters: - name: X-Amz-Target in: header @@ -2096,7 +2096,7 @@ paths: /DescribeFleetPortSettings: post: operationId: DescribeFleetPortSettings - description: "This API works with the following fleet types: EC2, Container Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. Use this operation in the following ways: To retrieve the port settings for a fleet, identify the fleet's unique identifier. To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty. Learn more Setting up Amazon GameLift Servers fleets" + description: "This API works with the following fleet types: EC2 Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. Use this operation in the following ways: To retrieve the port settings for a fleet, identify the fleet's unique identifier. To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty. Learn more Setting up Amazon GameLift Servers fleets" parameters: - name: X-Amz-Target in: header @@ -2132,7 +2132,7 @@ paths: /DescribeFleetUtilization: post: operationId: DescribeFleetUtilization - description: "This API works with the following fleet types: EC2, Container Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations. This operation can be used in the following ways: To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get utilization data for all fleets, do not provide a fleet identifier. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region. Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Setting up Amazon GameLift Servers Fleets GameLift Metrics for Fleets" + description: "This API works with the following fleet types: EC2 Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations. This operation can be used in the following ways: To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get utilization data for all fleets, do not provide a fleet identifier. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region. Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Setting up Amazon GameLift Servers Fleets GameLift Metrics for Fleets" parameters: - name: X-Amz-Target in: header @@ -2304,7 +2304,7 @@ paths: description: A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value. GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." AliasId: $ref: "#/components/schemas/AliasIdOrArn" description: A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value. @@ -2423,7 +2423,7 @@ paths: description: A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." AliasId: $ref: "#/components/schemas/AliasIdOrArn" description: A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value. @@ -2624,7 +2624,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to retrieve player sessions for. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to retrieve player sessions for. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." PlayerId: $ref: "#/components/schemas/PlayerId" description: A unique identifier for a player to retrieve player sessions for. @@ -2683,7 +2683,7 @@ paths: /DescribeScalingPolicies: post: operationId: DescribeScalingPolicies - description: "This API works with the following fleet types: EC2 Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE." + description: "This API works with the following fleet types: EC2, Container Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE." parameters: - name: X-Amz-Target in: header @@ -2913,7 +2913,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to get logs for. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to get logs for. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." required: - GameSessionId responses: @@ -2983,7 +2983,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions for which to retrieve player connection details. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions for which to retrieve player connection details. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." PlayerIds: $ref: "#/components/schemas/PlayerIdList" description: List of unique identifiers for players. Connection details are returned for each player in this list. @@ -3493,7 +3493,7 @@ paths: /PutScalingPolicy: post: operationId: PutScalingPolicy - description: "This API works with the following fleet types: EC2 Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift Servers to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift Servers to take whatever action is needed to maintain that target. For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift Servers to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift Servers will start new instances or stop unused instances in order to return to the 10% buffer. To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Rule-based policy A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\" A policy's rule statement has the following structure: If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the rule statement would look like this: If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted." + description: "This API works with the following fleet types: EC2, Container Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift Servers to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift Servers to take whatever action is needed to maintain that target. For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift Servers to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift Servers will start new instances or stop unused instances in order to return to the 10% buffer. To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Rule-based policy A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\" A policy's rule statement has the following structure: If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the rule statement would look like this: If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted." parameters: - name: X-Amz-Target in: header @@ -3554,7 +3554,7 @@ paths: /RegisterCompute: post: operationId: RegisterCompute - description: "This API works with the following fleet types: Anywhere, Container Registers a compute resource in an Amazon GameLift Servers Anywhere fleet. For an Anywhere fleet that's running the Amazon GameLift Servers Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes. To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource. If successful, this operation returns compute details, including an Amazon GameLift Servers SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift Servers service. Each server process includes the SDK endpoint in its call to the Amazon GameLift Servers server SDK action InitSDK(). To view compute details, call DescribeCompute with the compute name. Learn more Create an Anywhere fleet Test your integration Server SDK reference guides (for version 5.x)" + description: "This API works with the following fleet types: Anywhere Registers a compute resource in an Amazon GameLift Servers Anywhere fleet. For an Anywhere fleet that's running the Amazon GameLift Servers Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes. To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource. If successful, this operation returns compute details, including an Amazon GameLift Servers SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift Servers service. Each server process includes the SDK endpoint in its call to the Amazon GameLift Servers server SDK action InitSDK(). To view compute details, call DescribeCompute with the compute name. Learn more Create an Anywhere fleet Test your integration Server SDK reference guides (for version 5.x)" parameters: - name: X-Amz-Target in: header @@ -3877,7 +3877,7 @@ paths: description: A descriptive label that is associated with a game session. Session names do not need to be unique. PlayerLatencies: $ref: "#/components/schemas/PlayerLatencyList" - description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. + description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. DesiredPlayerSessions: $ref: "#/components/schemas/DesiredPlayerSessionList" description: Set of information on each player to create a player session for. @@ -3927,7 +3927,7 @@ paths: description: Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. GameSessionArn: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed." + description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed." Players: $ref: "#/components/schemas/PlayerList" description: Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game. You can include up to 199 Players in a StartMatchBackfill request. PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data. The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill. LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region. @@ -4183,7 +4183,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to be terminated. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to be terminated. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." TerminationMode: $ref: "#/components/schemas/TerminationMode" description: "The method to use to terminate the game session. Available methods include: TRIGGER_ON_PROCESS_TERMINATE – Prompts the Amazon GameLift Servers service to send an OnProcessTerminate() callback to the server process and initiate the normal game session shutdown sequence. The OnProcessTerminate method, which is implemented in the game server code, must include a call to the server SDK action ProcessEnding(), which is how the server process signals to Amazon GameLift Servers that a game session is ending. If the server process doesn't call ProcessEnding(), the game session termination won't conclude successfully. FORCE_TERMINATE – Prompts the Amazon GameLift Servers service to stop the server process immediately. Amazon GameLift Servers takes action (depending on the type of fleet) to shut down the server process without the normal game session shutdown sequence. This method is not available for game sessions that are running on Anywhere fleets unless the fleet is deployed with the Amazon GameLift Servers Agent. In this scenario, a force terminate request results in an invalid or bad request exception." @@ -4390,7 +4390,7 @@ paths: /UpdateContainerGroupDefinition: post: operationId: UpdateContainerGroupDefinition - description: "This API works with the following fleet types: Container Updates properties in an existing container group definition. This operation doesn't replace the definition. Instead, it creates a new version of the definition and saves it separately. You can access all versions that you choose to retain. The only property you can't update is the container group type. Request options: Update based on the latest version of the container group definition. Specify the container group definition name only, or use an ARN value without a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the latest version. Update based on a specific version of the container group definition. Specify the container group definition name and a source version number, or use an ARN value with a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the source version. Change a game server container definition. Provide the updated container definition. Add or change a support container definition. Provide a complete set of container definitions, including the updated definition. Remove a support container definition. Provide a complete set of container definitions, excluding the definition to remove. If the container group has only one support container definition, provide an empty set. Results: If successful, this operation returns the complete properties of the new container group definition version. If the container group definition version is used in an active fleets, the update automatically initiates a new fleet deployment of the new version. You can track a fleet's deployments using ListFleetDeployments." + description: "This API works with the following fleet types: Container Updates properties in an existing container group definition. This operation doesn't replace the definition. Instead, it creates a new version of the definition and saves it separately. You can access all versions that you choose to retain. The only property you can't update is the container group type. Request options: Update based on the latest version of the container group definition. Specify the container group definition name only, or use an ARN value without a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the latest version. Update based on a specific version of the container group definition. Specify the container group definition name and a source version number, or use an ARN value with a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the source version. Change a game server container definition. Provide a complete set of container definitions, including the updated definition. Add or change a support container definition. Provide a complete set of container definitions, including the updated definition. Remove a support container definition. Provide a complete set of container definitions, excluding the definition to remove. If the container group has only one support container definition, provide an empty set. Results: If successful, this operation returns the complete properties of the new container group definition version. If the container group definition version is used in an active fleets, the update automatically initiates a new fleet deployment of the new version. You can track a fleet's deployments using ListFleetDeployments." parameters: - name: X-Amz-Target in: header @@ -4442,7 +4442,7 @@ paths: /UpdateFleetAttributes: post: operationId: UpdateFleetAttributes - description: "This API works with the following fleet types: EC2, Anywhere, Container Updates a fleet's mutable attributes, such as game session protection and resource creation limits. To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift Servers returns the identifiers for the updated fleet. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers. Learn more Setting up Amazon GameLift Servers fleets" + description: "This API works with the following fleet types: EC2, Anywhere Updates a fleet's mutable attributes, such as game session protection and resource creation limits. To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift Servers returns the identifiers for the updated fleet. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers. Learn more Setting up Amazon GameLift Servers fleets" parameters: - name: X-Amz-Target in: header @@ -4541,7 +4541,7 @@ paths: /UpdateFleetPortSettings: post: operationId: UpdateFleetPortSettings - description: "This API works with the following fleet types: EC2, Container Updates permissions that allow inbound traffic to connect to game sessions in the fleet. To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name. Learn more Setting up Amazon GameLift Servers fleets" + description: "This API works with the following fleet types: EC2 Updates permissions that allow inbound traffic to connect to game sessions in the fleet. To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet identifiers for the updated fleet are returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name. Learn more Setting up Amazon GameLift Servers fleets" parameters: - name: X-Amz-Target in: header @@ -4626,7 +4626,7 @@ paths: /UpdateGameServerGroup: post: operationId: UpdateGameServerGroup - description: "This API works with the following fleet types: EC2 (FleetIQ) Updates Amazon GameLift Servers FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts. To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift Servers FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned. Learn more Amazon GameLift Servers FleetIQ Guide" + description: "This API works with the following fleet types: EC2 (FleetIQ) Updates Amazon GameLift Servers FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts. To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift Servers FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned. Target tracking Auto Scaling policies on the Auto Scaling group cannot be updated through the Amazon Web Services Management Console. Instead, use the Amazon Elastic Compute Cloud Auto Scaling PutScalingPolicy API action to update these policies. Learn more Amazon GameLift Servers FleetIQ Guide" parameters: - name: X-Amz-Target in: header @@ -4691,7 +4691,7 @@ paths: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions to update. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions to update. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." MaximumPlayerSessionCount: $ref: "#/components/schemas/WholeNumber" description: The maximum number of players that can be connected simultaneously to the game session. @@ -5001,7 +5001,7 @@ components: MatchmakingIdStringModel: type: string maxLength: 128 - pattern: "[a-zA-Z0-9-\\.]*" + pattern: ^[a-zA-Z0-9-\.]*$ PlayerIdsForAcceptMatch: type: array items: @@ -5021,17 +5021,17 @@ components: type: string minLength: 1 maxLength: 256 - pattern: "[a-zA-Z0-9-\\.]+|^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]+" + pattern: ^([a-zA-Z0-9-\.]+|arn:.*:gameservergroup\/[a-zA-Z0-9-\.]+)$ GameServerId: type: string minLength: 3 maxLength: 128 - pattern: "[a-zA-Z0-9-\\.]+" + pattern: ^[a-zA-Z0-9-\.]+$ GameServerData: type: string minLength: 1 maxLength: 1024 - pattern: .*\S.* + pattern: ^.*\S.*$ ClaimFilterOption: description: Filters which game servers may be claimed when calling ClaimGameServer. type: object @@ -5095,12 +5095,12 @@ components: type: string minLength: 1 maxLength: 128 - pattern: "[a-zA-Z0-9-\\.]+" + pattern: ^[a-zA-Z0-9-\.]+$ GameServerGroupArn: type: string minLength: 1 maxLength: 256 - pattern: ^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]* + pattern: ^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]*$ GameServerInstanceId: type: string minLength: 19 @@ -5110,7 +5110,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: .*\S.* + pattern: ^.*\S.*$ GameServerClaimStatus: type: string enum: @@ -5127,7 +5127,7 @@ components: type: string minLength: 1 maxLength: 1024 - pattern: .*\S.* + pattern: ^.*\S.*$ NonZeroAndMaxString: type: string minLength: 1 @@ -5154,7 +5154,7 @@ components: type: string minLength: 1 maxLength: 128 - pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+ + pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+$ FreeText: type: string TagList: @@ -5215,10 +5215,10 @@ components: description: The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). AliasId: type: string - pattern: ^alias-\S+ + pattern: ^alias-\S+$ AliasArn: type: string - pattern: ^arn:.*:alias\/alias-\S+ + pattern: ^arn:.*:alias\/alias-\S+$ S3Location: description: The location in Amazon S3 where build or script files are stored for access by Amazon GameLift Servers. type: object @@ -5297,10 +5297,10 @@ components: description: The Amazon GameLift Servers Server SDK version used to develop your game server. BuildId: type: string - pattern: ^build-\S+ + pattern: ^build-\S+$ BuildArn: type: string - pattern: ^arn:.*:build\/build-\S+ + pattern: ^arn:.*:build\/build-\S+$ BuildStatus: type: string enum: @@ -5378,7 +5378,7 @@ components: - Protocol IpRange: type: string - pattern: "[^\\s]+" + pattern: ^[^\s]+$ IpProtocol: type: string enum: @@ -5410,7 +5410,7 @@ components: type: string minLength: 1 maxLength: 64 - pattern: ^[A-Za-z0-9\-]+ + pattern: ^[A-Za-z0-9\-]+$ MetricGroupList: type: array items: @@ -5460,7 +5460,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: "[a-zA-Z0-9:/\\-\\*]+" + pattern: ^[a-zA-Z0-9:/\-\*]+$ PlayerGatewayMode: type: string enum: @@ -5532,7 +5532,7 @@ components: description: A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time. Status: $ref: "#/components/schemas/ContainerFleetStatus" - description: The current status of the container fleet. PENDING -- A new container fleet has been requested. CREATING -- A new container fleet resource is being created. CREATED -- A new container fleet resource has been created. No fleet instances have been deployed. ACTIVATING -- New container fleet instances are being deployed. ACTIVE -- The container fleet has been deployed and is ready to host game sessions. UPDATING -- Updates to the container fleet is being updated. A deployment is in progress. + description: The current status of the container fleet. PENDING -- A new container fleet has been requested. CREATING -- A new container fleet resource is being created. CREATED -- A new container fleet resource has been created. No fleet instances have been deployed. ACTIVATING -- New container fleet instances are being deployed. ACTIVE -- The container fleet has been deployed and is ready to host game sessions. UPDATING -- Updates to the container fleet is being updated. A deployment is in progress. EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions. DeploymentDetails: $ref: "#/components/schemas/DeploymentDetails" description: Information about the most recent deployment for the container fleet. @@ -5574,6 +5574,7 @@ components: - ACTIVE - UPDATING - DELETING + - EXPIRED DeploymentDetails: description: Information about the most recent deployment for the container fleet. type: object @@ -5599,7 +5600,7 @@ components: description: A location identifier. Status: $ref: "#/components/schemas/ContainerFleetLocationStatus" - description: The status of fleet activity in the location. PENDING -- A new container fleet has been requested. CREATING -- A new container fleet resource is being created. CREATED -- A new container fleet resource has been created. No fleet instances have been deployed. ACTIVATING -- New container fleet instances are being deployed. ACTIVE -- The container fleet has been deployed and is ready to host game sessions. UPDATING -- Updates to the container fleet is being updated. A deployment is in progress. + description: The status of fleet activity in the location. PENDING -- A new container fleet has been requested. CREATING -- A new container fleet resource is being created. CREATED -- A new container fleet resource has been created. No fleet instances have been deployed. ACTIVATING -- New container fleet instances are being deployed. ACTIVE -- The container fleet has been deployed and is ready to host game sessions. UPDATING -- Updates to the container fleet is being updated. A deployment is in progress. EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions. PlayerGatewayStatus: $ref: "#/components/schemas/PlayerGatewayStatus" description: "The current status of player gateway in this location for this container fleet. Note, even if a container fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see Amazon GameLift Servers service locations. Possible values include: ENABLED -- Player gateway is available for this container fleet location. DISABLED -- Player gateway is not available for this container fleet location." @@ -5613,6 +5614,7 @@ components: - ACTIVE - UPDATING - DELETING + - EXPIRED PlayerGatewayStatus: type: string enum: @@ -5657,6 +5659,9 @@ components: ServerSdkVersion: $ref: "#/components/schemas/ServerSdkVersion" description: The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets. + LinuxCapabilities: + $ref: "#/components/schemas/LinuxCapabilities" + description: Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities. required: - ContainerName - ImageUri @@ -5781,6 +5786,57 @@ components: - FromPort - ToPort - Protocol + LinuxCapabilities: + description: "A set of Linux capabilities that are added to a container's default Docker configuration for a container defined in the ContainerGroupDefinition. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. Modifying capabilities on an existing container: To remove a capability, update the Include list with only the needed capabilities. To revert back to default capabilities, omit LinuxCapabilities within the ContainerDefinition. Part of: GameServerContainerDefinition, GameServerContainerDefinitionInput, SupportContainerDefinition, SupportContainerDefinitionInput Returned by: CreateContainerGroupDefinition, DescribeContainerGroupDefinition, ListContainerGroupDefinitions, ListContainerGroupDefinitionVersions, UpdateContainerGroupDefinition" + type: object + properties: + Include: + $ref: "#/components/schemas/LinuxCapabilityList" + description: The list of Linux capabilities to add to the container's default configuration. Specify each capability as a string from the set of supported capability names (for example, NET_BIND_SERVICE or SYS_PTRACE). + LinuxCapabilityList: + type: array + items: + $ref: "#/components/schemas/LinuxCapability" + LinuxCapability: + type: string + enum: + - AUDIT_CONTROL + - AUDIT_WRITE + - BLOCK_SUSPEND + - CHOWN + - DAC_OVERRIDE + - DAC_READ_SEARCH + - FOWNER + - FSETID + - IPC_LOCK + - IPC_OWNER + - KILL + - LEASE + - LINUX_IMMUTABLE + - MAC_ADMIN + - MAC_OVERRIDE + - MKNOD + - NET_ADMIN + - NET_BIND_SERVICE + - NET_BROADCAST + - NET_RAW + - SETFCAP + - SETGID + - SETPCAP + - SETUID + - SYS_ADMIN + - SYS_BOOT + - SYS_CHROOT + - SYS_MODULE + - SYS_NICE + - SYS_PACCT + - SYS_PTRACE + - SYS_RAWIO + - SYS_RESOURCE + - SYS_TIME + - SYS_TTY_CONFIG + - SYSLOG + - WAKE_ALARM SupportContainerDefinitionInputList: type: array items: @@ -5819,6 +5875,9 @@ components: Vcpu: $ref: "#/components/schemas/ContainerVcpu" description: "The number of vCPU units to reserve for this container. The container can use more resources when needed, if available. If you don't reserve CPU units for this container, it shares the container group's total vCPU limit. Related data type: ContainerGroupDefinition TotalCpuLimit" + LinuxCapabilities: + $ref: "#/components/schemas/LinuxCapabilities" + description: Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities. required: - ContainerName - ImageUri @@ -5930,7 +5989,7 @@ components: required: - Name GameServerContainerDefinition: - description: "Describes the game server container in an existing game server container group. A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts. You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput. Part of: ContainerGroupDefinition Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition" + description: "Describes the game server container in an existing game server container group. A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts. You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput. Part of: ContainerGroupDefinition Returned by: CreateContainerGroupDefinition, DescribeContainerGroupDefinition, ListContainerGroupDefinitions, ListContainerGroupDefinitionVersions, UpdateContainerGroupDefinition" type: object properties: ContainerName: @@ -5957,6 +6016,9 @@ components: ServerSdkVersion: $ref: "#/components/schemas/ServerSdkVersion" description: The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets. + LinuxCapabilities: + $ref: "#/components/schemas/LinuxCapabilities" + description: Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities. Sha256: type: string pattern: ^sha256:[a-fA-F0-9]{64}$ @@ -5965,7 +6027,7 @@ components: items: $ref: "#/components/schemas/SupportContainerDefinition" SupportContainerDefinition: - description: "Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes. You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput. Part of: ContainerGroupDefinition Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition" + description: "Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes. You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput. Part of: ContainerGroupDefinition Returned by: CreateContainerGroupDefinition, DescribeContainerGroupDefinition, ListContainerGroupDefinitions, ListContainerGroupDefinitionVersions, UpdateContainerGroupDefinition" type: object properties: ContainerName: @@ -6001,6 +6063,9 @@ components: Vcpu: $ref: "#/components/schemas/ContainerVcpu" description: "The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group. Related data type: ContainerGroupDefinition TotalVcpuLimit" + LinuxCapabilities: + $ref: "#/components/schemas/LinuxCapabilities" + description: Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities. PositiveInteger: type: integer minimum: 1 @@ -6012,20 +6077,24 @@ components: - FAILED BuildIdOrArn: type: string - pattern: ^build-\S+|^arn:.*:build\/build-\S+ + minLength: 1 + maxLength: 512 + pattern: ^(build-\S+|arn:.*:build\/build-\S+)$ ScriptIdOrArn: type: string - pattern: ^script-\S+|^arn:.*:script\/script-\S+ + minLength: 1 + maxLength: 512 + pattern: ^(script-\S+|arn:.*:script\/script-\S+)$ LaunchPathStringModel: type: string minLength: 1 maxLength: 1024 - pattern: "[A-Za-z0-9_:.+\\/\\\\\\- ]+" + pattern: ^[A-Za-z0-9_:.+\/\\\- ]+$ LaunchParametersStringModel: type: string minLength: 1 maxLength: 1024 - pattern: "[A-Za-z0-9_:.+\\/\\\\\\- =@;{},?'\\[\\]\"]+" + pattern: ^[A-Za-z0-9_:.+\/\\\- =@;{},?'\[\]"]+$ StringList: type: array items: @@ -6538,6 +6607,27 @@ components: - r7a.24xlarge - r7a.32xlarge - r7a.48xlarge + - c8a.medium + - c8a.large + - c8a.xlarge + - c8a.2xlarge + - c8i.large + - c8i.xlarge + - c8i.2xlarge + - c9g.medium + - c9g.large + - c9g.xlarge + - c9g.2xlarge + - m8a.medium + - m8a.large + - m8a.xlarge + - m8a.2xlarge + - m8i.large + - m8i.xlarge + - m8i.2xlarge + - m9g.large + - m9g.xlarge + - m9g.2xlarge RuntimeConfiguration: description: A set of instructions that define the set of server processes to run on computes in a fleet. Server processes run either an executable in a custom game build or a Amazon GameLift Servers Realtime script. Amazon GameLift Servers launches the processes, manages their life cycle, and replaces them as needed. Computes check regularly for an updated runtime configuration. An Amazon GameLift Servers instance is limited to 50 processes running concurrently. To calculate the total number of processes defined in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet. type: object @@ -6580,7 +6670,7 @@ components: minimum: 1 maximum: 600 ResourceCreationLimitPolicy: - description: A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources. The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift Servers checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period. + description: A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources. The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift Servers checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period. The purpose of this policy is to prevent a single player from consuming a large share of available hosting resources. For example, setting NewGameSessionsPerCreator to 4 and PolicyPeriodInMinutes to 10 limits each player to creating 4 game sessions every 10 minutes. Setting these values too high (for example, 200 game sessions every 1000 minutes) still allows a single player to rapidly consume resources. We recommend keeping these values small. type: object properties: NewGameSessionsPerCreator: @@ -6682,7 +6772,7 @@ components: description: A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). Status: $ref: "#/components/schemas/FleetStatus" - description: "Current status of the fleet. Possible fleet statuses include the following: NEW -- A new fleet resource has been defined and Amazon GameLift Servers has started creating the fleet. Desired instances is set to 1. DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift Servers is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift Servers launches a fleet instance. ACTIVATING -- Amazon GameLift Servers is launching a game server process and testing its connectivity with the Amazon GameLift Servers service. ACTIVE -- The fleet is now ready to host game sessions. ERROR -- An error occurred when downloading, validating, building, or activating the fleet. DELETING -- Hosts are responding to a delete fleet request. TERMINATED -- The fleet no longer exists." + description: "Current status of the fleet. Possible fleet statuses include the following: NEW -- A new fleet resource has been defined and Amazon GameLift Servers has started creating the fleet. Desired instances is set to 1. DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift Servers is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift Servers launches a fleet instance. ACTIVATING -- Amazon GameLift Servers is launching a game server process and testing its connectivity with the Amazon GameLift Servers service. ACTIVE -- The fleet is now ready to host game sessions. ERROR -- An error occurred when downloading, validating, building, or activating the fleet. EXPIRED -- The fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions. DELETING -- Hosts are responding to a delete fleet request. TERMINATED -- The fleet no longer exists." BuildId: $ref: "#/components/schemas/BuildId" description: A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2". @@ -6752,12 +6842,13 @@ components: - ERROR - TERMINATED - NOT_FOUND + - EXPIRED ScriptId: type: string - pattern: ^script-\S+ + pattern: ^script-\S+$ ScriptArn: type: string - pattern: ^arn:.*:script\/script-\S+ + pattern: ^arn:.*:script\/script-\S+$ FleetActionList: type: array items: @@ -6817,17 +6908,17 @@ components: type: string minLength: 1 maxLength: 255 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]+$ LaunchTemplateName: type: string minLength: 3 maxLength: 128 - pattern: "[a-zA-Z0-9\\(\\)\\.\\-/_]+" + pattern: ^[a-zA-Z0-9\(\)\.\-/_]+$ LaunchTemplateVersion: type: string minLength: 1 maxLength: 128 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]+$ InstanceDefinitions: type: array items: @@ -7035,7 +7126,7 @@ components: type: string minLength: 0 maxLength: 256 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ GameServerGroupStatus: type: string enum: @@ -7056,7 +7147,9 @@ components: - REPLACE_INSTANCE_TYPES AliasIdOrArn: type: string - pattern: ^alias-\S+|^arn:.*:alias\/alias-\S+ + minLength: 1 + maxLength: 512 + pattern: ^(alias-\S+|arn:.*:alias\/alias-\S+)$ GamePropertyList: type: array items: @@ -7084,7 +7177,7 @@ components: type: string minLength: 1 maxLength: 48 - pattern: "[a-zA-Z0-9-]+" + pattern: ^[a-zA-Z0-9-]+$ LargeGameSessionData: type: string minLength: 1 @@ -7101,7 +7194,7 @@ components: properties: GameSessionId: $ref: "#/components/schemas/NonZeroAndMaxString" - description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." Name: $ref: "#/components/schemas/NonZeroAndMaxString" description: A descriptive label that is associated with a game session. Session names do not need to be unique. @@ -7180,7 +7273,7 @@ components: type: string minLength: 1 maxLength: 128 - pattern: ^[0-9A-Fa-f\:\.]+ + pattern: ^[0-9A-Fa-f\:\.]+$ DnsName: type: string PlayerSessionCreationPolicy: @@ -7196,12 +7289,12 @@ components: type: string minLength: 1 maxLength: 128 - pattern: ^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)? + pattern: ^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$ GameSessionQueueName: type: string minLength: 1 maxLength: 128 - pattern: "[a-zA-Z0-9-]+" + pattern: ^[a-zA-Z0-9-]+$ PlayerLatencyPolicyList: type: array items: @@ -7231,7 +7324,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: "[a-zA-Z0-9:/-]+" + pattern: ^[a-zA-Z0-9:/-]+$ FilterConfiguration: description: A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily exclude specific locations from receiving placements. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all, of a fleet's locations. type: object @@ -7268,12 +7361,12 @@ components: type: string minLength: 0 maxLength: 256 - pattern: "[\\s\\S]*" + pattern: ^[\s\S]*$ QueueSnsArnStringModel: type: string minLength: 0 maxLength: 300 - pattern: "[a-zA-Z0-9:_-]*(\\.fifo)?" + pattern: ^[a-zA-Z0-9:_-]*(\.fifo)?$ CreateGameSessionQueueOutput: type: object properties: @@ -7315,12 +7408,12 @@ components: type: string minLength: 1 maxLength: 256 - pattern: ^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+ + pattern: ^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+$ CustomInputLocationStringModel: type: string minLength: 8 maxLength: 64 - pattern: ^custom-[A-Za-z0-9\-]+ + pattern: ^custom-[A-Za-z0-9\-]+$ CreateLocationOutput: type: object properties: @@ -7344,7 +7437,7 @@ components: type: string minLength: 1 maxLength: 128 - pattern: ^arn:.*:location\/custom-\S+ + pattern: ^arn:.*:location\/custom-\S+$ PingBeacon: description: Information about a UDP ping beacon that can be used to measure network latency between a player device and an Amazon GameLift Servers hosting location. type: object @@ -7378,12 +7471,12 @@ components: type: string minLength: 1 maxLength: 256 - pattern: "[a-zA-Z0-9-\\.]*|^arn:.*:matchmakingruleset\\/[a-zA-Z0-9-\\.]*" + pattern: ^([a-zA-Z0-9-\.]*|arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]*)$ SnsArnStringModel: type: string minLength: 0 maxLength: 300 - pattern: "[a-zA-Z0-9:_/-]*(.fifo)?" + pattern: ^[a-zA-Z0-9:_/-]*(\.fifo)?$ CustomEventData: type: string minLength: 0 @@ -7466,11 +7559,11 @@ components: MatchmakingConfigurationArn: description: Data type used for Matchmaking Configuration ARN. type: string - pattern: ^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]* + pattern: ^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*$ MatchmakingRuleSetArn: description: Data type used for Matchmaking RuleSet ARN. type: string - pattern: ^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]* + pattern: ^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]*$ RuleSetBody: type: string minLength: 1 @@ -7523,7 +7616,7 @@ components: description: A unique identifier for a player that is associated with this player session. GameSessionId: $ref: "#/components/schemas/NonZeroAndMaxString" - description: "An identifier for the game session that is unique across all regions that the player session is connected to. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions that the player session is connected to. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." FleetId: $ref: "#/components/schemas/FleetId" description: A unique identifier for the fleet that the player's game session is running on. @@ -7553,7 +7646,9 @@ components: description: Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game. PlayerSessionId: type: string - pattern: ^psess-\S+ + minLength: 1 + maxLength: 128 + pattern: ^psess-\S+$ PlayerSessionStatus: type: string enum: @@ -7679,21 +7774,21 @@ components: type: string minLength: 1 maxLength: 256 - pattern: "[a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+" + pattern: ^([a-zA-Z0-9-]+|arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+)$ DeleteGameSessionQueueOutput: type: object CustomLocationNameOrArnModel: type: string minLength: 1 maxLength: 128 - pattern: ^custom-[A-Za-z0-9\-]+|^arn:.*:location\/custom-\S+ + pattern: ^(custom-[A-Za-z0-9\-]+|arn:.*:location\/custom-\S+)$ DeleteLocationOutput: type: object MatchmakingConfigurationName: type: string minLength: 1 maxLength: 256 - pattern: "[a-zA-Z0-9-\\.]*|^arn:.*:matchmakingconfiguration\\/[a-zA-Z0-9-\\.]*" + pattern: ^([a-zA-Z0-9-\.]*|arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*)$ DeleteMatchmakingConfigurationOutput: type: object DeleteMatchmakingRuleSetOutput: @@ -7705,7 +7800,7 @@ components: ComputeNameOrArn: type: string maxLength: 1024 - pattern: ^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$|^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)? + pattern: ^([a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?|arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?)$ DeregisterComputeOutput: type: object DescribeAliasOutput: @@ -7781,7 +7876,7 @@ components: ComputeArn: type: string maxLength: 1024 - pattern: ^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)? + pattern: ^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$ ComputeStatus: type: string enum: @@ -7799,7 +7894,9 @@ components: maxLength: 128 InstanceId: type: string - pattern: "[a-zA-Z0-9\\.-]+" + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z0-9\.-]+$ ContainerAttributes: type: array items: @@ -7826,12 +7923,20 @@ components: ContainerGroupDefinition: $ref: "#/components/schemas/ContainerGroupDefinition" description: The properties of the requested container group definition resource. + ContainerNameQueryFilter: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9\-_]+$ DescribeContainerGroupPortMappingsOutput: type: object properties: FleetId: $ref: "#/components/schemas/FleetId" description: A unique identifier for the container fleet. + FleetArn: + $ref: "#/components/schemas/FleetArn" + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:``::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value. Location: $ref: "#/components/schemas/LocationStringModel" description: The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2. @@ -8070,7 +8175,7 @@ components: type: string minLength: 1 maxLength: 256 - pattern: "[a-zA-Z0-9:/-]+" + pattern: ^[a-zA-Z0-9:/-]+$ DeploymentStatus: type: string enum: @@ -8133,7 +8238,7 @@ components: description: A unique identifier for an event resource, such as a fleet ID. EventCode: $ref: "#/components/schemas/EventCode" - description: "The type of event being logged. Fleet state transition events: FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID. FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. Amazon GameLift Servers is downloading the compressed build and running install scripts. FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. Amazon GameLift Servers has successfully installed build and is now validating the build files. FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. Amazon GameLift Servers has successfully verified the build files and is now launching a fleet instance. FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. Amazon GameLift Servers is launching a game server process on the fleet instance and is testing its connectivity with the Amazon GameLift Servers service. FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions. FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details. Fleet creation events (ordered by fleet creation activity): FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance. FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and Amazon GameLift Serversis now extracting the build files from the uploaded build. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and Amazon GameLift Servers is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_COMPLETED_INSTALLER -- The game server build files were successfully installed and validation of the installation will begin soon. FLEET_CREATION_FAILED_INSTALLER -- The installed failed while attempting to install the build files. This event indicates that the failure occurred before Amazon GameLift Servers could start validation. FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, Amazon GameLift Servers tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl. FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance. FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance. FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again. FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see Debug Fleet Creation Issues. FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc. FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details. VPC peering events: FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift Servers fleet and a VPC in your Amazon Web Services account. FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted. Spot instance events: INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification. INSTANCE_RECYCLED -- A spot instance was determined to have a high risk of interruption and is scheduled to be recycled once it has no active game sessions. Server process events: SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet. SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected (5 minutes). Check your game session log to see why InitSDK() was not called in time. This event is not emitted for managed container fleets and Anywhere fleets unless they're deployed with the Amazon GameLift Servers Agent. SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected (5 minutes) after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time. SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called. SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long. SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly within the time expected after OnProcessTerminate() was sent. Check your game session log to see why termination took longer than expected. SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected (30 seconds) after calling ProcessEnding(). Check your game session log to see why termination took longer than expected. Game session events: GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected. Other fleet events: FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings. FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting. FLEET_DELETED -- A request to delete a fleet was initiated. GENERIC_EVENT -- An unspecified event has occurred." + description: "The type of event being logged. Fleet state transition events: FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID. FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. Amazon GameLift Servers is downloading the compressed build and running install scripts. FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. Amazon GameLift Servers has successfully installed build and is now validating the build files. FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. Amazon GameLift Servers has successfully verified the build files and is now launching a fleet instance. FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. Amazon GameLift Servers is launching a game server process on the fleet instance and is testing its connectivity with the Amazon GameLift Servers service. FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions. FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details. Fleet creation events (ordered by fleet creation activity): FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance. FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and Amazon GameLift Serversis now extracting the build files from the uploaded build. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and Amazon GameLift Servers is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_COMPLETED_INSTALLER -- The game server build files were successfully installed and validation of the installation will begin soon. FLEET_CREATION_FAILED_INSTALLER -- The installed failed while attempting to install the build files. This event indicates that the failure occurred before Amazon GameLift Servers could start validation. FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, Amazon GameLift Servers tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl. FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance. FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance. FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again. FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see Debug Fleet Creation Issues. FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc. FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details. VPC peering events: FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift Servers fleet and a VPC in your Amazon Web Services account. FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted. Spot instance events: INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification. INSTANCE_RECYCLED -- A spot instance was determined to have a high risk of interruption and is scheduled to be recycled once it has no active game sessions. Server process events: SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet. SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected (5 minutes). Check your game session log to see why InitSDK() was not called in time. This event is not emitted for managed container fleets and Anywhere fleets unless they're deployed with the Amazon GameLift Servers Agent. SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected (5 minutes) after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time. SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called. SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long. SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly within the time expected after OnProcessTerminate() was sent. Check your game session log to see why termination took longer than expected. SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected (30 seconds) after calling ProcessEnding(). Check your game session log to see why termination took longer than expected. Game session events: GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected. Other fleet events: FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings. FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting. FLEET_DELETED -- A request to delete a fleet was initiated. FLEET_EXPIRED -- The fleet has been expired. The fleet is scaled down to zero instances and can no longer host game sessions. GENERIC_EVENT -- An unspecified event has occurred." Message: $ref: "#/components/schemas/NonEmptyString" description: Additional information related to the event. @@ -8152,6 +8257,7 @@ components: - GENERIC_EVENT - FLEET_CREATED - FLEET_DELETED + - FLEET_EXPIRED - FLEET_SCALING_EVENT - FLEET_STATE_DOWNLOADING - FLEET_STATE_VALIDATING @@ -8418,16 +8524,16 @@ components: description: A descriptive label that is associated with a game session. Session names do not need to be unique. GameSessionId: $ref: "#/components/schemas/NonZeroAndMaxString" - description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//. This value is the same as GameSessionArn. This value isn't final until placement status is FULFILLED." + description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/. This value is the same as GameSessionArn. This value isn't final until placement status is FULFILLED." GameSessionArn: $ref: "#/components/schemas/NonZeroAndMaxString" - description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//. This value is the same as GameSessionId. This value isn't final until placement status is FULFILLED." + description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/. This value is the same as GameSessionId. This value isn't final until placement status is FULFILLED." GameSessionRegion: $ref: "#/components/schemas/NonZeroAndMaxString" description: Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED. PlayerLatencies: $ref: "#/components/schemas/PlayerLatencyList" - description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. + description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). StartTime: $ref: "#/components/schemas/Timestamp" description: Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). @@ -8471,7 +8577,7 @@ components: items: $ref: "#/components/schemas/PlayerLatency" PlayerLatency: - description: Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player. + description: Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified location (an Amazon Web Services Region or a custom location for Amazon GameLift Servers Anywhere fleets). The relative difference between a player's latency values for multiple locations are used to determine which fleets are best suited to place a new game session for the player. type: object properties: PlayerId: @@ -8479,7 +8585,7 @@ components: description: A unique identifier for a player associated with the latency data. RegionIdentifier: $ref: "#/components/schemas/NonZeroAndMaxString" - description: Name of the Region that is associated with the latency value. + description: Name of the Region or custom location that is associated with the latency value. For Amazon GameLift Servers Anywhere fleets, use the custom location name. LatencyInMilliseconds: $ref: "#/components/schemas/Float" description: Amount of time that represents the time lag experienced by the player when connected to the specified Region. @@ -8689,14 +8795,14 @@ components: LatencyInMs: type: object properties: {} - description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable. + description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable. GameSessionConnectionInfo: description: Connection information for a new game session that is created in response to a start matchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the matchmaking ticket. type: object properties: GameSessionArn: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." IpAddress: $ref: "#/components/schemas/IpAddress" description: The IP address of the game session. To connect to a Amazon GameLift Servers game server, an app needs both the IP address and port number. @@ -9025,7 +9131,7 @@ components: type: string minLength: 1 maxLength: 64 - pattern: ^[a-zA-Z0-9\-]+ + pattern: ^[a-zA-Z0-9\-]+$ GetGameSessionLogUrlOutput: type: object properties: @@ -9072,7 +9178,7 @@ components: properties: GameSessionId: $ref: "#/components/schemas/ArnStringModel" - description: "An identifier for the game session that is unique across all regions for which the player connection details were retrieved. The value is always a full ARN in the following format: arn:aws:gamelift:``::gamesession//." + description: "An identifier for the game session that is unique across all regions for which the player connection details were retrieved. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:``::gamesession//. For Remote Location game session - arn:aws:gamelift:``::gamesession//``/." PlayerConnectionDetails: $ref: "#/components/schemas/PlayerConnectionDetailList" description: A collection of player connection detail objects, one for each requested player. @@ -9317,7 +9423,7 @@ components: type: string minLength: 1 maxLength: 256 - pattern: ^[0-9a-zA-Z_\-\.]+ + pattern: ^[0-9a-zA-Z_\-\.]+$ RegisterComputeOutput: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/gameliftstreams.yaml b/providers/src/aws/v00.00.00000/services/gameliftstreams.yaml index 797dc0fe..0ca1c399 100644 --- a/providers/src/aws/v00.00.00000/services/gameliftstreams.yaml +++ b/providers/src/aws/v00.00.00000/services/gameliftstreams.yaml @@ -96,7 +96,7 @@ paths: /applications: post: operationId: CreateApplication - description: Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it. Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide. Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application. If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to INITIALIZED. When an application reaches READY status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication. + description: Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it. Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide. Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application. Creating an application is the only time Amazon GameLift Streams accesses your Amazon S3 bucket. After the application reaches READY status, you can delete the original files from your Amazon S3 bucket without affecting the application. If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to INITIALIZED. When an application reaches READY status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication. parameters: [] requestBody: required: true @@ -211,6 +211,30 @@ paths: application/json: schema: $ref: "#/components/schemas/ListStreamGroupsOutput" + /streamgroups/{identifier}/streamsessions/{stream_session_identifier}/access: + post: + operationId: CreateStreamSessionAdminShell + description: "Creates an administrative terminal session with full access to the live runtime environment of the Amazon GameLift Streams stream session. Use the returned credentials (SessionId, StreamUrl and TokenValue) with the Amazon Web Services Systems Manager Session Manager plugin for the CLI to access the terminal session. The stream session must be in one of the following statuses: ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, or RECONNECTING. The StreamUrl is valid for 60 seconds. After it expires, call this operation again to get a new URL. The returned credentials grant full access to the live runtime environment of the Amazon GameLift Streams stream session. The operator who connects to the terminal session has the same level of access that your Amazon GameLift Streams applications have, including potentially user input, screen images, and application data files. Grant permissions to call this operation only to trusted IAM identities that require live runtime environment access." + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "The stream group that runs this stream session. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4." + - name: stream_session_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateStreamSessionAdminShellOutput" /streamgroups/{identifier}/streamsessions/{stream_session_identifier}/connections: post: operationId: CreateStreamSessionConnection @@ -248,6 +272,58 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateStreamSessionConnectionOutput" + /streamgroups/{identifier}/streamurls: + post: + operationId: CreateStreamUrl + description: Creates a stream URL that grants temporary access to a stream session in a web browser without requiring an Amazon Web Services account or client integration. You can use the stream URL to start a stream session up to the number of times set by UsageLimit, until it expires after UrlExpiresAfterMinutes. Each successful use starts a new stream session. To make the request idempotent, provide a ClientToken. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4. The stream session runs in this stream group." + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ApplicationIdentifier: + $ref: "#/components/schemas/Identifier" + Protocol: + $ref: "#/components/schemas/Protocol" + UrlExpiresAfterMinutes: + $ref: "#/components/schemas/UrlExpiresAfterMinutes" + UsageLimit: + $ref: "#/components/schemas/UsageLimit" + Description: + $ref: "#/components/schemas/Description" + Locations: + $ref: "#/components/schemas/LocationList" + SessionLengthSeconds: + $ref: "#/components/schemas/SessionLengthSeconds" + AdditionalLaunchArgs: + $ref: "#/components/schemas/GameLaunchArgList" + AdditionalEnvironmentVariables: + $ref: "#/components/schemas/EnvironmentVariables" + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" + ClientToken: + $ref: "#/components/schemas/ClientToken" + required: + - ApplicationIdentifier + - UrlExpiresAfterMinutes + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateStreamUrlOutput" /applications/{identifier}: delete: operationId: DeleteApplication @@ -477,6 +553,48 @@ paths: responses: "204": description: Success + /streamgroups/{identifier}/streamurls/{stream_url_identifier}: + get: + operationId: GetStreamUrl + description: Retrieves properties for a stream URL, including its current status, usage, and the stream sessions started through it. If you delete the stream group or application that backs the stream URL, this operation updates the status of the stream URL to REVOKED. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4. This is the stream group that owns the stream URL." + - name: stream_url_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "The unique identifier of the stream URL. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetStreamUrlOutput" + /applications/{identifier}/shadercaches: + get: + operationId: ListApplicationShaderCaches + description: Lists the shader caches associated with an Amazon GameLift Streams application. Each shader cache entry includes its status, associated stream groups, and size in bytes. Returns shader caches associated with the specified Amazon GameLift Streams application in all statuses. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListApplicationShaderCachesOutput" /streamgroups/{identifier}/streamsessions: get: operationId: ListStreamSessions @@ -560,6 +678,10 @@ paths: $ref: "#/components/schemas/EnvironmentVariables" PerformanceStatsConfiguration: $ref: "#/components/schemas/PerformanceStatsConfiguration" + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" required: - SignalRequest - ApplicationIdentifier @@ -606,6 +728,42 @@ paths: application/json: schema: $ref: "#/components/schemas/ListStreamSessionsByAccountOutput" + /streamurls: + get: + operationId: ListStreamUrls + description: Retrieves a list of the stream URLs in the current Amazon Web Services Region for your Amazon Web Services account. You can filter the results by status or by stream group. Use the pagination parameters to retrieve results as a set of sequential pages. If you delete the stream group or application that backs a stream URL, this operation updates that stream URL's status to REVOKED. + parameters: + - name: Status + in: query + required: false + schema: + $ref: "#/components/schemas/StreamUrlStatus" + description: "Filters the list to stream URLs with the specified status. ACTIVE: The stream URL is valid and can start stream sessions. EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions. REVOKED: The stream URL was revoked and can no longer start stream sessions. LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions." + - name: StreamGroupIdentifier + in: query + required: false + schema: + $ref: "#/components/schemas/Identifier" + description: "Filters the list to stream URLs that belong to the specified stream group. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4." + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return per page. Valid values are 1-100. The default is 25. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListStreamUrlsOutput" /tags/{resource_arn}: get: operationId: ListTagsForResource @@ -673,6 +831,35 @@ paths: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" + /streamgroups/{identifier}/streamurls/{stream_url_identifier}/revoke: + post: + operationId: RevokeStreamUrl + description: Revokes a stream URL so that it can no longer start new stream sessions. By default, stream sessions that are already running continue until they end on their own. To also end running sessions, set RevocationMode to REVOKE_AND_TERMINATE_SESSIONS. Revoking a stream URL is permanent. The status of the stream URL changes to REVOKED. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4. This is the stream group that owns the stream URL." + - name: stream_url_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Identifier" + description: "The unique identifier of the stream URL to revoke. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4." + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + RevocationMode: + $ref: "#/components/schemas/RevocationMode" + responses: + "204": + description: Success components: parameters: X-Amz-Content-Sha256: @@ -1077,7 +1264,7 @@ components: description: "This value is the set of locations, including their name, current status, and capacities. A location can be in one of the following states: ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group." StreamClass: $ref: "#/components/schemas/StreamClass" - description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" + description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" Id: $ref: "#/components/schemas/Id" description: "A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4." @@ -1126,6 +1313,28 @@ components: enum: - internalError - noAvailableInstances + CreateStreamSessionAdminShellOutput: + type: object + properties: + SessionId: + $ref: "#/components/schemas/SessionId" + description: An Amazon Web Services Systems Manager session identifier that uniquely identifies the requested terminal session. Use this value with the Amazon Web Services Systems Manager Session Manager plugin. + StreamUrl: + $ref: "#/components/schemas/StreamUrl" + description: An Amazon Web Services Systems Manager WebSocket connection endpoint for the requested terminal session. + TokenValue: + $ref: "#/components/schemas/TokenValue" + description: An Amazon Web Services Systems Manager authentication token that authenticates your access to the session ID and WebSocket URL. This token must be treated with the same level of security as other user credentials. The token value is only valid for establishing a new connection within 60 seconds of generation. + SessionId: + type: string + minLength: 1 + maxLength: 256 + StreamUrl: + type: string + TokenValue: + type: string + minLength: 0 + maxLength: 1024 SignalRequest: type: string minLength: 1 @@ -1137,6 +1346,149 @@ components: description: The WebRTC answer string that the stream server generates in response to the SignalRequest. SignalResponse: type: string + Protocol: + type: string + enum: + - WebRTC + UrlExpiresAfterMinutes: + type: integer + minimum: 1 + UsageLimit: + type: integer + minimum: 1 + LocationList: + type: array + items: + $ref: "#/components/schemas/LocationName" + SessionLengthSeconds: + type: integer + minimum: 1 + maximum: 86400 + GameLaunchArgList: + type: array + items: + $ref: "#/components/schemas/String" + EnvironmentVariables: + type: object + properties: {} + IamRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/.+ + DisplayConfiguration: + description: The virtual monitor settings for a stream session, including the resolution. If not specified, the stream session uses the default resolution of 1920 × 1080. + type: object + properties: + Resolution: + $ref: "#/components/schemas/Resolution" + description: The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080. + Resolution: + description: Contains the width and height dimensions, in pixels, that define the resolution of the stream session's virtual monitor. The total number of pixels (width × height) must not exceed 2,073,600 (equivalent to 1920 × 1080). + type: object + properties: + Width: + $ref: "#/components/schemas/ResolutionWidth" + description: The width of the stream session's virtual monitor, in pixels. The value must be an even number. + Height: + $ref: "#/components/schemas/ResolutionHeight" + description: The height of the stream session's virtual monitor, in pixels. The value must be an even number. + required: + - Width + - Height + ResolutionWidth: + type: integer + minimum: 320 + maximum: 4096 + ResolutionHeight: + type: integer + minimum: 320 + maximum: 4096 + CreateStreamUrlOutput: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]. + StreamUrlId: + $ref: "#/components/schemas/Id" + description: The unique identifier for the stream URL resource, for example su-1AB2C3De4. + StreamUrl: + $ref: "#/components/schemas/StreamSessionStreamUrl" + description: The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit. + Status: + $ref: "#/components/schemas/StreamUrlStatus" + description: "The current status of the stream URL. Possible statuses include the following: ACTIVE: The stream URL is valid and can start stream sessions. EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions. REVOKED: The stream URL was revoked and can no longer start stream sessions. LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions." + StatusReason: + $ref: "#/components/schemas/StreamUrlStatusReason" + description: "Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following: userRevoked: You revoked the stream URL. revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions. revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended. streamGroupDeleted: The stream group was deleted, which revoked the stream URL. applicationDeleted: The application was deleted, which revoked the stream URL." + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: "The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: "A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + UsageLimit: + $ref: "#/components/schemas/UsageLimit" + description: The maximum number of times the stream URL can start a stream session. + RemainingUses: + $ref: "#/components/schemas/RemainingUses" + description: The number of times the stream URL can still be used to start a stream session. + StreamGroupArn: + $ref: "#/components/schemas/Arn" + description: "The stream group that runs the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4." + ApplicationArn: + $ref: "#/components/schemas/Arn" + description: "The application that runs in the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." + Protocol: + $ref: "#/components/schemas/Protocol" + description: The data transport protocol used for stream sessions started from this stream URL. + Locations: + $ref: "#/components/schemas/LocationList" + description: The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide. + SessionLengthSeconds: + $ref: "#/components/schemas/SessionLengthSeconds" + description: The maximum length of time, in seconds, that a stream session started from this stream URL can run. + Description: + $ref: "#/components/schemas/Description" + description: The descriptive label for the stream URL. + AdditionalLaunchArgs: + $ref: "#/components/schemas/GameLaunchArgList" + description: The command-line arguments passed to the application when a stream session starts. + AdditionalEnvironmentVariables: + type: object + properties: {} + description: The environment variables made available to the application when a stream session starts. + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide. + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" + description: The display settings, such as resolution, for stream sessions started from this stream URL. + required: + - Arn + StreamSessionStreamUrl: + type: string + minLength: 1 + maxLength: 2048 + StreamUrlStatus: + type: string + enum: + - ACTIVE + - EXPIRED + - REVOKED + - LIMIT_REACHED + StreamUrlStatusReason: + type: string + enum: + - userRevoked + - revokedAndTerminatingSessions + - revokedAndSessionsTerminated + - streamGroupDeleted + - applicationDeleted + RemainingUses: + type: integer + minimum: 0 DisassociateApplicationsOutput: type: object properties: @@ -1217,7 +1569,7 @@ components: description: "This value is the set of locations, including their name, current status, and capacities. A location can be in one of the following states: ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group." StreamClass: $ref: "#/components/schemas/StreamClass" - description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" + description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" Id: $ref: "#/components/schemas/Id" description: "A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4." @@ -1308,6 +1660,12 @@ components: ExportFilesMetadata: $ref: "#/components/schemas/ExportFilesMetadata" description: Provides details about the stream session's exported files. + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the AWS Identity and Access Management (IAM) role that Amazon GameLift Streams assumes on behalf of your application during the stream session. + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" + description: The configuration for the stream session's virtual monitor. UserId: type: string minLength: 0 @@ -1331,28 +1689,17 @@ components: - invalidSignalRequest - placementTimeout - applicationLogS3DestinationError + - assumeRoleFailed - applicationExit - connectionTimeout - reconnectionTimeout - maxSessionLengthTimeout - idleTimeout - apiTerminated - Protocol: - type: string - enum: - - WebRTC ConnectionTimeoutSeconds: type: integer minimum: 1 maximum: 3600 - SessionLengthSeconds: - type: integer - minimum: 1 - maximum: 86400 - GameLaunchArgList: - type: array - items: - $ref: "#/components/schemas/String" PerformanceStatsConfiguration: description: Configuration settings for sharing the stream session's performance stats with the client type: object @@ -1389,6 +1736,159 @@ components: type: string minLength: 0 maxLength: 1024 + GetStreamUrlOutput: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]. + StreamUrlId: + $ref: "#/components/schemas/Id" + description: The unique identifier for the stream URL resource, for example su-1AB2C3De4. + StreamUrl: + $ref: "#/components/schemas/StreamSessionStreamUrl" + description: The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit. + Status: + $ref: "#/components/schemas/StreamUrlStatus" + description: "The current status of the stream URL. Possible statuses include the following: ACTIVE: The stream URL is valid and can start stream sessions. EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions. REVOKED: The stream URL was revoked and can no longer start stream sessions. LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions." + StatusReason: + $ref: "#/components/schemas/StreamUrlStatusReason" + description: "Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following: userRevoked: You revoked the stream URL. revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions. revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended. streamGroupDeleted: The stream group was deleted, which revoked the stream URL. applicationDeleted: The application was deleted, which revoked the stream URL." + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: "The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: "A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + UsageLimit: + $ref: "#/components/schemas/UsageLimit" + description: The maximum number of times the stream URL can start a stream session. + RemainingUses: + $ref: "#/components/schemas/RemainingUses" + description: The number of times the stream URL can still be used to start a stream session. + StreamGroupArn: + $ref: "#/components/schemas/Arn" + description: "The stream group that runs the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4." + ApplicationArn: + $ref: "#/components/schemas/Arn" + description: "The application that runs in the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." + Protocol: + $ref: "#/components/schemas/Protocol" + description: The data transport protocol used for stream sessions started from this stream URL. + Locations: + $ref: "#/components/schemas/LocationList" + description: The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide. + SessionLengthSeconds: + $ref: "#/components/schemas/SessionLengthSeconds" + description: The maximum length of time, in seconds, that a stream session started from this stream URL can run. + Description: + $ref: "#/components/schemas/Description" + description: The descriptive label for the stream URL. + AdditionalLaunchArgs: + $ref: "#/components/schemas/GameLaunchArgList" + description: The command-line arguments passed to the application when a stream session starts. + AdditionalEnvironmentVariables: + type: object + properties: {} + description: The environment variables made available to the application when a stream session starts. + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide. + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" + description: The display settings, such as resolution, for stream sessions started from this stream URL. + StreamSessions: + $ref: "#/components/schemas/StreamSessionSummaryList" + description: A list of the stream sessions that have been started through this stream URL. + required: + - Arn + StreamSessionSummaryList: + type: array + items: + $ref: "#/components/schemas/StreamSessionSummary" + StreamSessionSummary: + description: Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: "An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567." + UserId: + $ref: "#/components/schemas/UserId" + description: An opaque, unique identifier for an end-user, defined by the developer. + Status: + $ref: "#/components/schemas/StreamSessionStatus" + description: "The current status of the stream session resource. ACTIVATING: The stream session is starting and preparing to stream. ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates. CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded. ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information. PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state. TERMINATING: The stream session is ending. TERMINATED: The stream session has ended." + StatusReason: + $ref: "#/components/schemas/StreamSessionStatusReason" + description: "A short description of the reason the stream session is in ERROR status or TERMINATED status. ERROR status reasons: applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists. internalError: An internal service error occurred. Start a new stream session to continue streaming. invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request. placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available. TERMINATED status reasons: apiTerminated: The stream session was terminated by an API call to TerminateStreamSession. applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running. connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds. maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds. reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection." + Protocol: + $ref: "#/components/schemas/Protocol" + description: The data transfer protocol in use with the stream session. + LastUpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: "A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: "A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + ApplicationArn: + $ref: "#/components/schemas/Arn" + description: "An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." + ExportFilesMetadata: + $ref: "#/components/schemas/ExportFilesMetadata" + description: Provides details about the stream session's exported files. + Location: + $ref: "#/components/schemas/LocationName" + description: The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide. + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the AWS Identity and Access Management (IAM) role that Amazon GameLift Streams assumes on behalf of your application during the stream session. + ListApplicationShaderCachesOutput: + type: object + properties: + Items: + $ref: "#/components/schemas/ShaderCacheSummaryList" + description: A collection of shader cache metadata for the specified Amazon GameLift Streams application. Each item includes the shader cache status, associated stream groups, and storage size. + ShaderCacheSummaryList: + type: array + items: + $ref: "#/components/schemas/ShaderCacheSummary" + ShaderCacheSummary: + description: Describes a shader cache associated with an Amazon GameLift Streams application. + type: object + properties: + Identifier: + $ref: "#/components/schemas/Identifier" + description: A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27. + ApplicationArn: + $ref: "#/components/schemas/Arn" + description: "An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." + Status: + $ref: "#/components/schemas/ShaderCacheStatus" + description: "The current status of the shader cache. Possible statuses include the following: INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache. PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups. READY: The shader cache is replicated and available for use in stream sessions. DELETING: Amazon GameLift Streams is deleting the shader cache. ERROR: An error occurred during shader cache processing. Create a new shader cache to try again." + LastUpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: "A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + StorageBytes: + $ref: "#/components/schemas/Long" + description: The total storage used by all compiled shader files in this shader cache, in bytes. + AssociatedStreamGroups: + $ref: "#/components/schemas/ArnList" + description: "The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide. This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4." + required: + - Identifier + - ApplicationArn + ShaderCacheStatus: + type: string + enum: + - INITIALIZED + - PROCESSING + - READY + - DELETING + - ERROR + Long: + type: integer + format: int64 NextToken: type: string MaxResults: @@ -1466,7 +1966,7 @@ components: description: Object that identifies the Amazon GameLift Streams application to stream with this stream group. StreamClass: $ref: "#/components/schemas/StreamClass" - description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" + description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" Status: $ref: "#/components/schemas/StreamGroupStatus" description: "The current status of the stream group resource. Possible statuses include the following: ACTIVATING: The stream group is deploying and isn't ready to host streams. ACTIVE: The stream group is ready to host streams. ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. DELETING: Amazon GameLift Streams is in the process of deleting the stream group. ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information. EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities. UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting)." @@ -1490,53 +1990,73 @@ components: NextToken: $ref: "#/components/schemas/NextToken" description: A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. - StreamSessionSummaryList: + ListStreamSessionsByAccountOutput: + type: object + properties: + Items: + $ref: "#/components/schemas/StreamSessionSummaryList" + description: A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. + ListStreamUrlsOutput: + type: object + properties: + Items: + $ref: "#/components/schemas/StreamUrlSummaryList" + description: A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration. + NextToken: + $ref: "#/components/schemas/NextToken" + description: A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. + StreamUrlSummaryList: type: array items: - $ref: "#/components/schemas/StreamSessionSummary" - StreamSessionSummary: - description: Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. + $ref: "#/components/schemas/StreamUrlSummary" + StreamUrlSummary: + description: Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl. type: object properties: Arn: $ref: "#/components/schemas/Arn" - description: "An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567." - UserId: - $ref: "#/components/schemas/UserId" - description: An opaque, unique identifier for an end-user, defined by the developer. + description: The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]. + StreamUrlId: + $ref: "#/components/schemas/Id" + description: The unique identifier for the stream URL resource, for example su-1AB2C3De4. + StreamUrl: + $ref: "#/components/schemas/StreamSessionStreamUrl" + description: The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit. Status: - $ref: "#/components/schemas/StreamSessionStatus" - description: "The current status of the stream session resource. ACTIVATING: The stream session is starting and preparing to stream. ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates. CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded. ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information. PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state. TERMINATING: The stream session is ending. TERMINATED: The stream session has ended." + $ref: "#/components/schemas/StreamUrlStatus" + description: "The current status of the stream URL. Possible statuses include the following: ACTIVE: The stream URL is valid and can start stream sessions. EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions. REVOKED: The stream URL was revoked and can no longer start stream sessions. LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions." StatusReason: - $ref: "#/components/schemas/StreamSessionStatusReason" - description: "A short description of the reason the stream session is in ERROR status or TERMINATED status. ERROR status reasons: applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists. internalError: An internal service error occurred. Start a new stream session to continue streaming. invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request. placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available. TERMINATED status reasons: apiTerminated: The stream session was terminated by an API call to TerminateStreamSession. applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running. connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds. maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds. reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection." - Protocol: - $ref: "#/components/schemas/Protocol" - description: The data transfer protocol in use with the stream session. - LastUpdatedAt: + $ref: "#/components/schemas/StreamUrlStatusReason" + description: "Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following: userRevoked: You revoked the stream URL. revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions. revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended. streamGroupDeleted: The stream group was deleted, which revoked the stream URL. applicationDeleted: The application was deleted, which revoked the stream URL." + ExpiresAt: $ref: "#/components/schemas/Timestamp" - description: "A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + description: "The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." CreatedAt: $ref: "#/components/schemas/Timestamp" description: "A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC)." + UsageLimit: + $ref: "#/components/schemas/UsageLimit" + description: The maximum number of times the stream URL can start a stream session. + RemainingUses: + $ref: "#/components/schemas/RemainingUses" + description: The number of times the stream URL can still be used to start a stream session. + StreamGroupArn: + $ref: "#/components/schemas/Arn" + description: "The stream group that runs the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4." ApplicationArn: $ref: "#/components/schemas/Arn" - description: "An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." - ExportFilesMetadata: - $ref: "#/components/schemas/ExportFilesMetadata" - description: Provides details about the stream session's exported files. - Location: - $ref: "#/components/schemas/LocationName" - description: The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide. - ListStreamSessionsByAccountOutput: - type: object - properties: - Items: - $ref: "#/components/schemas/StreamSessionSummaryList" - description: A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. - NextToken: - $ref: "#/components/schemas/NextToken" - description: A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. + description: "The application that runs in the stream sessions. This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6." + SessionLengthSeconds: + $ref: "#/components/schemas/SessionLengthSeconds" + description: The maximum length of time, in seconds, that a stream session started from this stream URL can run. + Description: + $ref: "#/components/schemas/Description" + description: The descriptive label for the stream URL. + required: + - Arn ListTagsForResourceResponse: type: object properties: @@ -1548,13 +2068,11 @@ components: type: array items: $ref: "#/components/schemas/String" - LocationList: - type: array - items: - $ref: "#/components/schemas/LocationName" - EnvironmentVariables: - type: object - properties: {} + RevocationMode: + type: string + enum: + - REVOKE_URL + - REVOKE_AND_TERMINATE_SESSIONS StartStreamSessionOutput: type: object properties: @@ -1622,6 +2140,12 @@ components: ExportFilesMetadata: $ref: "#/components/schemas/ExportFilesMetadata" description: Provides details about the stream session's exported files. + RoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the AWS Identity and Access Management (IAM) role that Amazon GameLift Streams assumes on behalf of your application during the stream session. + DisplayConfiguration: + $ref: "#/components/schemas/DisplayConfiguration" + description: The configuration for the stream session's virtual monitor. TagResourceResponse: type: object TagKeyList: @@ -1698,7 +2222,7 @@ components: description: "This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group." StreamClass: $ref: "#/components/schemas/StreamClass" - description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor Core GPU. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" + description: "The target stream quality for the stream group. A stream class can be one of the following: gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM Tenancy: Supports up to 4 concurrent stream sessions gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM Tenancy: Supports up to 12 concurrent stream sessions gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM Tenancy: Supports 1 concurrent stream session gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM Tenancy: Supports up to 2 concurrent stream sessions gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. Reference resolution: 1080p Reference frame rate: 60 fps Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM Tenancy: Supports 1 concurrent stream session" Id: $ref: "#/components/schemas/Id" description: "A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4." @@ -1912,6 +2436,12 @@ components: name: stream_sessions title: stream_sessions methods: + create_stream_session_admin_shell: + operation: + $ref: "#/paths/~1streamgroups~1{identifier}~1streamsessions~1{stream_session_identifier}~1access/post" + response: + openAPIDocKey: "200" + mediaType: application/json create_stream_session_connection: operation: $ref: "#/paths/~1streamgroups~1{identifier}~1streamsessions~1{stream_session_identifier}~1connections/post" @@ -1968,9 +2498,85 @@ components: - $ref: "#/components/x-stackQL-resources/stream_sessions/methods/list_stream_sessions" insert: - $ref: "#/components/x-stackQL-resources/stream_sessions/methods/create_stream_session_connection" + - $ref: "#/components/x-stackQL-resources/stream_sessions/methods/create_stream_session_admin_shell" update: [] delete: - $ref: "#/components/x-stackQL-resources/stream_sessions/methods/terminate_stream_session" + stream_urls: + id: aws.gameliftstreams.stream_urls + name: stream_urls + title: stream_urls + methods: + create_stream_url: + operation: + $ref: "#/paths/~1streamgroups~1{identifier}~1streamurls/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_stream_url: + operation: + $ref: "#/paths/~1streamgroups~1{identifier}~1streamurls~1{stream_url_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_stream_urls: + operation: + $ref: "#/paths/~1streamurls/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: query + responseToken: + key: $.NextToken + location: body + revoke_stream_url: + operation: + $ref: "#/paths/~1streamgroups~1{identifier}~1streamurls~1{stream_url_identifier}~1revoke/post" + response: + openAPIDocKey: "204" + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/stream_urls/methods/get_stream_url" + - $ref: "#/components/x-stackQL-resources/stream_urls/methods/list_stream_urls" + insert: + - $ref: "#/components/x-stackQL-resources/stream_urls/methods/create_stream_url" + update: + - $ref: "#/components/x-stackQL-resources/stream_urls/methods/revoke_stream_url" + delete: [] + application_shader_caches: + id: aws.gameliftstreams.application_shader_caches + name: application_shader_caches + title: application_shader_caches + methods: + list_application_shader_caches: + operation: + $ref: "#/paths/~1applications~1{identifier}~1shadercaches/get" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/application_shader_caches/methods/list_application_shader_caches" + insert: [] + update: [] + delete: [] stream_sessions_by_accounts: id: aws.gameliftstreams.stream_sessions_by_accounts name: stream_sessions_by_accounts diff --git a/providers/src/aws/v00.00.00000/services/geo_maps.yaml b/providers/src/aws/v00.00.00000/services/geo_maps.yaml index e84e7a86..cf4fcf32 100644 --- a/providers/src/aws/v00.00.00000/services/geo_maps.yaml +++ b/providers/src/aws/v00.00.00000/services/geo_maps.yaml @@ -16,7 +16,7 @@ servers: description: AWS region description: Regional endpoint for geo-maps paths: - /glyphs/{font_stack}/{font_unicode_range}: + /v2/glyphs/{font_stack}/{font_unicode_range}: get: operationId: GetGlyphs description: GetGlyphs returns the map's glyphs. For more information, see Style labels with glyphs in the Amazon Location Service Developer Guide. @@ -40,7 +40,7 @@ paths: application/json: schema: $ref: "#/components/schemas/GetGlyphsResponse" - /styles/{style}/{color_scheme}/{variant}/sprites/{file_name}: + /v2/styles/{style}/{color_scheme}/{variant}/sprites/{file_name}: get: operationId: GetSprites description: GetSprites returns the map's sprites. For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide. @@ -76,10 +76,10 @@ paths: application/json: schema: $ref: "#/components/schemas/GetSpritesResponse" - /static/{file_name}: + /v2/static/{file_name}: get: operationId: GetStaticMap - description: "This operation is not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. For more information, see the following topics in the Amazon Location Service Developer Guide: Static maps Customize static maps Overlay on the static map" + description: "GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see the following topics in the Amazon Location Service Developer Guide: Static maps Customize static maps Overlay on the static map" parameters: - name: bounding-box in: query @@ -208,7 +208,7 @@ paths: application/json: schema: $ref: "#/components/schemas/GetStaticMapResponse" - /styles/{style}/descriptor: + /v2/styles/{style}/descriptor: get: operationId: GetStyleDescriptor description: GetStyleDescriptor returns information about the style. For more information, see Style dynamic maps in the Amazon Location Service Developer Guide. @@ -261,6 +261,18 @@ paths: schema: $ref: "#/components/schemas/Buildings" description: "Adjusts how building details are rendered on the map. The following building styles are currently supported: Buildings3D: Displays buildings as three-dimensional extrusions on the map. Buildings3D is valid only for the Standard and Monochrome map styles." + - name: poi-density + in: query + required: false + schema: + $ref: "#/components/schemas/PoiDensity" + description: Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels. Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density. The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest. This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style. + - name: poi-categories + in: query + required: false + schema: + $ref: "#/components/schemas/PoiCategoryList" + description: "Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories. The following categories are currently supported: FoodAndDrink Entertainment SightsAndMuseums Transportation Accommodations LeisureAndOutdoor Shopping BusinessAndServices FacilitiesAndBuildings Specify each category as a separate poi-categories query parameter. Duplicate values are rejected. This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category. This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style." - name: key in: query required: false @@ -274,7 +286,7 @@ paths: application/json: schema: $ref: "#/components/schemas/GetStyleDescriptorResponse" - /tiles/{tileset}/{z}/{x}/{y}: + /v2/tiles/{tileset}/{z}/{x}/{y}: get: operationId: GetTile description: GetTile returns a tile. Map tiles are used by clients to render a map. They're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. For more information, see Tiles in the Amazon Location Service Developer Guide. @@ -564,6 +576,31 @@ components: type: string enum: - Buildings3D + PoiDensity: + type: string + enum: + - "Off" + - VerySparse + - Sparse + - Default + - Dense + - VeryDense + PoiCategoryList: + type: array + items: + $ref: "#/components/schemas/PoiCategory" + PoiCategory: + type: string + enum: + - FoodAndDrink + - Entertainment + - SightsAndMuseums + - Transportation + - Accommodations + - LeisureAndOutdoor + - Shopping + - BusinessAndServices + - FacilitiesAndBuildings GetStyleDescriptorResponse: type: object properties: @@ -638,7 +675,7 @@ components: methods: get_glyphs: operation: - $ref: "#/paths/~1glyphs~1{font_stack}~1{font_unicode_range}/get" + $ref: "#/paths/~1v2~1glyphs~1{font_stack}~1{font_unicode_range}/get" response: openAPIDocKey: "200" mediaType: application/json @@ -655,7 +692,7 @@ components: methods: get_sprites: operation: - $ref: "#/paths/~1styles~1{style}~1{color_scheme}~1{variant}~1sprites~1{file_name}/get" + $ref: "#/paths/~1v2~1styles~1{style}~1{color_scheme}~1{variant}~1sprites~1{file_name}/get" response: openAPIDocKey: "200" mediaType: application/json @@ -672,7 +709,7 @@ components: methods: get_static_map: operation: - $ref: "#/paths/~1static~1{file_name}/get" + $ref: "#/paths/~1v2~1static~1{file_name}/get" response: openAPIDocKey: "200" mediaType: application/json @@ -691,7 +728,7 @@ components: methods: get_style_descriptor: operation: - $ref: "#/paths/~1styles~1{style}~1descriptor/get" + $ref: "#/paths/~1v2~1styles~1{style}~1descriptor/get" response: openAPIDocKey: "200" mediaType: application/json @@ -710,7 +747,7 @@ components: methods: get_tile: operation: - $ref: "#/paths/~1tiles~1{tileset}~1{z}~1{x}~1{y}/get" + $ref: "#/paths/~1v2~1tiles~1{tileset}~1{z}~1{x}~1{y}/get" response: openAPIDocKey: "200" mediaType: application/json diff --git a/providers/src/aws/v00.00.00000/services/geo_places.yaml b/providers/src/aws/v00.00.00000/services/geo_places.yaml index fc62b12c..eb9780a0 100644 --- a/providers/src/aws/v00.00.00000/services/geo_places.yaml +++ b/providers/src/aws/v00.00.00000/services/geo_places.yaml @@ -19,7 +19,7 @@ paths: /v2/autocomplete: post: operationId: Autocomplete - description: Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. For more information, see Autocomplete in the Amazon Location Service Developer Guide. + description: Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see Autocomplete in the Amazon Location Service Developer Guide. parameters: - name: key in: query @@ -64,7 +64,7 @@ paths: /v2/geocode: post: operationId: Geocode - description: Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Geocode in the Amazon Location Service Developer Guide. + description: Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see Geocode in the Amazon Location Service Developer Guide. parameters: - name: key in: query @@ -97,6 +97,12 @@ paths: $ref: "#/components/schemas/CountryCode" IntendedUse: $ref: "#/components/schemas/GeocodeIntendedUse" + PostalCodeMode: + $ref: "#/components/schemas/PostalCodeMode" + AddressTranslations: + $ref: "#/components/schemas/AddressTranslationComponentList" + AddressNamesMode: + $ref: "#/components/schemas/GeocodeAddressNamesMode" responses: "200": description: Success @@ -145,6 +151,12 @@ paths: schema: $ref: "#/components/schemas/ApiKey" description: "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request." + - name: address-names-mode + in: query + required: false + schema: + $ref: "#/components/schemas/GetPlaceAddressNamesMode" + description: Specifies how address names are returned. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States. responses: "200": description: Success @@ -188,6 +200,8 @@ paths: $ref: "#/components/schemas/ReverseGeocodeIntendedUse" Heading: $ref: "#/components/schemas/Heading" + AddressNamesMode: + $ref: "#/components/schemas/ReverseGeocodeAddressNamesMode" required: - QueryPosition responses: @@ -200,7 +214,7 @@ paths: /v2/search-nearby: post: operationId: SearchNearby - description: SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. For more information, see Search Nearby in the Amazon Location Service Developer Guide. + description: SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see Search Nearby in the Amazon Location Service Developer Guide. parameters: - name: key in: query @@ -280,6 +294,8 @@ paths: $ref: "#/components/schemas/SearchTextIntendedUse" NextToken: $ref: "#/components/schemas/Token" + TravelMode: + $ref: "#/components/schemas/SearchTextTravelMode" responses: "200": description: Success @@ -323,6 +339,8 @@ paths: $ref: "#/components/schemas/CountryCode" IntendedUse: $ref: "#/components/schemas/SuggestIntendedUse" + TravelMode: + $ref: "#/components/schemas/SuggestTravelMode" required: - QueryText responses: @@ -451,11 +469,18 @@ components: enum: - Locality - PostalCode + - Street + - Intersection + - PointAddress + - InterpolatedAddress + - Country + - Region PostalCodeMode: type: string enum: - MergeAllSpannedLocalities - EnumerateSpannedLocalities + - EnumerateSpannedDistricts AutocompleteAdditionalFeatureList: type: array items: @@ -517,6 +542,9 @@ components: Highlights: $ref: "#/components/schemas/AutocompleteHighlights" description: Indicates the starting and ending index of the place in the text query that match the found title. + EstimatedPointAddress: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates that the coordinates of the position and access points of the point address are estimated. required: - PlaceId - PlaceType @@ -919,6 +947,8 @@ components: type: array items: $ref: "#/components/schemas/HighlightList" + SensitiveBoolean: + type: boolean GeocodeRequestQueryTextString: type: string minLength: 1 @@ -1018,6 +1048,10 @@ components: - Street - PointAddress - InterpolatedAddress + - SecondaryAddress + - PointOfInterest + - Country + - Region GeocodeAdditionalFeatureList: type: array items: @@ -1034,6 +1068,22 @@ components: enum: - SingleUse - Storage + AddressTranslationComponentList: + type: array + items: + $ref: "#/components/schemas/AddressTranslationComponent" + AddressTranslationComponent: + type: string + enum: + - District + - Locality + - Region + - SubRegion + GeocodeAddressNamesMode: + type: string + enum: + - Matched + - Administrative GeocodeResponse: type: object properties: @@ -1110,6 +1160,12 @@ components: SecondaryAddresses: $ref: "#/components/schemas/RelatedPlaceList" description: "All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI." + Translations: + $ref: "#/components/schemas/TranslationDetails" + description: All name translations and alternative names for the requested address fields in all available languages. + EstimatedPointAddress: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates that the coordinates of the position and access points of the point address are estimated. required: - PlaceId - PlaceType @@ -1122,8 +1178,6 @@ components: type: string minLength: 0 maxLength: 200 - SensitiveBoolean: - type: boolean PostalCodeDetailsList: type: array items: @@ -1262,6 +1316,27 @@ components: Position: $ref: "#/components/schemas/Position" description: "The position in World Geodetic System (WGS 84) format: [longitude, latitude]." + Type: + $ref: "#/components/schemas/AccessPointType" + description: The type of access point, indicating its intended use. Only applies to results of type place. + Primary: + $ref: "#/components/schemas/SensitiveBoolean" + description: Set to true for the primary access position when the place has more than one access point. + Label: + $ref: "#/components/schemas/SensitiveString" + description: A short textual description of the access point, such as "North Entrance". + AccessPointType: + type: string + enum: + - Delivery + - Emergency + - Entrance + - Loading + - Other + - Parking + - Taxi + SensitiveString: + type: string TimeZone: description: The time zone in which the place is located. type: object @@ -1459,6 +1534,9 @@ components: SecondaryAddressComponents: $ref: "#/components/schemas/ParsedQuerySecondaryAddressComponentList" description: "Parsed secondary address components from the provided query text. Coverage for ParsedQuery.Address.SecondaryAddressComponents is available in the following countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA" + OtherComponents: + $ref: "#/components/schemas/ParsedQueryComponentList" + description: Additional information extracted from the query that does not correspond to standard address components. ParsedQuerySecondaryAddressComponentList: type: array items: @@ -1585,6 +1663,82 @@ components: type: array items: $ref: "#/components/schemas/RelatedPlace" + TranslationDetails: + description: Translation details for the address, including alternative names and translations in available languages. + type: object + properties: + Locality: + $ref: "#/components/schemas/AdminNamesList" + description: A list of administrative names and translations for the locality address component. + Region: + $ref: "#/components/schemas/AdminNamesList" + description: A list of administrative names and translations for the region address component. + District: + $ref: "#/components/schemas/AdminNamesList" + description: A list of administrative names and translations for the district address component. + SubRegion: + $ref: "#/components/schemas/AdminNamesList" + description: A list of administrative names and translations for the sub-region address component. + AdminNamesList: + type: array + items: + $ref: "#/components/schemas/AdminNames" + AdminNames: + description: The official administrative names for an address component, returned when AddressNamesMode is set to Administrative. + type: object + properties: + Names: + $ref: "#/components/schemas/TranslationNameList" + description: A list of translation names for the administrative address component, including name variants and translations in available languages. + Preference: + $ref: "#/components/schemas/AdminNamesPreference" + description: Indicates the preference level of the administrative name. Valid values are Primary and Alternative. + required: + - Names + TranslationNameList: + type: array + items: + $ref: "#/components/schemas/TranslationName" + TranslationName: + description: A translation or alternative name for an address component. + type: object + properties: + Value: + $ref: "#/components/schemas/TranslationNameValueString" + description: The translated or alternative name value. + Language: + $ref: "#/components/schemas/LanguageTag" + description: A BCP 47 compliant language code for the translation name. + Type: + $ref: "#/components/schemas/TranslationNameType" + description: The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym. + Primary: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates this is the primary name variant for the given language. + Transliterated: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates this name is a transliterated version rather than a native script translation. + required: + - Value + - Type + TranslationNameValueString: + type: string + minLength: 1 + maxLength: 200 + TranslationNameType: + type: string + enum: + - Abbreviation + - AreaCode + - BaseName + - Exonym + - Shortened + - Synonym + AdminNamesPreference: + type: string + enum: + - Alternative + - Primary GetPlaceRequestPlaceIdString: type: string minLength: 0 @@ -1601,11 +1755,16 @@ components: - Access - Contact - SecondaryAddresses + - CrossReferences GetPlaceIntendedUse: type: string enum: - SingleUse - Storage + GetPlaceAddressNamesMode: + type: string + enum: + - Administrative GetPlaceResponse: type: object properties: @@ -1672,6 +1831,15 @@ components: SecondaryAddresses: $ref: "#/components/schemas/RelatedPlaceList" description: "All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI." + PlaceAttributes: + $ref: "#/components/schemas/PlaceAttributeList" + description: A list of place attributes for the result, such as whether the business offers drive-through service. + EstimatedPointAddress: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates that the coordinates of the position and access points of the point address are estimated. + CrossReferences: + $ref: "#/components/schemas/CrossReferenceList" + description: The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled. required: - PlaceId - PlaceType @@ -1881,6 +2049,42 @@ components: Street: $ref: "#/components/schemas/PhonemeTranscriptionList" description: How to pronounce the name of the street results should be present in. + PlaceAttributeList: + type: array + items: + $ref: "#/components/schemas/PlaceAttribute" + PlaceAttribute: + type: string + enum: + - DriveThrough + CrossReferenceList: + type: array + items: + $ref: "#/components/schemas/CrossReference" + CrossReference: + description: A reference to a third-party supplier's identifier for a place, enabling correlation of places across external systems. + type: object + properties: + Source: + $ref: "#/components/schemas/CrossReferenceSourceString" + description: The name of the third-party data supplier (for example, Yelp or TripAdvisor). + SourcePlaceId: + $ref: "#/components/schemas/CrossReferenceSourcePlaceIdString" + description: The place identifier assigned by the third-party supplier. + SourceCategories: + $ref: "#/components/schemas/CategoryList" + description: The list of place category identifiers this supplier reference relates to. + required: + - Source + - SourcePlaceId + CrossReferenceSourceString: + type: string + minLength: 1 + maxLength: 100 + CrossReferenceSourcePlaceIdString: + type: string + minLength: 1 + maxLength: 100 ReverseGeocodeRequestQueryRadiusLong: type: integer format: int64 @@ -1909,6 +2113,8 @@ components: - Street - PointAddress - InterpolatedAddress + - SecondaryAddress + - PointOfInterest ReverseGeocodeAdditionalFeatureList: type: array items: @@ -1929,6 +2135,10 @@ components: format: double minimum: 0 maximum: 360 + ReverseGeocodeAddressNamesMode: + type: string + enum: + - Administrative ReverseGeocodeResponse: type: object properties: @@ -1993,6 +2203,12 @@ components: Intersections: $ref: "#/components/schemas/IntersectionList" description: All Intersections that are near the provided address. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. + MainAddress: + $ref: "#/components/schemas/RelatedPlace" + description: The main address corresponding to a place of type Secondary Address. + EstimatedPointAddress: + $ref: "#/components/schemas/SensitiveBoolean" + description: If true, indicates that the coordinates of the position and access points of the point address are estimated. required: - PlaceId - PlaceType @@ -2077,6 +2293,7 @@ components: - Phonemes - Access - Contact + - CrossReferences SearchNearbyIntendedUse: type: string enum: @@ -2162,6 +2379,12 @@ components: Phonemes: $ref: "#/components/schemas/PhonemeDetails" description: How the various components of the result's address are pronounced in various languages. + PlaceAttributes: + $ref: "#/components/schemas/PlaceAttributeList" + description: A list of place attributes for the result, such as whether the business offers drive-through service. + CrossReferences: + $ref: "#/components/schemas/CrossReferenceList" + description: The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled. required: - PlaceId - PlaceType @@ -2209,11 +2432,18 @@ components: - Phonemes - Access - Contact + - CrossReferences SearchTextIntendedUse: type: string enum: - SingleUse - Storage + SearchTextTravelMode: + type: string + enum: + - Car + - Scooter + - Truck SearchTextResponse: type: object properties: @@ -2274,7 +2504,7 @@ components: description: List of potential contact methods for the result/place. OpeningHours: $ref: "#/components/schemas/OpeningHoursList" - description: List of opening hours objects. + description: List of opening hours objects. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. AccessPoints: $ref: "#/components/schemas/AccessPointList" description: "Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]." @@ -2290,6 +2520,12 @@ components: Phonemes: $ref: "#/components/schemas/PhonemeDetails" description: How the various components of the result's address are pronounced in various languages. + PlaceAttributes: + $ref: "#/components/schemas/PlaceAttributeList" + description: A list of place attributes for the result, such as whether the business offers drive-through service. + CrossReferences: + $ref: "#/components/schemas/CrossReferenceList" + description: The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled. required: - PlaceId - PlaceType @@ -2337,10 +2573,17 @@ components: - TimeZone - Phonemes - Access + - CrossReferences SuggestIntendedUse: type: string enum: - SingleUse + SuggestTravelMode: + type: string + enum: + - Car + - Scooter + - Truck SuggestResponse: type: object properties: @@ -2435,6 +2678,12 @@ components: Phonemes: $ref: "#/components/schemas/PhonemeDetails" description: How the various components of the result's address are pronounced in various languages. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. + PlaceAttributes: + $ref: "#/components/schemas/PlaceAttributeList" + description: A list of place attributes for the result, such as whether the business offers drive-through service. + CrossReferences: + $ref: "#/components/schemas/CrossReferenceList" + description: The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled. SuggestPlaceResultPlaceIdString: type: string minLength: 1 diff --git a/providers/src/aws/v00.00.00000/services/glue.yaml b/providers/src/aws/v00.00.00000/services/glue.yaml index 85e62160..afc47169 100644 --- a/providers/src/aws/v00.00.00000/services/glue.yaml +++ b/providers/src/aws/v00.00.00000/services/glue.yaml @@ -18,6 +18,52 @@ servers: description: AWS region description: Regional endpoint for glue paths: + /AssociateGlossaryTerms: + post: + operationId: AssociateGlossaryTerms + description: Associates one or more glossary terms with an asset in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.AssociateGlossaryTerms + default: AWSGlue.AssociateGlossaryTerms + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to associate glossary terms with. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form. When specified along with itemIdentifier, the glossary terms are associated with an item within the iterable form rather than the asset itself. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form. Required when iterableFormName is specified. + GlossaryTermIdentifiers: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The list of glossary term identifiers to associate with the asset. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - AssetIdentifier + - GlossaryTermIdentifiers + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AssociateGlossaryTermsResponse" /BatchCreatePartition: post: operationId: BatchCreatePartition @@ -367,6 +413,39 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetDataQualityResultResponse" + /BatchGetDataQualityRulesetEvaluationRun: + post: + operationId: BatchGetDataQualityRulesetEvaluationRun + description: Retrieves the details of multiple evaluation runs in a single request. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.BatchGetDataQualityRulesetEvaluationRun + default: AWSGlue.BatchGetDataQualityRulesetEvaluationRun + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + RunIds: + $ref: "#/components/schemas/DataQualityRulesetEvaluationRunIdList" + description: A list of unique run identifiers for the evaluation runs to retrieve. + required: + - RunIds + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetDataQualityRulesetEvaluationRunResponse" /BatchGetDevEndpoints: post: operationId: BatchGetDevEndpoints @@ -400,6 +479,47 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetDevEndpointsResponse" + /BatchGetIterableForms: + post: + operationId: BatchGetIterableForms + description: Retrieves multiple items from an iterable form on an asset in Glue Data Catalog in a single request. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.BatchGetIterableForms + default: AWSGlue.BatchGetIterableForms + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form to retrieve items from. + ItemIdentifiers: + $ref: "#/components/schemas/ItemIdentifierList" + description: The list of item identifiers to retrieve. Each identifier can be an item ID or item name. + required: + - AssetIdentifier + - IterableFormName + - ItemIdentifiers + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetIterableFormsResponse" /BatchGetJobs: post: operationId: BatchGetJobs @@ -1378,6 +1498,88 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateDevEndpointResponse" + /CreateGlossary: + post: + operationId: CreateGlossary + description: Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.CreateGlossary + default: AWSGlue.CreateGlossary + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/GlossaryName" + description: The name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The description of the glossary. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateGlossaryResponse" + /CreateGlossaryTerm: + post: + operationId: CreateGlossaryTerm + description: Creates a glossary term within a business glossary in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.CreateGlossaryTerm + default: AWSGlue.CreateGlossaryTerm + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + GlossaryIdentifier: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary in which to create the term. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: A short description of the glossary term. + LongDescription: + $ref: "#/components/schemas/GlossaryLongDescription" + description: A long description of the glossary term. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - GlossaryIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateGlossaryTermResponse" /CreateGlueIdentityCenterConfiguration: post: operationId: CreateGlueIdentityCenterConfiguration @@ -2051,6 +2253,9 @@ paths: RequestOrigin: $ref: "#/components/schemas/OrchestrationNameString" description: The origin of the request. + SessionType: + $ref: "#/components/schemas/SessionType" + description: The type of session to create. required: - Role - Command @@ -2342,6 +2547,115 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateWorkflowResponse" + /DeleteAsset: + post: + operationId: DeleteAsset + description: Deletes an asset from Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteAsset + default: AWSGlue.DeleteAsset + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to delete. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssetResponse" + /DeleteAssetType: + post: + operationId: DeleteAssetType + description: Deletes an asset type from Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteAssetType + default: AWSGlue.DeleteAssetType + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type to delete. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssetTypeResponse" + /DeleteAttachment: + post: + operationId: DeleteAttachment + description: Deletes a form attachment from an asset in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteAttachment + default: AWSGlue.DeleteAttachment + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset from which to delete the attachment. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form. When specified along with itemIdentifier, the attachment is deleted from an item within the iterable form rather than from the asset itself. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form. Required when iterableFormName is specified. + AttachmentName: + $ref: "#/components/schemas/AttachmentName" + description: The name of the attachment to delete. + required: + - AssetIdentifier + - AttachmentName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAttachmentResponse" /DeleteBlueprint: post: operationId: DeleteBlueprint @@ -2797,10 +3111,10 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteDevEndpointResponse" - /DeleteGlueIdentityCenterConfiguration: + /DeleteFormType: post: - operationId: DeleteGlueIdentityCenterConfiguration - description: Deletes the existing Glue Identity Center configuration, removing the integration between Glue and Amazon Web Services IAM Identity Center. + operationId: DeleteFormType + description: Deletes a form type from Glue Data Catalog. A form type cannot be deleted if it is still referenced by an asset type. parameters: - name: X-Amz-Target in: header @@ -2809,25 +3123,31 @@ paths: schema: type: string enum: - - AWSGlue.DeleteGlueIdentityCenterConfiguration - default: AWSGlue.DeleteGlueIdentityCenterConfiguration + - AWSGlue.DeleteFormType + default: AWSGlue.DeleteFormType requestBody: required: true content: application/x-amz-json-1.1: schema: type: object + properties: + Identifier: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type to delete. + required: + - Identifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteGlueIdentityCenterConfigurationResponse" - /DeleteIntegration: + $ref: "#/components/schemas/DeleteFormTypeResponse" + /DeleteGlossary: post: - operationId: DeleteIntegration - description: Deletes the specified Zero-ETL integration. + operationId: DeleteGlossary + description: Deletes a business glossary from Glue Data Catalog. A glossary cannot be deleted if it still contains glossary terms. parameters: - name: X-Amz-Target in: header @@ -2836,8 +3156,8 @@ paths: schema: type: string enum: - - AWSGlue.DeleteIntegration - default: AWSGlue.DeleteIntegration + - AWSGlue.DeleteGlossary + default: AWSGlue.DeleteGlossary requestBody: required: true content: @@ -2845,22 +3165,22 @@ paths: schema: type: object properties: - IntegrationIdentifier: - $ref: "#/components/schemas/String128" - description: The Amazon Resource Name (ARN) for the integration. + Identifier: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary to delete. required: - - IntegrationIdentifier + - Identifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteIntegrationResponse" - /DeleteIntegrationResourceProperty: + $ref: "#/components/schemas/DeleteGlossaryResponse" + /DeleteGlossaryTerm: post: - operationId: DeleteIntegrationResourceProperty - description: This API is used for deleting the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). + operationId: DeleteGlossaryTerm + description: Deletes a glossary term from Glue Data Catalog. parameters: - name: X-Amz-Target in: header @@ -2869,8 +3189,8 @@ paths: schema: type: string enum: - - AWSGlue.DeleteIntegrationResourceProperty - default: AWSGlue.DeleteIntegrationResourceProperty + - AWSGlue.DeleteGlossaryTerm + default: AWSGlue.DeleteGlossaryTerm requestBody: required: true content: @@ -2878,22 +3198,22 @@ paths: schema: type: object properties: - ResourceArn: - $ref: "#/components/schemas/String512" - description: The connection ARN of the source, or the database ARN of the target. + Identifier: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term to delete. required: - - ResourceArn + - Identifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteIntegrationResourcePropertyResponse" - /DeleteIntegrationTableProperties: + $ref: "#/components/schemas/DeleteGlossaryTermResponse" + /DeleteGlueIdentityCenterConfiguration: post: - operationId: DeleteIntegrationTableProperties - description: Deletes the table properties that have been created for the tables that need to be replicated. + operationId: DeleteGlueIdentityCenterConfiguration + description: Deletes the existing Glue Identity Center configuration, removing the integration between Glue and Amazon Web Services IAM Identity Center. parameters: - name: X-Amz-Target in: header @@ -2902,35 +3222,25 @@ paths: schema: type: string enum: - - AWSGlue.DeleteIntegrationTableProperties - default: AWSGlue.DeleteIntegrationTableProperties + - AWSGlue.DeleteGlueIdentityCenterConfiguration + default: AWSGlue.DeleteGlueIdentityCenterConfiguration requestBody: required: true content: application/x-amz-json-1.1: schema: type: object - properties: - ResourceArn: - $ref: "#/components/schemas/String512" - description: The connection ARN of the source, or the database ARN of the target. - TableName: - $ref: "#/components/schemas/String128" - description: The name of the table to be replicated. - required: - - ResourceArn - - TableName responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteIntegrationTablePropertiesResponse" - /DeleteJob: + $ref: "#/components/schemas/DeleteGlueIdentityCenterConfigurationResponse" + /DeleteIntegration: post: - operationId: DeleteJob - description: Deletes a specified job definition. If the job definition is not found, no exception is thrown. + operationId: DeleteIntegration + description: Deletes the specified Zero-ETL integration. parameters: - name: X-Amz-Target in: header @@ -2939,8 +3249,8 @@ paths: schema: type: string enum: - - AWSGlue.DeleteJob - default: AWSGlue.DeleteJob + - AWSGlue.DeleteIntegration + default: AWSGlue.DeleteIntegration requestBody: required: true content: @@ -2948,10 +3258,113 @@ paths: schema: type: object properties: - JobName: - $ref: "#/components/schemas/NameString" - description: The name of the job definition to delete. - required: + IntegrationIdentifier: + $ref: "#/components/schemas/String128" + description: The Amazon Resource Name (ARN) for the integration. + required: + - IntegrationIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntegrationResponse" + /DeleteIntegrationResourceProperty: + post: + operationId: DeleteIntegrationResourceProperty + description: This API is used for deleting the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteIntegrationResourceProperty + default: AWSGlue.DeleteIntegrationResourceProperty + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String512" + description: The connection ARN of the source, or the database ARN of the target. + required: + - ResourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntegrationResourcePropertyResponse" + /DeleteIntegrationTableProperties: + post: + operationId: DeleteIntegrationTableProperties + description: Deletes the table properties that have been created for the tables that need to be replicated. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteIntegrationTableProperties + default: AWSGlue.DeleteIntegrationTableProperties + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String512" + description: The connection ARN of the source, or the database ARN of the target. + TableName: + $ref: "#/components/schemas/String128" + description: The name of the table to be replicated. + required: + - ResourceArn + - TableName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntegrationTablePropertiesResponse" + /DeleteJob: + post: + operationId: DeleteJob + description: Deletes a specified job definition. If the job definition is not found, no exception is thrown. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DeleteJob + default: AWSGlue.DeleteJob + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobName: + $ref: "#/components/schemas/NameString" + description: The name of the job definition to delete. + required: - JobName responses: "200": @@ -3706,6 +4119,118 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeIntegrationsResponse" + /DisassociateGlossaryTerms: + post: + operationId: DisassociateGlossaryTerms + description: Removes the association of one or more glossary terms from an asset in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.DisassociateGlossaryTerms + default: AWSGlue.DisassociateGlossaryTerms + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to disassociate glossary terms from. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form. When specified along with itemIdentifier, the glossary terms are disassociated from an item within the iterable form rather than the asset itself. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form. Required when iterableFormName is specified. + GlossaryTermIdentifiers: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The list of glossary term identifiers to disassociate from the asset. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - AssetIdentifier + - GlossaryTermIdentifiers + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisassociateGlossaryTermsResponse" + /GetAsset: + post: + operationId: GetAsset + description: Retrieves the metadata for an asset in Glue Data Catalog, including its forms, additional attachments, and associated glossary terms. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetAsset + default: AWSGlue.GetAsset + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to retrieve. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAssetOutput" + /GetAssetType: + post: + operationId: GetAssetType + description: Retrieves an asset type in Glue Data Catalog by its identifier. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetAssetType + default: AWSGlue.GetAssetType + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type to retrieve. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAssetTypeResponse" /GetBlueprint: post: operationId: GetBlueprint @@ -4417,6 +4942,46 @@ paths: application/json: schema: $ref: "#/components/schemas/GetCustomEntityTypeResponse" + /GetDashboardUrl: + post: + operationId: GetDashboardUrl + description: Retrieves the URL for the Spark monitoring dashboard for a Glue resource. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetDashboardUrl + default: AWSGlue.GetDashboardUrl + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceId: + $ref: "#/components/schemas/NameString" + description: The unique identifier of the resource for which to retrieve the dashboard URL. + ResourceType: + $ref: "#/components/schemas/GlueResourceType" + description: The type of the resource. Valid values are SESSION and JOB. + RequestOrigin: + $ref: "#/components/schemas/OrchestrationNameString" + description: The origin of the request. + required: + - ResourceId + - ResourceType + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDashboardUrlResponse" /GetDataCatalogEncryptionSettings: post: operationId: GetDataCatalogEncryptionSettings @@ -4448,6 +5013,33 @@ paths: application/json: schema: $ref: "#/components/schemas/GetDataCatalogEncryptionSettingsResponse" + /GetDataCatalogExportConfiguration: + post: + operationId: GetDataCatalogExportConfiguration + description: Retrieves the current export configuration for the Glue Data Catalog. The export configuration controls whether catalog metadata is exported to S3 Tables. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetDataCatalogExportConfiguration + default: AWSGlue.GetDataCatalogExportConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDataCatalogExportConfigurationOutput" /GetDataQualityModel: post: operationId: GetDataQualityModel @@ -4887,10 +5479,10 @@ paths: application/json: schema: $ref: "#/components/schemas/GetEntityRecordsOutputDisplay" - /GetGlueIdentityCenterConfiguration: + /GetFormType: post: - operationId: GetGlueIdentityCenterConfiguration - description: Retrieves the current Glue Identity Center configuration details, including the associated Identity Center instance and application information. + operationId: GetFormType + description: Retrieves a form type in Glue Data Catalog by its identifier. parameters: - name: X-Amz-Target in: header @@ -4899,25 +5491,31 @@ paths: schema: type: string enum: - - AWSGlue.GetGlueIdentityCenterConfiguration - default: AWSGlue.GetGlueIdentityCenterConfiguration + - AWSGlue.GetFormType + default: AWSGlue.GetFormType requestBody: required: true content: application/x-amz-json-1.1: schema: type: object + properties: + Identifier: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type to retrieve. + required: + - Identifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/GetGlueIdentityCenterConfigurationResponse" - /GetIntegrationResourceProperty: + $ref: "#/components/schemas/GetFormTypeResponse" + /GetGlossary: post: - operationId: GetIntegrationResourceProperty - description: This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target) + operationId: GetGlossary + description: Retrieves a business glossary in Glue Data Catalog by its identifier. parameters: - name: X-Amz-Target in: header @@ -4926,8 +5524,8 @@ paths: schema: type: string enum: - - AWSGlue.GetIntegrationResourceProperty - default: AWSGlue.GetIntegrationResourceProperty + - AWSGlue.GetGlossary + default: AWSGlue.GetGlossary requestBody: required: true content: @@ -4935,22 +5533,22 @@ paths: schema: type: object properties: - ResourceArn: - $ref: "#/components/schemas/String512" - description: The connection ARN of the source, or the database ARN of the target. + Identifier: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary to retrieve. required: - - ResourceArn + - Identifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/GetIntegrationResourcePropertyResponse" - /GetIntegrationTableProperties: + $ref: "#/components/schemas/GetGlossaryResponse" + /GetGlossaryTerm: post: - operationId: GetIntegrationTableProperties - description: This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables. + operationId: GetGlossaryTerm + description: Retrieves a glossary term in Glue Data Catalog by its identifier. parameters: - name: X-Amz-Target in: header @@ -4959,8 +5557,8 @@ paths: schema: type: string enum: - - AWSGlue.GetIntegrationTableProperties - default: AWSGlue.GetIntegrationTableProperties + - AWSGlue.GetGlossaryTerm + default: AWSGlue.GetGlossaryTerm requestBody: required: true content: @@ -4968,14 +5566,107 @@ paths: schema: type: object properties: - ResourceArn: - $ref: "#/components/schemas/String512" - description: The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release. - TableName: - $ref: "#/components/schemas/String128" - description: The name of the table to be replicated. + Identifier: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term to retrieve. required: - - ResourceArn + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetGlossaryTermResponse" + /GetGlueIdentityCenterConfiguration: + post: + operationId: GetGlueIdentityCenterConfiguration + description: Retrieves the current Glue Identity Center configuration details, including the associated Identity Center instance and application information. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetGlueIdentityCenterConfiguration + default: AWSGlue.GetGlueIdentityCenterConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetGlueIdentityCenterConfigurationResponse" + /GetIntegrationResourceProperty: + post: + operationId: GetIntegrationResourceProperty + description: This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target) + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetIntegrationResourceProperty + default: AWSGlue.GetIntegrationResourceProperty + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String512" + description: The connection ARN of the source, or the database ARN of the target. + required: + - ResourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntegrationResourcePropertyResponse" + /GetIntegrationTableProperties: + post: + operationId: GetIntegrationTableProperties + description: This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetIntegrationTableProperties + default: AWSGlue.GetIntegrationTableProperties + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ResourceArn: + $ref: "#/components/schemas/String512" + description: The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release. + TableName: + $ref: "#/components/schemas/String128" + description: The name of the table to be replicated. + required: + - ResourceArn - TableName responses: "200": @@ -5947,6 +6638,39 @@ paths: application/json: schema: $ref: "#/components/schemas/GetSessionResponse" + /GetSessionEndpoint: + post: + operationId: GetSessionEndpoint + description: Returns the Spark Connect endpoint URL and authentication token for an interactive session. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.GetSessionEndpoint + default: AWSGlue.GetSessionEndpoint + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + SessionId: + $ref: "#/components/schemas/NameString" + description: The unique identifier of the interactive session. + required: + - SessionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSessionEndpointResponse" /GetStatement: post: operationId: GetStatement @@ -6029,6 +6753,9 @@ paths: IncludeStatusDetails: $ref: "#/components/schemas/BooleanNullable" description: Specifies whether to include status details related to a request to create or update an Glue Data Catalog view. + AttributesToGet: + $ref: "#/components/schemas/TableAttributesList" + description: "Specifies the table fields returned by the GetTable call. This parameter doesn't accept an empty list. The following are the valid combinations of values: DEFAULT - Returns the Hive-style table definition only. LATEST_ICEBERG_METADATA - Returns only the latest Apache Iceberg table metadata. DEFAULT, LATEST_ICEBERG_METADATA - Returns both the Hive-style table definition and the latest Apache Iceberg table metadata." required: - DatabaseName responses: @@ -6827,6 +7554,40 @@ paths: application/json: schema: $ref: "#/components/schemas/ImportCatalogToGlueResponse" + /ListAssetTypes: + post: + operationId: ListAssetTypes + description: Lists the asset types defined in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.ListAssetTypes + default: AWSGlue.ListAssetTypes + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssetTypesResponse" /ListBlueprints: post: operationId: ListBlueprints @@ -7115,6 +7876,9 @@ paths: MaxResults: $ref: "#/components/schemas/PageSize" description: The maximum number of results to return. + Tags: + $ref: "#/components/schemas/TagsMap" + description: A list of key-value pair tags to filter recommendation runs. responses: "200": description: Success @@ -7365,10 +8129,10 @@ paths: application/json: schema: $ref: "#/components/schemas/ListEntitiesResponse" - /ListIntegrationResourceProperties: + /ListFormTypes: post: - operationId: ListIntegrationResourceProperties - description: List integration resource properties for a single customer. It supports the filters, maxRecords and markers. + operationId: ListFormTypes + description: Lists the form types defined in Glue Data Catalog. parameters: - name: X-Amz-Target in: header @@ -7377,8 +8141,8 @@ paths: schema: type: string enum: - - AWSGlue.ListIntegrationResourceProperties - default: AWSGlue.ListIntegrationResourceProperties + - AWSGlue.ListFormTypes + default: AWSGlue.ListFormTypes requestBody: required: true content: @@ -7386,26 +8150,23 @@ paths: schema: type: object properties: - Marker: - $ref: "#/components/schemas/String1024" - description: This is the pagination token for next page, initial value is null. - Filters: - $ref: "#/components/schemas/IntegrationResourcePropertyFilterList" - description: A list of filters, supported filter Key is SourceArn and TargetArn. - MaxRecords: - $ref: "#/components/schemas/IntegrationInteger" - description: This is total number of items to be evaluated. + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListIntegrationResourcePropertiesResponse" - /ListJobs: + $ref: "#/components/schemas/ListFormTypesResponse" + /ListGlossaries: post: - operationId: ListJobs - description: Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. + operationId: ListGlossaries + description: Lists business glossaries in Glue Data Catalog. parameters: - name: X-Amz-Target in: header @@ -7414,8 +8175,8 @@ paths: schema: type: string enum: - - AWSGlue.ListJobs - default: AWSGlue.ListJobs + - AWSGlue.ListGlossaries + default: AWSGlue.ListGlossaries requestBody: required: true content: @@ -7423,26 +8184,23 @@ paths: schema: type: object properties: - NextToken: - $ref: "#/components/schemas/GenericString" - description: A continuation token, if this is a continuation request. MaxResults: $ref: "#/components/schemas/PageSize" - description: The maximum size of a list to return. - Tags: - $ref: "#/components/schemas/TagsMap" - description: Specifies to return only these tagged resources. + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListJobsOutputDisplay" - /ListMLTransforms: + $ref: "#/components/schemas/ListGlossariesResponse" + /ListGlossaryTerms: post: - operationId: ListMLTransforms - description: Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved. + operationId: ListGlossaryTerms + description: Lists glossary terms within a business glossary in Glue Data Catalog. parameters: - name: X-Amz-Target in: header @@ -7451,8 +8209,8 @@ paths: schema: type: string enum: - - AWSGlue.ListMLTransforms - default: AWSGlue.ListMLTransforms + - AWSGlue.ListGlossaryTerms + default: AWSGlue.ListGlossaryTerms requestBody: required: true content: @@ -7460,32 +8218,28 @@ paths: schema: type: object properties: - NextToken: - $ref: "#/components/schemas/PaginationToken" - description: A continuation token, if this is a continuation request. + GlossaryIdentifier: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary whose terms to list. MaxResults: $ref: "#/components/schemas/PageSize" - description: The maximum size of a list to return. - Filter: - $ref: "#/components/schemas/TransformFilterCriteria" - description: A TransformFilterCriteria used to filter the machine learning transforms. - Sort: - $ref: "#/components/schemas/TransformSortCriteria" - description: A TransformSortCriteria used to sort the machine learning transforms. - Tags: - $ref: "#/components/schemas/TagsMap" - description: Specifies to return only these tagged resources. + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. + required: + - GlossaryIdentifier responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListMLTransformsOutputDisplay" - /ListMaterializedViewRefreshTaskRuns: + $ref: "#/components/schemas/ListGlossaryTermsResponse" + /ListIntegrationResourceProperties: post: - operationId: ListMaterializedViewRefreshTaskRuns - description: List all task runs for a particular account. + operationId: ListIntegrationResourceProperties + description: List integration resource properties for a single customer. It supports the filters, maxRecords and markers. parameters: - name: X-Amz-Target in: header @@ -7494,8 +8248,8 @@ paths: schema: type: string enum: - - AWSGlue.ListMaterializedViewRefreshTaskRuns - default: AWSGlue.ListMaterializedViewRefreshTaskRuns + - AWSGlue.ListIntegrationResourceProperties + default: AWSGlue.ListIntegrationResourceProperties requestBody: required: true content: @@ -7503,34 +8257,26 @@ paths: schema: type: object properties: - CatalogId: - $ref: "#/components/schemas/NameString" - description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default. - DatabaseName: - $ref: "#/components/schemas/NameString" - description: The database where the table resides. - TableName: - $ref: "#/components/schemas/NameString" - description: The name of the table for which statistics is generated. - MaxResults: - $ref: "#/components/schemas/PageSize" - description: The maximum size of the response. - NextToken: - $ref: "#/components/schemas/Token" - description: A continuation token, if this is a continuation call. - required: - - CatalogId + Marker: + $ref: "#/components/schemas/String1024" + description: This is the pagination token for next page, initial value is null. + Filters: + $ref: "#/components/schemas/IntegrationResourcePropertyFilterList" + description: A list of filters, supported filter Key is SourceArn and TargetArn. + MaxRecords: + $ref: "#/components/schemas/IntegrationInteger" + description: This is total number of items to be evaluated. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListMaterializedViewRefreshTaskRunsResponse" - /ListRegistries: + $ref: "#/components/schemas/ListIntegrationResourcePropertiesResponse" + /ListIterableForms: post: - operationId: ListRegistries - description: Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available. + operationId: ListIterableForms + description: Lists the items in an iterable form on an asset in Glue Data Catalog. For example, lists the columns of a table asset. parameters: - name: X-Amz-Target in: header @@ -7539,8 +8285,8 @@ paths: schema: type: string enum: - - AWSGlue.ListRegistries - default: AWSGlue.ListRegistries + - AWSGlue.ListIterableForms + default: AWSGlue.ListIterableForms requestBody: required: true content: @@ -7548,9 +8294,177 @@ paths: schema: type: object properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form to list items from. MaxResults: - $ref: "#/components/schemas/MaxResultsNumber" - description: Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page. + $ref: "#/components/schemas/PageSize" + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. + required: + - AssetIdentifier + - IterableFormName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListIterableFormsResponse" + /ListJobs: + post: + operationId: ListJobs + description: Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.ListJobs + default: AWSGlue.ListJobs + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/GenericString" + description: A continuation token, if this is a continuation request. + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum size of a list to return. + Tags: + $ref: "#/components/schemas/TagsMap" + description: Specifies to return only these tagged resources. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListJobsOutputDisplay" + /ListMLTransforms: + post: + operationId: ListMLTransforms + description: Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.ListMLTransforms + default: AWSGlue.ListMLTransforms + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/PaginationToken" + description: A continuation token, if this is a continuation request. + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum size of a list to return. + Filter: + $ref: "#/components/schemas/TransformFilterCriteria" + description: A TransformFilterCriteria used to filter the machine learning transforms. + Sort: + $ref: "#/components/schemas/TransformSortCriteria" + description: A TransformSortCriteria used to sort the machine learning transforms. + Tags: + $ref: "#/components/schemas/TagsMap" + description: Specifies to return only these tagged resources. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMLTransformsOutputDisplay" + /ListMaterializedViewRefreshTaskRuns: + post: + operationId: ListMaterializedViewRefreshTaskRuns + description: List all task runs for a particular account. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.ListMaterializedViewRefreshTaskRuns + default: AWSGlue.ListMaterializedViewRefreshTaskRuns + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CatalogId: + $ref: "#/components/schemas/NameString" + description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default. + DatabaseName: + $ref: "#/components/schemas/NameString" + description: The database where the table resides. + TableName: + $ref: "#/components/schemas/NameString" + description: The name of the materialized view. + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum size of the response. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, if this is a continuation call. + required: + - CatalogId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMaterializedViewRefreshTaskRunsResponse" + /ListRegistries: + post: + operationId: ListRegistries + description: Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.ListRegistries + default: AWSGlue.ListRegistries + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/MaxResultsNumber" + description: Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page. NextToken: $ref: "#/components/schemas/SchemaRegistryTokenString" description: A continuation token, if this is a continuation call. @@ -7920,6 +8834,146 @@ paths: application/json: schema: $ref: "#/components/schemas/ModifyIntegrationResponse" + /PutAsset: + post: + operationId: PutAsset + description: Creates or updates an asset in Glue Data Catalog. If the asset already exists, this operation updates it; otherwise, a new asset is created. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.PutAsset + default: AWSGlue.PutAsset + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetTypeId: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type for the asset. + Identifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. If an asset with this identifier already exists, it is updated. + Name: + $ref: "#/components/schemas/AssetName" + description: The name of the asset. + Description: + $ref: "#/components/schemas/AssetDescription" + description: The description of the asset. + Forms: + $ref: "#/components/schemas/AssetFormMap" + description: The forms to set on the asset, keyed by form name. Each entry specifies the form type and its JSON content. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - AssetTypeId + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutAssetResponse" + /PutAssetType: + post: + operationId: PutAssetType + description: Creates or updates an asset type in Glue Data Catalog. An asset type defines the structure of assets by specifying which forms they include. If an asset type with the given name already exists, it is updated. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.PutAssetType + default: AWSGlue.PutAssetType + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/AssetTypeName" + description: The name of the asset type. + Forms: + $ref: "#/components/schemas/AssetTypeFormsMap" + description: The forms that make up the asset type, keyed by form name. Each entry references the form type that defines the form's schema. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutAssetTypeResponse" + /PutAttachment: + post: + operationId: PutAttachment + description: Attaches a form to an asset or an iterable form item in Glue Data Catalog. If an attachment with the same name already exists, it is overwritten. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.PutAttachment + default: AWSGlue.PutAttachment + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to attach the form to. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form. When specified along with itemIdentifier, the attachment targets an item within the iterable form rather than the asset itself. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form. Required when iterableFormName is specified. + AttachmentName: + $ref: "#/components/schemas/AttachmentName" + description: The name of the attachment. + Content: + $ref: "#/components/schemas/FormContent" + description: The JSON content of the form, conforming to the schema of the specified form type. + FormTypeId: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type for this attachment. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - AssetIdentifier + - AttachmentName + - Content + - FormTypeId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutAttachmentResponse" /PutDataCatalogEncryptionSettings: post: operationId: PutDataCatalogEncryptionSettings @@ -7956,6 +9010,45 @@ paths: application/json: schema: $ref: "#/components/schemas/PutDataCatalogEncryptionSettingsResponse" + /PutDataCatalogExportConfiguration: + post: + operationId: PutDataCatalogExportConfiguration + description: Creates or updates the export configuration for the Glue Data Catalog. Use this operation to enable or disable the export of catalog metadata to S3 Tables. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.PutDataCatalogExportConfiguration + default: AWSGlue.PutDataCatalogExportConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ExportSetting: + $ref: "#/components/schemas/ExportSetting" + description: The export setting for the data catalog. Specify ENABLED to start exporting catalog metadata to S3 Tables, or DISABLED to stop exporting. This field is required. + EncryptionConfiguration: + $ref: "#/components/schemas/ExportEncryptionConfiguration" + description: The encryption configuration for the exported data. If not specified, the default encryption settings are used. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - ExportSetting + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutDataCatalogExportConfigurationOutput" /PutDataQualityProfileAnnotation: post: operationId: PutDataQualityProfileAnnotation @@ -7993,6 +9086,43 @@ paths: application/json: schema: $ref: "#/components/schemas/PutDataQualityProfileAnnotationResponse" + /PutFormType: + post: + operationId: PutFormType + description: Creates or updates a form type in Glue Data Catalog. A form type defines the schema for structured metadata that can be attached to assets. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.PutFormType + default: AWSGlue.PutFormType + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/FormTypeName" + description: The name of the form type. Must start with an uppercase letter. + Schema: + $ref: "#/components/schemas/FormTypeSchema" + description: The Smithy IDL schema definition for the form type. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutFormTypeResponse" /PutResourcePolicy: post: operationId: PutResourcePolicy @@ -8389,8 +9519,48 @@ paths: schema: type: string enum: - - AWSGlue.RunStatement - default: AWSGlue.RunStatement + - AWSGlue.RunStatement + default: AWSGlue.RunStatement + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + SessionId: + $ref: "#/components/schemas/NameString" + description: The Session Id of the statement to be run. + Code: + $ref: "#/components/schemas/OrchestrationStatementCodeString" + description: The statement code to be run. + RequestOrigin: + $ref: "#/components/schemas/OrchestrationNameString" + description: The origin of the request. + required: + - SessionId + - Code + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RunStatementResponse" + /SearchAssets: + post: + operationId: SearchAssets + description: Searches for assets in Glue Data Catalog using full-text search, filters, sorting, and aggregations. Returns matching assets with relevance-ranked results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.SearchAssets + default: AWSGlue.SearchAssets requestBody: required: true content: @@ -8398,25 +9568,28 @@ paths: schema: type: object properties: - SessionId: - $ref: "#/components/schemas/NameString" - description: The Session Id of the statement to be run. - Code: - $ref: "#/components/schemas/OrchestrationStatementCodeString" - description: The statement code to be run. - RequestOrigin: - $ref: "#/components/schemas/OrchestrationNameString" - description: The origin of the request. - required: - - SessionId - - Code + SearchText: + $ref: "#/components/schemas/SearchText" + description: The text to search for. At least one of searchText or filterClause must be provided. + MaxResults: + $ref: "#/components/schemas/SearchMaxResults" + description: The maximum number of results to return in the response. + NextToken: + $ref: "#/components/schemas/SearchNextToken" + description: A continuation token, if this is a continuation call. + Sort: + $ref: "#/components/schemas/SearchSort" + description: The sort criteria for the search results. + FilterClause: + $ref: "#/components/schemas/SearchFilterClause" + description: The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/RunStatementResponse" + $ref: "#/components/schemas/SearchAssetsOutput" /SearchTables: post: operationId: SearchTables @@ -8707,6 +9880,9 @@ paths: ClientToken: $ref: "#/components/schemas/HashString" description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource. + AdditionalRunOptions: + $ref: "#/components/schemas/DataQualityRuleRecommendationRunAdditionalRunOptions" + description: Additional run options you can specify for a recommendation run. required: - DataSource - Role @@ -8992,7 +10168,7 @@ paths: /StartMaterializedViewRefreshTaskRun: post: operationId: StartMaterializedViewRefreshTaskRun - description: Starts a materialized view refresh task run, for a specified table and columns. + description: Starts a materialized view refresh task run for a specified materialized view. parameters: - name: X-Amz-Target in: header @@ -9018,7 +10194,7 @@ paths: description: The name of the database where the table resides. TableName: $ref: "#/components/schemas/NameString" - description: The name of the table to generate run the materialized view refresh task. + description: The name of the materialized view to run the refresh task for. FullRefresh: $ref: "#/components/schemas/NullableBoolean" description: Specifies whether this is a full refresh of the task run. @@ -9241,7 +10417,7 @@ paths: /StopMaterializedViewRefreshTaskRun: post: operationId: StopMaterializedViewRefreshTaskRun - description: Stops a materialized view refresh task run, for a specified table and columns. + description: Stops a materialized view refresh task run for a specified materialized view. parameters: - name: X-Amz-Target in: header @@ -9267,7 +10443,7 @@ paths: description: The name of the database where the table resides. TableName: $ref: "#/components/schemas/NameString" - description: The name of the table to generate statistics. + description: The name of the materialized view. required: - CatalogId - DatabaseName @@ -9491,6 +10667,48 @@ paths: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" + /UpdateAsset: + post: + operationId: UpdateAsset + description: Updates the name and description of an existing asset in Glue Data Catalog. Only the fields that you provide are updated. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.UpdateAsset + default: AWSGlue.UpdateAsset + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset to update. + Name: + $ref: "#/components/schemas/AssetName" + description: The new name of the asset. + Description: + $ref: "#/components/schemas/AssetDescription" + description: The new description of the asset. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAssetResponse" /UpdateBlueprint: post: operationId: UpdateBlueprint @@ -10029,6 +11247,93 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateDevEndpointResponse" + /UpdateGlossary: + post: + operationId: UpdateGlossary + description: Updates a business glossary in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.UpdateGlossary + default: AWSGlue.UpdateGlossary + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary to update. + Name: + $ref: "#/components/schemas/GlossaryName" + description: The updated name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The updated description of the glossary. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateGlossaryResponse" + /UpdateGlossaryTerm: + post: + operationId: UpdateGlossaryTerm + description: Updates a glossary term in Glue Data Catalog. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSGlue.UpdateGlossaryTerm + default: AWSGlue.UpdateGlossaryTerm + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + Identifier: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term to update. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The updated name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: The updated short description of the glossary term. + LongDescription: + $ref: "#/components/schemas/GlossaryLongDescription" + description: The updated long description of the glossary term. + ClientToken: + $ref: "#/components/schemas/HashString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateGlossaryTermResponse" /UpdateGlueIdentityCenterConfiguration: post: operationId: UpdateGlueIdentityCenterConfiguration @@ -10792,6 +12097,46 @@ components: schema: type: string schemas: + AssetId: + type: string + minLength: 1 + maxLength: 1087 + pattern: "[a-zA-Z0-9\\-\\:\\/\\.\\_\\*]+" + IterableFormName: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z][a-zA-Z0-9_]*(::[a-zA-Z][a-zA-Z0-9_]*)?$ + ItemIdentifier: + type: string + minLength: 1 + maxLength: 1087 + GlossaryTermIdList: + type: array + items: + $ref: "#/components/schemas/GlossaryTermId" + GlossaryTermId: + type: string + HashString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + AssociateGlossaryTermsResponse: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form, if the association targets an item. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form, if applicable. + GlossaryTerms: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The glossary terms now associated with the asset. CatalogIdString: type: string minLength: 1 @@ -11765,11 +13110,6 @@ components: type: array items: $ref: "#/components/schemas/HashString" - HashString: - type: string - minLength: 1 - maxLength: 255 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" BatchGetDataQualityResultResponse: type: object properties: @@ -11971,6 +13311,10 @@ components: type: object properties: {} description: A map of metrics associated with the evaluation of the analyzer. + EvaluatedDistributions: + type: object + properties: {} + description: A map of distribution metrics associated with the evaluation of the analyzer. DataQualityObservations: type: array items: @@ -12026,28 +13370,247 @@ components: type: array items: $ref: "#/components/schemas/NameString" - DataQualityAggregatedMetrics: - description: A summary of metrics showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results. - type: object - properties: - TotalRowsProcessed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of rows that were processed during the data quality evaluation. - TotalRowsPassed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of rows that passed all applicable data quality rules. - TotalRowsFailed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of rows that failed one or more data quality rules. - TotalRulesProcessed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of data quality rules that were evaluated. - TotalRulesPassed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of data quality rules that passed their evaluation criteria. - TotalRulesFailed: - $ref: "#/components/schemas/NullableDouble" - description: The total number of data quality rules that failed their evaluation criteria. + DataQualityAggregatedMetrics: + description: A summary of metrics showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results. + type: object + properties: + TotalRowsProcessed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of rows that were processed during the data quality evaluation. + TotalRowsPassed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of rows that passed all applicable data quality rules. + TotalRowsFailed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of rows that failed one or more data quality rules. + TotalRulesProcessed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of data quality rules that were evaluated. + TotalRulesPassed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of data quality rules that passed their evaluation criteria. + TotalRulesFailed: + $ref: "#/components/schemas/NullableDouble" + description: The total number of data quality rules that failed their evaluation criteria. + DataQualityRulesetEvaluationRunIdList: + type: array + items: + $ref: "#/components/schemas/HashString" + BatchGetDataQualityRulesetEvaluationRunResponse: + type: object + properties: + Runs: + $ref: "#/components/schemas/DataQualityRulesetEvaluationRunsList" + description: A list of evaluation run details for the requested run IDs. + RunsNotFound: + $ref: "#/components/schemas/DataQualityRulesetEvaluationRunIdList" + description: A list of run IDs that were not found. + DataQualityRulesetEvaluationRunsList: + type: array + items: + $ref: "#/components/schemas/DataQualityRulesetEvaluationRun" + DataQualityRulesetEvaluationRun: + description: The details of a data quality ruleset evaluation run. + type: object + properties: + RunId: + $ref: "#/components/schemas/HashString" + description: The unique run identifier associated with this run. + DataSource: + $ref: "#/components/schemas/DataSource" + Role: + $ref: "#/components/schemas/RoleString" + description: An IAM role supplied to encrypt the results of the run. + NumberOfWorkers: + $ref: "#/components/schemas/NullableInteger" + description: The number of G.1X workers to be used in the run. The default is 5. + Timeout: + $ref: "#/components/schemas/Timeout" + description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). + AdditionalRunOptions: + $ref: "#/components/schemas/DataQualityEvaluationRunAdditionalRunOptions" + Status: + $ref: "#/components/schemas/TaskStatusType" + description: The status for this run. + ErrorString: + $ref: "#/components/schemas/GenericString" + description: The error strings that are associated with the run. + StartedOn: + $ref: "#/components/schemas/Timestamp" + description: The date and time when this run started. + LastModifiedOn: + $ref: "#/components/schemas/Timestamp" + description: A timestamp. The last point in time when this run was modified. + CompletedOn: + $ref: "#/components/schemas/Timestamp" + description: The date and time when this run was completed. + ExecutionTime: + $ref: "#/components/schemas/ExecutionTime" + description: The amount of time (in seconds) that the run consumed resources. + RulesetNames: + $ref: "#/components/schemas/RulesetNames" + description: A list of ruleset names for the run. + ResultIds: + $ref: "#/components/schemas/DataQualityResultIdList" + description: A list of result IDs for the data quality results for the run. + AdditionalDataSources: + type: object + properties: {} + description: A map of reference strings to additional data sources you can specify for an evaluation run. + RoleString: + type: string + Timeout: + type: integer + minimum: 1 + DataQualityEvaluationRunAdditionalRunOptions: + description: Additional run options you can specify for an evaluation run. + type: object + properties: + CloudWatchMetricsEnabled: + $ref: "#/components/schemas/NullableBoolean" + description: Whether or not to enable CloudWatch metrics. + ResultsS3Prefix: + $ref: "#/components/schemas/UriString" + description: Prefix for Amazon S3 to store results. + CompositeRuleEvaluationMethod: + $ref: "#/components/schemas/DQCompositeRuleEvaluationMethod" + description: Set the evaluation method for composite rules in the ruleset to ROW/COLUMN + CustomLogGroupPrefix: + $ref: "#/components/schemas/GenericString" + description: A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to ``/error and ``/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups. + RowLevelResults: + $ref: "#/components/schemas/RowLevelResultsOptions" + description: The configuration for writing row-level evaluation results to a Glue Data Catalog table. + ProfilingResults: + $ref: "#/components/schemas/ProfilingResultsOptions" + description: The configuration for writing profiling results to a Glue Data Catalog table. + ObservationScope: + $ref: "#/components/schemas/ObservationConfiguration" + description: The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled. + ObservationMode: + $ref: "#/components/schemas/ObservationMode" + description: The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated. + DataQualityRuleResults: + $ref: "#/components/schemas/DataQualityRuleResultsOptions" + description: The configuration for writing rule results to a Glue Data Catalog table. + ObservationResults: + $ref: "#/components/schemas/ObservationResultsOptions" + description: The configuration for writing observation results to a Glue Data Catalog table. + UriString: + type: string + DQCompositeRuleEvaluationMethod: + type: string + enum: + - COLUMN + - ROW + RowLevelResultsOptions: + description: The configuration for writing row-level evaluation results. + type: object + properties: + MaxRowsToWrite: + $ref: "#/components/schemas/NullableInteger" + description: The maximum number of rows to write in the results. + ResultType: + $ref: "#/components/schemas/ResultTypeEnum" + description: The result type to include in the row-level results output. + CatalogTableConfig: + $ref: "#/components/schemas/CatalogTableConfigOptions" + description: The Glue Data Catalog table configuration for storing the results. + ResultTypeEnum: + type: string + enum: + - ALL + - PASSED_ONLY + - FAILED_ONLY + CatalogTableConfigOptions: + description: The configuration for a Glue Data Catalog table used to store data quality results. + type: object + properties: + DatabaseName: + $ref: "#/components/schemas/NameString" + description: The name of the database in the Glue Data Catalog. + TableName: + $ref: "#/components/schemas/NameString" + description: The name of the table in the Glue Data Catalog. + S3Location: + $ref: "#/components/schemas/UriString" + description: The Amazon S3 location for storing the results. + CatalogId: + $ref: "#/components/schemas/NameString" + description: A unique identifier for the Glue Data Catalog. + ProfilingResultsOptions: + description: The configuration for writing profiling results. + type: object + properties: + WriteProfilingResultsEnabled: + $ref: "#/components/schemas/NullableBoolean" + description: Set to true to write profiling results. + CatalogTableConfig: + $ref: "#/components/schemas/CatalogTableConfigOptions" + description: The Glue Data Catalog table configuration for storing the profiling results. + DistributionResults: + $ref: "#/components/schemas/DistributionResultsOptions" + description: The configuration for writing distribution results. + DistributionResultsOptions: + description: The configuration for writing distribution results. + type: object + properties: + WriteDistributionResultsEnabled: + $ref: "#/components/schemas/NullableBoolean" + description: Set to true to write distribution results. + CatalogTableConfig: + $ref: "#/components/schemas/CatalogTableConfigOptions" + description: The Glue Data Catalog table configuration for storing the distribution results. + ObservationConfiguration: + type: string + enum: + - ALL + - NONE + ObservationMode: + type: string + enum: + - SCHEDULED + - FIXED + DataQualityRuleResultsOptions: + description: The configuration for writing data quality rule results. + type: object + properties: + WriteDataQualityRuleResultsEnabled: + $ref: "#/components/schemas/NullableBoolean" + description: Set to true to write data quality rule results. + CatalogTableConfig: + $ref: "#/components/schemas/CatalogTableConfigOptions" + description: The Glue Data Catalog table configuration for storing the rule results. + ObservationResultsOptions: + description: The configuration for writing observation results. + type: object + properties: + WriteObservationResultsEnabled: + $ref: "#/components/schemas/NullableBoolean" + description: Set to true to write observation results. + CatalogTableConfig: + $ref: "#/components/schemas/CatalogTableConfigOptions" + description: The Glue Data Catalog table configuration for storing the observation results. + TaskStatusType: + type: string + enum: + - STARTING + - RUNNING + - STOPPING + - STOPPED + - SUCCEEDED + - FAILED + - TIMEOUT + ExecutionTime: + type: integer + RulesetNames: + type: array + items: + $ref: "#/components/schemas/NameString" + DataQualityResultIdList: + type: array + items: + $ref: "#/components/schemas/HashString" DevEndpointNames: type: array items: @@ -12173,6 +13736,69 @@ components: type: array items: $ref: "#/components/schemas/GenericString" + ItemIdentifierList: + type: array + items: + $ref: "#/components/schemas/ItemIdentifier" + BatchGetIterableFormsResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/IterableFormItemList" + description: The list of retrieved iterable form items. + Errors: + $ref: "#/components/schemas/ItemErrorList" + description: The list of errors for items that could not be retrieved. + IterableFormItemList: + type: array + items: + $ref: "#/components/schemas/IterableFormItem" + IterableFormItem: + description: A full iterable form item with its forms. + type: object + properties: + ItemId: + $ref: "#/components/schemas/ItemId" + description: The unique identifier of the item. + ItemName: + $ref: "#/components/schemas/ItemName" + description: The name of the item. + GlossaryTerms: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The identifiers of the glossary terms associated with the item. + Forms: + type: object + properties: {} + description: The forms on the item, keyed by form name. + Attachments: + type: object + properties: {} + description: Additional attachments on the item for more context, keyed by attachment name. + ItemId: + type: string + ItemName: + type: string + ItemErrorList: + type: array + items: + $ref: "#/components/schemas/ItemError" + ItemError: + description: An error that occurred when retrieving an iterable form item. + type: object + properties: + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item that caused the error. + Code: + $ref: "#/components/schemas/ItemErrorCode" + description: The error code. + Message: + $ref: "#/components/schemas/ItemErrorMessage" + description: The error message. + ItemErrorCode: + type: string + ItemErrorMessage: + type: string JobNameList: type: array items: @@ -12284,10 +13910,6 @@ components: - SCRIPT - VISUAL - NOTEBOOK - UriString: - type: string - RoleString: - type: string ExecutionProperty: description: An execution property of a job. type: object @@ -12339,9 +13961,6 @@ components: maxLength: 255 MaxRetries: type: integer - Timeout: - type: integer - minimum: 1 NotificationProperty: description: Specifies configuration properties of a notification. type: object @@ -13335,8 +14954,6 @@ components: RunId: $ref: "#/components/schemas/IdString" description: The job-run ID of the predecessor job run. - ExecutionTime: - type: integer OrchestrationMessageString: type: string maxLength: 400000 @@ -13557,16 +15174,6 @@ components: Status: $ref: "#/components/schemas/TaskStatusType" description: The status for this run. - TaskStatusType: - type: string - enum: - - STARTING - - RUNNING - - STOPPING - - STOPPED - - SUCCEEDED - - FAILED - - TIMEOUT CancelStatementResponse: type: object DataFormat: @@ -14425,6 +16032,58 @@ components: type: object properties: {} description: 'The map of arguments used to configure this DevEndpoint. Valid arguments are: "--enable-glue-datacatalog": "" You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.' + GlossaryName: + type: string + minLength: 1 + maxLength: 256 + MetadataDescription: + type: string + minLength: 1 + maxLength: 2048 + CreateGlossaryResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary. + Name: + $ref: "#/components/schemas/GlossaryName" + description: The name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The description of the glossary. + GlossaryId: + type: string + GlossaryTermName: + type: string + minLength: 1 + maxLength: 256 + GlossaryShortDescription: + type: string + minLength: 1 + maxLength: 1024 + GlossaryLongDescription: + type: string + minLength: 1 + maxLength: 4096 + CreateGlossaryTermResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term. + GlossaryId: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary containing this term. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: The short description of the glossary term. + LongDescription: + $ref: "#/components/schemas/GlossaryLongDescription" + description: The long description of the glossary term. IdentityCenterInstanceArn: type: string minLength: 10 @@ -15087,6 +16746,11 @@ components: OrchestrationArgumentsMap: type: object properties: {} + SessionType: + type: string + enum: + - LIVY + - SPARK_CONNECT CreateSessionResponse: type: object properties: @@ -15158,6 +16822,9 @@ components: ProfileName: $ref: "#/components/schemas/NameString" description: The name of an Glue usage profile associated with the session. + SessionType: + $ref: "#/components/schemas/SessionType" + description: The type of the session. SessionStatus: type: string enum: @@ -15629,6 +17296,31 @@ components: Name: $ref: "#/components/schemas/NameString" description: The name of the workflow which was provided as part of the request. + DeleteAssetResponse: + type: object + AssetTypeId: + type: string + minLength: 1 + maxLength: 256 + DeleteAssetTypeResponse: + type: object + AttachmentName: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ + DeleteAttachmentResponse: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form, if the deletion targets an item. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form, if applicable. DeleteBlueprintResponse: type: object properties: @@ -15663,6 +17355,16 @@ components: type: object DeleteDevEndpointResponse: type: object + FormTypeId: + type: string + minLength: 1 + maxLength: 256 + DeleteFormTypeResponse: + type: object + DeleteGlossaryResponse: + type: object + DeleteGlossaryTermResponse: + type: object DeleteGlueIdentityCenterConfigurationResponse: description: Response from deleting the Glue Identity Center configuration. type: object @@ -16065,6 +17767,9 @@ components: PaginationConfiguration: $ref: "#/components/schemas/PaginationConfiguration" description: Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies. + FilterConfiguration: + $ref: "#/components/schemas/FilterConfiguration" + description: Configuration for applying filter pushdown to REST API requests, defining how filter predicates are translated into query parameters or filter strings. HTTPMethod: type: string enum: @@ -16104,6 +17809,9 @@ components: PropertyType: $ref: "#/components/schemas/PropertyType" description: The data type of this property + Format: + $ref: "#/components/schemas/String" + description: A format template for the property value that defines how the value should be formatted before sending it in API requests. Use {value} as a placeholder for the actual property value (for example, SSWS {value}). required: - Name - Required @@ -16200,6 +17908,65 @@ components: required: - OffsetParameter - LimitParameter + FilterConfiguration: + description: Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies. + type: object + properties: + FilterMode: + $ref: "#/components/schemas/FilterMode" + description: The strategy for applying filters to requests. Use QUERY_PARAMS to pass filters as individual query parameters, or FILTER_STRING to construct a single filter expression string. + OperatorMappings: + type: object + properties: {} + description: "A map of logical filter operators to their API-specific string representations. Supported operator keys are: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, CONTAINS, BETWEEN, AND, and OR." + DateTimeFormat: + $ref: "#/components/schemas/String" + description: The global date and time format for filter expressions. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds. If not specified, values are passed as-is in ISO-8601 format. + StripQuotes: + $ref: "#/components/schemas/Bool" + description: Indicates whether surrounding double quotes should be stripped from filter values before processing. + BetweenConfiguration: + $ref: "#/components/schemas/BetweenConfiguration" + description: Configuration for handling BETWEEN range filter operations. + FilterStringConfiguration: + $ref: "#/components/schemas/FilterStringConfiguration" + description: Configuration for constructing filter expressions when FilterMode is set to FILTER_STRING. + required: + - FilterMode + FilterMode: + description: The strategy used to apply filter predicates to REST API requests. + type: string + enum: + - QUERY_PARAMS + - FILTER_STRING + BetweenConfiguration: + description: Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters. + type: object + properties: + LowBoundKey: + $ref: "#/components/schemas/String" + description: The parameter name used for the lower bound value in a BETWEEN filter operation. + HighBoundKey: + $ref: "#/components/schemas/String" + description: The parameter name used for the upper bound value in a BETWEEN filter operation. + Template: + $ref: "#/components/schemas/String" + description: A template string for constructing the BETWEEN filter expression. + FilterStringConfiguration: + description: Configuration for constructing filter expression strings when using the FILTER_STRING filter mode. + type: object + properties: + QueryParameterName: + $ref: "#/components/schemas/String" + description: The query parameter name used to send the constructed filter expression string in API requests. + QuoteStringValues: + $ref: "#/components/schemas/Bool" + description: Indicates whether string and date values should be wrapped with a quote character in the filter expression. + QuoteCharacter: + $ref: "#/components/schemas/String" + description: The character used to quote values when QuoteStringValues is true. Defaults to double quotes if not specified. + required: + - QueryParameterName EntityName: type: string NextToken: @@ -16455,6 +18222,89 @@ components: - IntegrationArn - Status - CreateTime + DisassociateGlossaryTermsResponse: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form, if the disassociation targets an item. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form, if applicable. + GlossaryTerms: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The remaining glossary terms associated with the asset. + GetAssetOutput: + description: The asset metadata returned by the GetAsset operation. + type: object + properties: + Id: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + Name: + $ref: "#/components/schemas/AssetName" + description: The name of the asset. + Description: + $ref: "#/components/schemas/AssetDescription" + description: The description of the asset. + CreatedAt: + $ref: "#/components/schemas/CreatedAt" + description: The timestamp at which the asset was created. + UpdatedAt: + $ref: "#/components/schemas/UpdatedAt" + description: The timestamp at which the asset was last updated. + AssetTypeId: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type for this asset. + GlossaryTerms: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The identifiers of the glossary terms associated with the asset. + Forms: + type: object + properties: {} + description: The forms on the asset, keyed by form name. + Attachments: + type: object + properties: {} + description: Additional attachments on the asset for more context, keyed by attachment name. + IterableForms: + type: object + properties: {} + description: The iterable forms available on the asset, keyed by form name (for example, columns). Use the form name with ListIterableForms or BatchGetIterableForms to retrieve the form's items. + required: + - Id + - AssetTypeId + AssetName: + type: string + AssetDescription: + type: string + CreatedAt: + type: string + format: date-time + UpdatedAt: + type: string + format: date-time + GetAssetTypeResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type. + Name: + $ref: "#/components/schemas/AssetTypeName" + description: The name of the asset type. + Forms: + type: object + properties: {} + description: The forms that make up the asset type, keyed by form name. + AssetTypeName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$ GetBlueprintResponse: type: object properties: @@ -17484,6 +19334,22 @@ components: ContextWords: $ref: "#/components/schemas/ContextWords" description: A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data. + GlueResourceType: + type: string + enum: + - JOB + - SESSION + GetDashboardUrlResponse: + type: object + properties: + Url: + $ref: "#/components/schemas/SensitiveUrl" + description: The URL for the Spark monitoring dashboard. + required: + - Url + SensitiveUrl: + type: string + maxLength: 40000 GetDataCatalogEncryptionSettingsResponse: type: object properties: @@ -17533,6 +19399,60 @@ components: description: An KMS key that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements. required: - ReturnConnectionPasswordEncrypted + GetDataCatalogExportConfigurationOutput: + description: The export configuration returned by the GetDataCatalogExportConfiguration operation. + type: object + properties: + ExportSetting: + $ref: "#/components/schemas/ExportSetting" + description: The export setting for the data catalog. Valid values are ENABLED and DISABLED. + Status: + $ref: "#/components/schemas/ExportStatus" + description: The current status of the export. Valid values are ENABLING, ENABLED, DISABLING, DISABLED, and FAILED. + EncryptionConfiguration: + $ref: "#/components/schemas/ExportEncryptionConfiguration" + description: The encryption configuration for the exported data. + S3TableBucketArn: + $ref: "#/components/schemas/S3TableBucketArn" + description: The ARN of the S3 Tables bucket where catalog metadata is exported. + CreatedAt: + $ref: "#/components/schemas/CreatedAt" + description: The timestamp at which the export configuration was created. + UpdatedAt: + $ref: "#/components/schemas/UpdatedAt" + description: The timestamp at which the export configuration was last updated. + ExportSetting: + description: The export setting for the data catalog. + type: string + enum: + - ENABLED + - DISABLED + ExportStatus: + description: The current status of the data catalog export. + type: string + enum: + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - FAILED + ExportEncryptionConfiguration: + description: The encryption configuration for exported data catalog metadata. + type: object + properties: + SseAlgorithm: + $ref: "#/components/schemas/SseAlgorithm" + description: The server-side encryption algorithm used for the exported data. Valid values are AES256 and aws:kms. + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArnString" + description: The ARN of the KMS key used to encrypt the exported data. + SseAlgorithm: + type: string + KmsKeyArnString: + type: string + pattern: arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+ + S3TableBucketArn: + type: string GetDataQualityModelResponse: type: object properties: @@ -17684,6 +19604,16 @@ components: DataQualitySecurityConfiguration: $ref: "#/components/schemas/NameString" description: The name of the security configuration created with the data quality encryption option. + AdditionalRunOptions: + $ref: "#/components/schemas/DataQualityRuleRecommendationRunAdditionalRunOptions" + description: Additional run options you can specify for a recommendation run. + DataQualityRuleRecommendationRunAdditionalRunOptions: + description: Additional run options you can specify for a recommendation run. + type: object + properties: + CustomLogGroupPrefix: + $ref: "#/components/schemas/GenericString" + description: A custom prefix for the CloudWatch log group names. When specified, recommendation run logs are written to ``/error and ``/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups. GetDataQualityRulesetResponse: description: Returns the data quality ruleset response. type: object @@ -17740,56 +19670,27 @@ components: $ref: "#/components/schemas/GenericString" description: The error strings that are associated with the run. StartedOn: - $ref: "#/components/schemas/Timestamp" - description: The date and time when this run started. - LastModifiedOn: - $ref: "#/components/schemas/Timestamp" - description: A timestamp. The last point in time when this data quality rule recommendation run was modified. - CompletedOn: - $ref: "#/components/schemas/Timestamp" - description: The date and time when this run was completed. - ExecutionTime: - $ref: "#/components/schemas/ExecutionTime" - description: The amount of time (in seconds) that the run consumed resources. - RulesetNames: - $ref: "#/components/schemas/RulesetNames" - description: A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name. - ResultIds: - $ref: "#/components/schemas/DataQualityResultIdList" - description: A list of result IDs for the data quality results for the run. - AdditionalDataSources: - type: object - properties: {} - description: A map of reference strings to additional data sources you can specify for an evaluation run. - DataQualityEvaluationRunAdditionalRunOptions: - description: Additional run options you can specify for an evaluation run. - type: object - properties: - CloudWatchMetricsEnabled: - $ref: "#/components/schemas/NullableBoolean" - description: Whether or not to enable CloudWatch metrics. - ResultsS3Prefix: - $ref: "#/components/schemas/UriString" - description: Prefix for Amazon S3 to store results. - CompositeRuleEvaluationMethod: - $ref: "#/components/schemas/DQCompositeRuleEvaluationMethod" - description: Set the evaluation method for composite rules in the ruleset to ROW/COLUMN - CustomLogGroupPrefix: - $ref: "#/components/schemas/GenericString" - description: A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to ``/error and ``/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups. - DQCompositeRuleEvaluationMethod: - type: string - enum: - - COLUMN - - ROW - RulesetNames: - type: array - items: - $ref: "#/components/schemas/NameString" - DataQualityResultIdList: - type: array - items: - $ref: "#/components/schemas/HashString" + $ref: "#/components/schemas/Timestamp" + description: The date and time when this run started. + LastModifiedOn: + $ref: "#/components/schemas/Timestamp" + description: A timestamp. The last point in time when this data quality rule recommendation run was modified. + CompletedOn: + $ref: "#/components/schemas/Timestamp" + description: The date and time when this run was completed. + ExecutionTime: + $ref: "#/components/schemas/ExecutionTime" + description: The amount of time (in seconds) that the run consumed resources. + RulesetNames: + $ref: "#/components/schemas/RulesetNames" + description: A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name. + ResultIds: + $ref: "#/components/schemas/DataQualityResultIdList" + description: A list of result IDs for the data quality results for the run. + AdditionalDataSources: + type: object + properties: {} + description: A map of reference strings to additional data sources you can specify for an evaluation run. GetDatabaseResponse: type: object properties: @@ -17917,6 +19818,57 @@ components: type: array items: $ref: "#/components/schemas/GetEntityRecordsRowDisplay" + GetFormTypeResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type. + Name: + $ref: "#/components/schemas/FormTypeName" + description: The name of the form type. + Schema: + $ref: "#/components/schemas/FormTypeSchema" + description: The Smithy IDL schema of the form type. + FormTypeName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[A-Z]\w*$ + FormTypeSchema: + type: string + minLength: 1 + maxLength: 100000 + GetGlossaryResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary. + Name: + $ref: "#/components/schemas/GlossaryName" + description: The name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The description of the glossary. + GetGlossaryTermResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term. + GlossaryId: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary containing this term. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: The short description of the glossary term. + LongDescription: + $ref: "#/components/schemas/GlossaryLongDescription" + description: The long description of the glossary term. GetGlueIdentityCenterConfigurationResponse: description: Response containing the Glue Identity Center configuration details. type: object @@ -18595,13 +20547,13 @@ components: description: The database where the table resides. TableName: $ref: "#/components/schemas/TableName" - description: The name of the table for which statistics is generated. + description: The name of the materialized view. CatalogId: $ref: "#/components/schemas/CatalogIdString" description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default. Role: $ref: "#/components/schemas/Role" - description: The IAM role that the service assumes to generate statistics. + description: The IAM role that the service assumes to run the materialized view refresh task. Status: $ref: "#/components/schemas/MaterializedViewRefreshState" description: The status of the task run. @@ -19001,6 +20953,38 @@ components: Session: $ref: "#/components/schemas/Session" description: The session object is returned in the response. + GetSessionEndpointResponse: + type: object + properties: + SparkConnect: + $ref: "#/components/schemas/SessionEndpoint" + description: The Spark Connect endpoint details for the session. + required: + - SparkConnect + SessionEndpoint: + description: Contains the Spark Connect endpoint details for an interactive session, including the URL and authentication credentials. + type: object + properties: + Url: + $ref: "#/components/schemas/SparkConnectEndpointUrl" + description: The Spark Connect endpoint URL for the session. + AuthToken: + $ref: "#/components/schemas/SensitiveString" + description: The authentication token to include in requests to the Spark Connect endpoint. + AuthTokenExpirationTime: + $ref: "#/components/schemas/TimestampValue" + description: The time at which the authentication token expires. + required: + - Url + - AuthToken + - AuthTokenExpirationTime + SparkConnectEndpointUrl: + type: string + maxLength: 2048 + pattern: ^sc://.*$ + SensitiveString: + type: string + maxLength: 16384 GetStatementResponse: type: object properties: @@ -19073,6 +21057,17 @@ components: LongValue: type: integer format: int64 + TableAttributesList: + type: array + items: + $ref: "#/components/schemas/TableAttributes" + TableAttributes: + type: string + enum: + - NAME + - TABLE_TYPE + - DEFAULT + - LATEST_ICEBERG_METADATA GetTableResponse: type: object properties: @@ -19156,6 +21151,9 @@ components: IsMaterializedView: $ref: "#/components/schemas/NullableBoolean" description: Indicates a table is a MaterializedView. + IcebergTableMetadata: + $ref: "#/components/schemas/IcebergTableMetadata" + description: The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata. Status: $ref: "#/components/schemas/TableStatus" description: Indicates the the state of an asynchronous change to a table. @@ -19234,6 +21232,63 @@ components: IsStale: $ref: "#/components/schemas/NullableBoolean" description: Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines. + IcebergTableMetadata: + description: The Apache Iceberg table metadata, including format version, table identifier, schemas, partition specifications, sort orders, and table properties. This structure captures the current state of an Iceberg table's metadata as managed by the Glue Data Catalog. + type: object + properties: + FormatVersion: + $ref: "#/components/schemas/VersionString" + description: The Apache Iceberg table format version, such as 1 or 2. Determines the set of features and on-disk layout supported by the table. + TableUuid: + $ref: "#/components/schemas/TableIdString" + description: The unique identifier (UUID) for the Iceberg table, assigned when the table is created and used to track the table across metadata updates. + Location: + $ref: "#/components/schemas/LocationString" + description: The base S3 location where the Iceberg table's data and metadata files are stored. + Properties: + type: object + properties: {} + description: A map of key-value pairs that define table-level properties and configuration settings for the Iceberg table. + Schemas: + $ref: "#/components/schemas/IcebergSchemaList" + description: The list of schemas that have been associated with the Iceberg table over its history, supporting schema evolution. + CurrentSchemaId: + $ref: "#/components/schemas/Integer" + description: The identifier of the schema that is currently active for the Iceberg table. Matches an entry in Schemas. + LastColumnId: + $ref: "#/components/schemas/Integer" + description: The highest column identifier that has been assigned in the Iceberg table's schema, used to ensure unique IDs as new columns are added. + PartitionSpecs: + $ref: "#/components/schemas/IcebergPartitionSpecList" + description: The list of partition specifications that have been associated with the Iceberg table over its history, supporting partition evolution. + DefaultSpecId: + $ref: "#/components/schemas/Integer" + description: The identifier of the partition specification that is currently used by default when writing new data to the Iceberg table. + LastPartitionId: + $ref: "#/components/schemas/Integer" + description: The highest partition field identifier that has been assigned across the table's partition specifications. + SortOrders: + $ref: "#/components/schemas/IcebergSortOrderList" + description: The list of sort order specifications that have been associated with the Iceberg table over its history. + DefaultSortOrderId: + $ref: "#/components/schemas/Integer" + description: The identifier of the sort order that is currently used by default when writing new data to the Iceberg table. + TableIdString: + type: string + maxLength: 100 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + IcebergSchemaList: + type: array + items: + $ref: "#/components/schemas/IcebergSchema" + IcebergPartitionSpecList: + type: array + items: + $ref: "#/components/schemas/IcebergPartitionSpec" + IcebergSortOrderList: + type: array + items: + $ref: "#/components/schemas/IcebergSortOrder" TableStatus: description: A structure containing information about the state of an asynchronous change to a table. type: object @@ -19360,15 +21415,6 @@ components: minLength: 0 maxLength: 2048 pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - TableAttributesList: - type: array - items: - $ref: "#/components/schemas/TableAttributes" - TableAttributes: - type: string - enum: - - NAME - - TABLE_TYPE GetTablesResponse: type: object properties: @@ -19615,6 +21661,29 @@ components: $ref: "#/components/schemas/WorkflowRun" ImportCatalogToGlueResponse: type: object + ListAssetTypesResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/AssetTypeItemList" + description: The list of asset type items. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, present if the current segment is not the last. + AssetTypeItemList: + type: array + items: + $ref: "#/components/schemas/AssetTypeItem" + AssetTypeItem: + description: A summary of an asset type. + type: object + properties: + Id: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type. + Name: + $ref: "#/components/schemas/AssetTypeName" + description: The name of the asset type. OrchestrationPageSize25: type: integer minimum: 1 @@ -19929,6 +21998,9 @@ components: DataSource: $ref: "#/components/schemas/DataSource" description: The data source (Glue table) associated with the recommendation run. + CreatedRulesetName: + $ref: "#/components/schemas/NameString" + description: The name of the ruleset that was created by the recommendation run. DataQualityRulesetEvaluationRunFilter: description: The filter criteria. type: object @@ -20121,6 +22193,9 @@ components: DoubleValue: $ref: "#/components/schemas/double" description: The value of the statistic. + DistributionValue: + $ref: "#/components/schemas/DistributionData" + description: The distribution value for the statistic. EvaluationLevel: $ref: "#/components/schemas/StatisticEvaluationLevel" description: "The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn." @@ -20158,6 +22233,27 @@ components: double: type: number format: double + DistributionData: + description: The distribution data for a statistic. + type: object + properties: + BinEdges: + $ref: "#/components/schemas/BinEdges" + description: The bin edge values for the distribution. + Count: + $ref: "#/components/schemas/Count" + description: The frequency count for each bin in the distribution. + DataType: + $ref: "#/components/schemas/NameString" + description: The data type of the column for the distribution. + BinEdges: + type: array + items: + $ref: "#/components/schemas/GenericString" + Count: + type: array + items: + $ref: "#/components/schemas/NullableInteger" StatisticEvaluationLevel: type: string enum: @@ -20225,6 +22321,83 @@ components: type: string Category: type: string + ListFormTypesResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/FormTypeItemList" + description: The list of form type items. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, present if the current segment is not the last. + required: + - Items + FormTypeItemList: + type: array + items: + $ref: "#/components/schemas/FormTypeItem" + FormTypeItem: + description: A summary of a form type. + type: object + properties: + Id: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type. + Name: + $ref: "#/components/schemas/FormTypeName" + description: The name of the form type. + ListGlossariesResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/GlossaryItemList" + description: The list of glossary items. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, present if the current segment is not the last. + GlossaryItemList: + type: array + items: + $ref: "#/components/schemas/GlossaryItem" + GlossaryItem: + description: A summary of a business glossary. + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary. + Name: + $ref: "#/components/schemas/GlossaryName" + description: The name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The description of the glossary. + ListGlossaryTermsResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/GlossaryTermItemList" + description: The list of glossary term items. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, present if the current segment is not the last. + GlossaryTermItemList: + type: array + items: + $ref: "#/components/schemas/GlossaryTermItem" + GlossaryTermItem: + description: A summary of a glossary term. + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: The short description of the glossary term. String1024: type: string minLength: 1 @@ -20278,6 +22451,37 @@ components: description: The resource properties associated with the integration target. required: - ResourceArn + ListIterableFormsResponse: + type: object + properties: + Items: + $ref: "#/components/schemas/IterableFormListItemList" + description: The list of iterable form items. + NextToken: + $ref: "#/components/schemas/Token" + description: A continuation token, present if the current segment is not the last. + IterableFormListItemList: + type: array + items: + $ref: "#/components/schemas/IterableFormListItem" + IterableFormListItem: + description: A summary of an item in an iterable form. + type: object + properties: + ItemId: + $ref: "#/components/schemas/ItemId" + description: The unique identifier of the item. + ItemName: + $ref: "#/components/schemas/ItemName" + description: The name of the item. + Description: + $ref: "#/components/schemas/ItemDescription" + description: The description of the item. + GlossaryTerms: + $ref: "#/components/schemas/GlossaryTermIdList" + description: The identifiers of the glossary terms associated with the item. + ItemDescription: + type: string ListJobsRowDisplay: type: object properties: @@ -20595,11 +22799,94 @@ components: - IntegrationArn - Status - CreateTime + AssetFormMap: + type: object + properties: {} + PutAssetResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + Name: + $ref: "#/components/schemas/AssetName" + description: The name of the asset. + Description: + $ref: "#/components/schemas/AssetDescription" + description: The description of the asset. + CreatedAt: + $ref: "#/components/schemas/CreatedAt" + description: The timestamp at which the asset was created. + Forms: + type: object + properties: {} + description: The forms attached to the asset, keyed by form name. + required: + - Id + - Name + AssetTypeFormsMap: + type: object + properties: {} + PutAssetTypeResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type. + Name: + $ref: "#/components/schemas/AssetTypeName" + description: The name of the asset type. + Forms: + type: object + properties: {} + description: The forms that make up the asset type, keyed by form name. + FormContent: + type: string + PutAttachmentResponse: + type: object + properties: + AssetIdentifier: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + IterableFormName: + $ref: "#/components/schemas/IterableFormName" + description: The name of the iterable form, if the attachment targets an item. + ItemIdentifier: + $ref: "#/components/schemas/ItemIdentifier" + description: The identifier of the item within the iterable form, if applicable. + AttachmentName: + $ref: "#/components/schemas/AttachmentName" + description: The name of the attachment. + FormTypeId: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type for this attachment. PutDataCatalogEncryptionSettingsResponse: type: object + PutDataCatalogExportConfigurationOutput: + description: The export configuration returned by the PutDataCatalogExportConfiguration operation. + type: object + properties: + ExportSetting: + $ref: "#/components/schemas/ExportSetting" + description: The export setting for the data catalog. + EncryptionConfiguration: + $ref: "#/components/schemas/ExportEncryptionConfiguration" + description: The encryption configuration for the exported data. PutDataQualityProfileAnnotationResponse: description: Left blank. type: object + PutFormTypeResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/FormTypeId" + description: The identifier of the form type. + Name: + $ref: "#/components/schemas/FormTypeName" + description: The name of the form type. + Schema: + $ref: "#/components/schemas/FormTypeSchema" + description: The Smithy IDL schema of the form type. ExistCondition: type: string enum: @@ -20919,6 +23206,162 @@ components: Id: $ref: "#/components/schemas/IntegerValue" description: Returns the Id of the statement that was run. + SearchText: + type: string + minLength: 1 + maxLength: 1000 + SearchMaxResults: + type: integer + minimum: 1 + maximum: 100 + SearchNextToken: + type: string + SearchSort: + description: The sort criteria for search results. + type: object + properties: + Attribute: + $ref: "#/components/schemas/SearchAttribute" + description: The attribute to sort by. + Order: + $ref: "#/components/schemas/SearchSortOrder" + description: The sort order. Valid values are ASCENDING and DESCENDING. + required: + - Attribute + SearchAttribute: + type: string + minLength: 1 + maxLength: 128 + SearchSortOrder: + type: string + enum: + - ASCENDING + - DESCENDING + SearchFilterClause: + description: A filter clause that supports nested boolean logic. Exactly one of andAllFilters, orAnyFilters, attributeFilter, or mapFilter must be specified. + type: object + properties: + AndAllFilters: + $ref: "#/components/schemas/SearchFilterClauseList" + description: A list of filter clauses that must all match (logical AND). + OrAnyFilters: + $ref: "#/components/schemas/SearchFilterClauseList" + description: A list of filter clauses where at least one must match (logical OR). + AttributeFilter: + $ref: "#/components/schemas/SearchAttributeFilter" + description: A filter on a single attribute value. + MapFilter: + $ref: "#/components/schemas/SearchMapFilter" + description: A filter on a map attribute's key-value pair. + SearchFilterClauseList: + type: array + items: + $ref: "#/components/schemas/SearchFilterClause" + SearchAttributeFilter: + description: A filter that compares an attribute value using an operator. + type: object + properties: + Attribute: + $ref: "#/components/schemas/SearchAttribute" + description: The attribute name to filter on. + Operator: + $ref: "#/components/schemas/SearchFilterOperator" + description: The comparison operator. Valid values are equals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, and notExists. + Value: + $ref: "#/components/schemas/SearchFilterValue" + description: The value to compare against. + required: + - Attribute + - Operator + SearchFilterOperator: + type: string + enum: + - equals + - greaterThan + - greaterThanOrEquals + - lessThan + - lessThanOrEquals + - notExists + SearchFilterValue: + description: A filter value. Exactly one of stringValue or longValue must be specified. + type: object + properties: + StringValue: + $ref: "#/components/schemas/SearchFilterStringValue" + description: A string filter value. + LongValue: + $ref: "#/components/schemas/SearchFilterLongValue" + description: A long integer filter value. + SearchFilterStringValue: + type: string + minLength: 0 + maxLength: 256 + SearchFilterLongValue: + type: integer + format: int64 + SearchMapFilter: + description: A filter on a map attribute's key-value pair. + type: object + properties: + Attribute: + $ref: "#/components/schemas/SearchAttribute" + description: The map attribute name to filter on. + Key: + $ref: "#/components/schemas/SearchMapKey" + description: The key within the map attribute to filter on. + Value: + $ref: "#/components/schemas/SearchMapFilterValue" + description: The value to compare against. + required: + - Attribute + - Key + - Value + SearchMapKey: + type: string + minLength: 1 + maxLength: 128 + SearchMapFilterValue: + description: A map filter value. Currently supports string comparison only. + type: object + properties: + StringValue: + $ref: "#/components/schemas/SearchFilterStringValue" + description: A string filter value. + SearchAssetsOutput: + description: The search results returned by the SearchAssets operation. + type: object + properties: + Items: + $ref: "#/components/schemas/SearchResultItemList" + description: The list of assets matching the search criteria. + NextToken: + $ref: "#/components/schemas/SearchNextToken" + description: A continuation token, present if the current segment is not the last. + SearchResultItemList: + type: array + items: + $ref: "#/components/schemas/SearchResultItem" + SearchResultItem: + description: A single search result item representing a matched asset. + type: object + properties: + Id: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the matched asset. + AssetName: + $ref: "#/components/schemas/SearchResultName" + description: The name of the matched asset. + AssetDescription: + $ref: "#/components/schemas/AssetDescription" + description: The description of the matched asset. + UpdatedAt: + $ref: "#/components/schemas/UpdatedAt" + description: The timestamp at which the matched asset was last updated. + AssetTypeId: + $ref: "#/components/schemas/AssetTypeId" + description: The identifier of the asset type for the matched asset. + SearchResultName: + type: string SearchPropertyPredicates: type: array items: @@ -21104,6 +23547,23 @@ components: $ref: "#/components/schemas/TagKey" UntagResourceResponse: type: object + UpdateAssetResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/AssetId" + description: The unique identifier of the asset. + Name: + $ref: "#/components/schemas/AssetName" + description: The name of the asset. + Description: + $ref: "#/components/schemas/AssetDescription" + description: The description of the asset. + UpdatedAt: + $ref: "#/components/schemas/UpdatedAt" + description: The timestamp at which the asset was last updated. + required: + - Id UpdateBlueprintResponse: type: object properties: @@ -21264,6 +23724,36 @@ components: description: The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint. You can only use pure Java/Scala libraries with a DevEndpoint. UpdateDevEndpointResponse: type: object + UpdateGlossaryResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary. + Name: + $ref: "#/components/schemas/GlossaryName" + description: The name of the glossary. + Description: + $ref: "#/components/schemas/MetadataDescription" + description: The description of the glossary. + UpdateGlossaryTermResponse: + type: object + properties: + Id: + $ref: "#/components/schemas/GlossaryTermId" + description: The unique identifier of the glossary term. + GlossaryId: + $ref: "#/components/schemas/GlossaryId" + description: The unique identifier of the glossary containing this term. + Name: + $ref: "#/components/schemas/GlossaryTermName" + description: The name of the glossary term. + ShortDescription: + $ref: "#/components/schemas/GlossaryShortDescription" + description: The short description of the glossary term. + LongDescription: + $ref: "#/components/schemas/GlossaryLongDescription" + description: The long description of the glossary term. UpdateGlueIdentityCenterConfigurationResponse: description: Response from updating an existing Glue Identity Center configuration. type: object @@ -21574,6 +24064,121 @@ components: $ref: "#/components/schemas/NameString" description: The name of the workflow which was specified in input. x-stackQL-resources: + glossary_terms: + id: aws.glue.glossary_terms + name: glossary_terms + title: glossary_terms + methods: + associate_glossary_terms: + operation: + $ref: "#/paths/~1AssociateGlossaryTerms/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + create_glossary_term: + operation: + $ref: "#/paths/~1CreateGlossaryTerm/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_glossary_term: + operation: + $ref: "#/paths/~1DeleteGlossaryTerm/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + disassociate_glossary_terms: + operation: + $ref: "#/paths/~1DisassociateGlossaryTerms/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_glossary_term: + operation: + $ref: "#/paths/~1GetGlossaryTerm/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_glossary_terms: + operation: + $ref: "#/paths/~1ListGlossaryTerms/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_glossary_term: + operation: + $ref: "#/paths/~1UpdateGlossaryTerm/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/get_glossary_term" + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/list_glossary_terms" + insert: + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/create_glossary_term" + update: + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/associate_glossary_terms" + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/update_glossary_term" + delete: + - $ref: "#/components/x-stackQL-resources/glossary_terms/methods/delete_glossary_term" databases: id: aws.glue.databases name: databases @@ -22193,6 +24798,58 @@ components: insert: [] update: [] delete: [] + data_quality_ruleset_evaluation_runs: + id: aws.glue.data_quality_ruleset_evaluation_runs + name: data_quality_ruleset_evaluation_runs + title: data_quality_ruleset_evaluation_runs + methods: + batch_get_data_quality_ruleset_evaluation_run: + operation: + $ref: "#/paths/~1BatchGetDataQualityRulesetEvaluationRun/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_data_quality_ruleset_evaluation_run: + operation: + $ref: "#/paths/~1GetDataQualityRulesetEvaluationRun/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_data_quality_ruleset_evaluation_runs: + operation: + $ref: "#/paths/~1ListDataQualityRulesetEvaluationRuns/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_quality_ruleset_evaluation_runs/methods/batch_get_data_quality_ruleset_evaluation_run" + - $ref: "#/components/x-stackQL-resources/data_quality_ruleset_evaluation_runs/methods/get_data_quality_ruleset_evaluation_run" + - $ref: "#/components/x-stackQL-resources/data_quality_ruleset_evaluation_runs/methods/list_data_quality_ruleset_evaluation_runs" + insert: [] + update: [] + delete: [] dev_endpoints: id: aws.glue.dev_endpoints name: dev_endpoints @@ -22316,6 +24973,52 @@ components: - $ref: "#/components/x-stackQL-resources/dev_endpoints/methods/update_dev_endpoint" delete: - $ref: "#/components/x-stackQL-resources/dev_endpoints/methods/delete_dev_endpoint" + iterable_forms: + id: aws.glue.iterable_forms + name: iterable_forms + title: iterable_forms + methods: + batch_get_iterable_forms: + operation: + $ref: "#/paths/~1BatchGetIterableForms/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_iterable_forms: + operation: + $ref: "#/paths/~1ListIterableForms/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/iterable_forms/methods/batch_get_iterable_forms" + - $ref: "#/components/x-stackQL-resources/iterable_forms/methods/list_iterable_forms" + insert: [] + update: [] + delete: [] jobs: id: aws.glue.jobs name: jobs @@ -23429,23 +26132,111 @@ components: config: requestBodyTranslate: algorithm: naive - get_column_statistics_task_settings: + get_column_statistics_task_settings: + operation: + $ref: "#/paths/~1GetColumnStatisticsTaskSettings/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ColumnStatisticsTaskSettings + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_column_statistics_task_settings: + operation: + $ref: "#/paths/~1UpdateColumnStatisticsTaskSettings/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/get_column_statistics_task_settings" + insert: + - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/create_column_statistics_task_settings" + update: + - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/update_column_statistics_task_settings" + delete: + - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/delete_column_statistics_task_settings" + connections: + id: aws.glue.connections + name: connections + title: connections + methods: + create_connection: + operation: + $ref: "#/paths/~1CreateConnection/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_connection: + operation: + $ref: "#/paths/~1DeleteConnection/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_connection: + operation: + $ref: "#/paths/~1GetConnection/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Connection + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_connections: operation: - $ref: "#/paths/~1GetColumnStatisticsTaskSettings/post" + $ref: "#/paths/~1GetConnections/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.ColumnStatisticsTaskSettings + objectKey: $.ConnectionList request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 base: "{}" config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body requestBodyTranslate: algorithm: naive - update_column_statistics_task_settings: + update_connection: operation: - $ref: "#/paths/~1UpdateColumnStatisticsTaskSettings/post" + $ref: "#/paths/~1UpdateConnection/post" response: openAPIDocKey: "200" mediaType: application/json @@ -23458,21 +26249,21 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/get_column_statistics_task_settings" + - $ref: "#/components/x-stackQL-resources/connections/methods/get_connection" insert: - - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/create_column_statistics_task_settings" + - $ref: "#/components/x-stackQL-resources/connections/methods/create_connection" update: - - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/update_column_statistics_task_settings" + - $ref: "#/components/x-stackQL-resources/connections/methods/update_connection" delete: - - $ref: "#/components/x-stackQL-resources/column_statistics_task_settings/methods/delete_column_statistics_task_settings" - connections: - id: aws.glue.connections - name: connections - title: connections + - $ref: "#/components/x-stackQL-resources/connections/methods/delete_connection" + glossaries: + id: aws.glue.glossaries + name: glossaries + title: glossaries methods: - create_connection: + create_glossary: operation: - $ref: "#/paths/~1CreateConnection/post" + $ref: "#/paths/~1CreateGlossary/post" response: openAPIDocKey: "200" mediaType: application/json @@ -23483,9 +26274,9 @@ components: config: requestBodyTranslate: algorithm: naive - delete_connection: + delete_glossary: operation: - $ref: "#/paths/~1DeleteConnection/post" + $ref: "#/paths/~1DeleteGlossary/post" response: openAPIDocKey: "200" mediaType: application/json @@ -23496,13 +26287,12 @@ components: config: requestBodyTranslate: algorithm: naive - get_connection: + get_glossary: operation: - $ref: "#/paths/~1GetConnection/post" + $ref: "#/paths/~1GetGlossary/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.Connection request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -23510,13 +26300,13 @@ components: config: requestBodyTranslate: algorithm: naive - get_connections: + list_glossaries: operation: - $ref: "#/paths/~1GetConnections/post" + $ref: "#/paths/~1ListGlossaries/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.ConnectionList + objectKey: $.Items request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -23531,9 +26321,9 @@ components: location: body requestBodyTranslate: algorithm: naive - update_connection: + update_glossary: operation: - $ref: "#/paths/~1UpdateConnection/post" + $ref: "#/paths/~1UpdateGlossary/post" response: openAPIDocKey: "200" mediaType: application/json @@ -23546,13 +26336,14 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/connections/methods/get_connection" + - $ref: "#/components/x-stackQL-resources/glossaries/methods/get_glossary" + - $ref: "#/components/x-stackQL-resources/glossaries/methods/list_glossaries" insert: - - $ref: "#/components/x-stackQL-resources/connections/methods/create_connection" + - $ref: "#/components/x-stackQL-resources/glossaries/methods/create_glossary" update: - - $ref: "#/components/x-stackQL-resources/connections/methods/update_connection" + - $ref: "#/components/x-stackQL-resources/glossaries/methods/update_glossary" delete: - - $ref: "#/components/x-stackQL-resources/connections/methods/delete_connection" + - $ref: "#/components/x-stackQL-resources/glossaries/methods/delete_glossary" glue_identity_center_configurations: id: aws.glue.glue_identity_center_configurations name: glue_identity_center_configurations @@ -24310,30 +27101,247 @@ components: config: requestBodyTranslate: algorithm: naive - get_tables: + get_tables: + operation: + $ref: "#/paths/~1GetTables/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.TableList + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + search_tables: + operation: + $ref: "#/paths/~1SearchTables/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_table: + operation: + $ref: "#/paths/~1UpdateTable/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tables/methods/get_table" + - $ref: "#/components/x-stackQL-resources/tables/methods/search_tables" + insert: + - $ref: "#/components/x-stackQL-resources/tables/methods/create_table" + update: + - $ref: "#/components/x-stackQL-resources/tables/methods/update_table" + delete: + - $ref: "#/components/x-stackQL-resources/tables/methods/delete_table" + usage_profiles: + id: aws.glue.usage_profiles + name: usage_profiles + title: usage_profiles + methods: + create_usage_profile: + operation: + $ref: "#/paths/~1CreateUsageProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_usage_profile: + operation: + $ref: "#/paths/~1DeleteUsageProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_usage_profile: + operation: + $ref: "#/paths/~1GetUsageProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_usage_profiles: + operation: + $ref: "#/paths/~1ListUsageProfiles/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Profiles + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_usage_profile: + operation: + $ref: "#/paths/~1UpdateUsageProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/get_usage_profile" + insert: + - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/create_usage_profile" + update: + - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/update_usage_profile" + delete: + - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/delete_usage_profile" + user_defined_functions: + id: aws.glue.user_defined_functions + name: user_defined_functions + title: user_defined_functions + methods: + create_user_defined_function: + operation: + $ref: "#/paths/~1CreateUserDefinedFunction/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_user_defined_function: + operation: + $ref: "#/paths/~1DeleteUserDefinedFunction/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_user_defined_function: + operation: + $ref: "#/paths/~1GetUserDefinedFunction/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.UserDefinedFunction + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_user_defined_functions: + operation: + $ref: "#/paths/~1GetUserDefinedFunctions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.UserDefinedFunctions + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_user_defined_function: operation: - $ref: "#/paths/~1GetTables/post" + $ref: "#/paths/~1UpdateUserDefinedFunction/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.TableList request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 base: "{}" config: - pagination: - requestToken: - key: NextToken - location: body - responseToken: - key: $.NextToken - location: body requestBodyTranslate: algorithm: naive - search_tables: + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/get_user_defined_function" + - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/get_user_defined_functions" + insert: + - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/create_user_defined_function" + update: + - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/update_user_defined_function" + delete: + - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/delete_user_defined_function" + assets: + id: aws.glue.assets + name: assets + title: assets + methods: + delete_asset: operation: - $ref: "#/paths/~1SearchTables/post" + $ref: "#/paths/~1DeleteAsset/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24344,9 +27352,9 @@ components: config: requestBodyTranslate: algorithm: naive - update_table: + delete_attachment: operation: - $ref: "#/paths/~1UpdateTable/post" + $ref: "#/paths/~1DeleteAttachment/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24357,24 +27365,9 @@ components: config: requestBodyTranslate: algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/tables/methods/get_table" - - $ref: "#/components/x-stackQL-resources/tables/methods/search_tables" - insert: - - $ref: "#/components/x-stackQL-resources/tables/methods/create_table" - update: - - $ref: "#/components/x-stackQL-resources/tables/methods/update_table" - delete: - - $ref: "#/components/x-stackQL-resources/tables/methods/delete_table" - usage_profiles: - id: aws.glue.usage_profiles - name: usage_profiles - title: usage_profiles - methods: - create_usage_profile: + get_asset: operation: - $ref: "#/paths/~1CreateUsageProfile/post" + $ref: "#/paths/~1GetAsset/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24385,9 +27378,9 @@ components: config: requestBodyTranslate: algorithm: naive - delete_usage_profile: + put_asset: operation: - $ref: "#/paths/~1DeleteUsageProfile/post" + $ref: "#/paths/~1PutAsset/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24398,9 +27391,9 @@ components: config: requestBodyTranslate: algorithm: naive - get_usage_profile: + put_attachment: operation: - $ref: "#/paths/~1GetUsageProfile/post" + $ref: "#/paths/~1PutAttachment/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24411,13 +27404,13 @@ components: config: requestBodyTranslate: algorithm: naive - list_usage_profiles: + search_assets: operation: - $ref: "#/paths/~1ListUsageProfiles/post" + $ref: "#/paths/~1SearchAssets/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.Profiles + objectKey: $.Items request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -24432,9 +27425,9 @@ components: location: body requestBodyTranslate: algorithm: naive - update_usage_profile: + update_asset: operation: - $ref: "#/paths/~1UpdateUsageProfile/post" + $ref: "#/paths/~1UpdateAsset/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24447,34 +27440,25 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/get_usage_profile" - insert: - - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/create_usage_profile" + - $ref: "#/components/x-stackQL-resources/assets/methods/get_asset" + - $ref: "#/components/x-stackQL-resources/assets/methods/search_assets" + insert: [] update: - - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/update_usage_profile" + - $ref: "#/components/x-stackQL-resources/assets/methods/update_asset" + replace: + - $ref: "#/components/x-stackQL-resources/assets/methods/put_attachment" + - $ref: "#/components/x-stackQL-resources/assets/methods/put_asset" delete: - - $ref: "#/components/x-stackQL-resources/usage_profiles/methods/delete_usage_profile" - user_defined_functions: - id: aws.glue.user_defined_functions - name: user_defined_functions - title: user_defined_functions + - $ref: "#/components/x-stackQL-resources/assets/methods/delete_attachment" + - $ref: "#/components/x-stackQL-resources/assets/methods/delete_asset" + asset_types: + id: aws.glue.asset_types + name: asset_types + title: asset_types methods: - create_user_defined_function: - operation: - $ref: "#/paths/~1CreateUserDefinedFunction/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - delete_user_defined_function: + delete_asset_type: operation: - $ref: "#/paths/~1DeleteUserDefinedFunction/post" + $ref: "#/paths/~1DeleteAssetType/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24485,13 +27469,12 @@ components: config: requestBodyTranslate: algorithm: naive - get_user_defined_function: + get_asset_type: operation: - $ref: "#/paths/~1GetUserDefinedFunction/post" + $ref: "#/paths/~1GetAssetType/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.UserDefinedFunction request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -24499,13 +27482,13 @@ components: config: requestBodyTranslate: algorithm: naive - get_user_defined_functions: + list_asset_types: operation: - $ref: "#/paths/~1GetUserDefinedFunctions/post" + $ref: "#/paths/~1ListAssetTypes/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.UserDefinedFunctions + objectKey: $.Items request: nativeCasing: pascal mediaType: application/x-amz-json-1.1 @@ -24520,9 +27503,9 @@ components: location: body requestBodyTranslate: algorithm: naive - update_user_defined_function: + put_asset_type: operation: - $ref: "#/paths/~1UpdateUserDefinedFunction/post" + $ref: "#/paths/~1PutAssetType/post" response: openAPIDocKey: "200" mediaType: application/json @@ -24535,14 +27518,14 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/get_user_defined_function" - - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/get_user_defined_functions" - insert: - - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/create_user_defined_function" - update: - - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/update_user_defined_function" + - $ref: "#/components/x-stackQL-resources/asset_types/methods/get_asset_type" + - $ref: "#/components/x-stackQL-resources/asset_types/methods/list_asset_types" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/asset_types/methods/put_asset_type" delete: - - $ref: "#/components/x-stackQL-resources/user_defined_functions/methods/delete_user_defined_function" + - $ref: "#/components/x-stackQL-resources/asset_types/methods/delete_asset_type" column_statistics_for_partitions: id: aws.glue.column_statistics_for_partitions name: column_statistics_for_partitions @@ -24721,6 +27704,81 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/connection_types/methods/delete_connection_type" + form_types: + id: aws.glue.form_types + name: form_types + title: form_types + methods: + delete_form_type: + operation: + $ref: "#/paths/~1DeleteFormType/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_form_type: + operation: + $ref: "#/paths/~1GetFormType/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_form_types: + operation: + $ref: "#/paths/~1ListFormTypes/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + put_form_type: + operation: + $ref: "#/paths/~1PutFormType/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/form_types/methods/get_form_type" + - $ref: "#/components/x-stackQL-resources/form_types/methods/list_form_types" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/form_types/methods/put_form_type" + delete: + - $ref: "#/components/x-stackQL-resources/form_types/methods/delete_form_type" resource_policies: id: aws.glue.resource_policies name: resource_policies @@ -25218,6 +28276,30 @@ components: insert: [] update: [] delete: [] + dashboard_urls: + id: aws.glue.dashboard_urls + name: dashboard_urls + title: dashboard_urls + methods: + get_dashboard_url: + operation: + $ref: "#/paths/~1GetDashboardUrl/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dashboard_urls/methods/get_dashboard_url" + insert: [] + update: [] + delete: [] data_catalog_encryption_settings: id: aws.glue.data_catalog_encryption_settings name: data_catalog_encryption_settings @@ -25258,6 +28340,45 @@ components: replace: - $ref: "#/components/x-stackQL-resources/data_catalog_encryption_settings/methods/put_data_catalog_encryption_settings" delete: [] + data_catalog_export_configurations: + id: aws.glue.data_catalog_export_configurations + name: data_catalog_export_configurations + title: data_catalog_export_configurations + methods: + get_data_catalog_export_configuration: + operation: + $ref: "#/paths/~1GetDataCatalogExportConfiguration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + put_data_catalog_export_configuration: + operation: + $ref: "#/paths/~1PutDataCatalogExportConfiguration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_catalog_export_configurations/methods/get_data_catalog_export_configuration" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/data_catalog_export_configurations/methods/put_data_catalog_export_configuration" + delete: [] data_quality_models: id: aws.glue.data_quality_models name: data_quality_models @@ -25344,44 +28465,6 @@ components: insert: [] update: [] delete: [] - data_quality_ruleset_evaluation_runs: - id: aws.glue.data_quality_ruleset_evaluation_runs - name: data_quality_ruleset_evaluation_runs - title: data_quality_ruleset_evaluation_runs - methods: - get_data_quality_ruleset_evaluation_run: - operation: - $ref: "#/paths/~1GetDataQualityRulesetEvaluationRun/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - list_data_quality_ruleset_evaluation_runs: - operation: - $ref: "#/paths/~1ListDataQualityRulesetEvaluationRuns/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - mediaType: application/x-amz-json-1.1 - base: "{}" - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/data_quality_ruleset_evaluation_runs/methods/get_data_quality_ruleset_evaluation_run" - - $ref: "#/components/x-stackQL-resources/data_quality_ruleset_evaluation_runs/methods/list_data_quality_ruleset_evaluation_runs" - insert: [] - update: [] - delete: [] dataflow_graphs: id: aws.glue.dataflow_graphs name: dataflow_graphs @@ -25643,6 +28726,31 @@ components: insert: [] update: [] delete: [] + session_endpoints: + id: aws.glue.session_endpoints + name: session_endpoints + title: session_endpoints + methods: + get_session_endpoint: + operation: + $ref: "#/paths/~1GetSessionEndpoint/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.SparkConnect + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/session_endpoints/methods/get_session_endpoint" + insert: [] + update: [] + delete: [] statements: id: aws.glue.statements name: statements diff --git a/providers/src/aws/v00.00.00000/services/grafana.yaml b/providers/src/aws/v00.00.00000/services/grafana.yaml index b64e6107..ffbf033b 100644 --- a/providers/src/aws/v00.00.00000/services/grafana.yaml +++ b/providers/src/aws/v00.00.00000/services/grafana.yaml @@ -911,6 +911,9 @@ components: kmsKeyId: $ref: "#/components/schemas/KmsKeyId" description: The ID or ARN of the Key Management Service key used for encrypting workspace data. + degradedWorkspaceReason: + $ref: "#/components/schemas/DegradedWorkspaceReason" + description: If the workspace is in the DEGRADED status, this field describes the reason the workspace is degraded. required: - created - dataSources @@ -1000,6 +1003,7 @@ components: - LICENSE_REMOVAL_FAILED - VERSION_UPDATING - VERSION_UPDATE_FAILED + - DEGRADED IamRoleArn: type: string minLength: 1 @@ -1100,6 +1104,10 @@ components: minLength: 1 maxLength: 2048 pattern: "[a-zA-Z0-9:/_-]+" + DegradedWorkspaceReason: + type: string + minLength: 1 + maxLength: 255 ClientToken: type: string pattern: "[!-~]{1,64}" diff --git a/providers/src/aws/v00.00.00000/services/groundstation.yaml b/providers/src/aws/v00.00.00000/services/groundstation.yaml index ce6d9cc8..27c30bf9 100644 --- a/providers/src/aws/v00.00.00000/services/groundstation.yaml +++ b/providers/src/aws/v00.00.00000/services/groundstation.yaml @@ -1930,12 +1930,12 @@ components: type: string minLength: 69 maxLength: 69 - pattern: "1 [ 0-9]{5}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]" + pattern: "1 [ 0-9A-HJ-NP-Z][ 0-9]{4}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]" TleLineTwo: type: string minLength: 69 maxLength: 69 - pattern: 2 [ 0-9]{5} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9] + pattern: 2 [ 0-9A-HJ-NP-Z][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9] TimeRange: description: A time range with a start and end time. type: object @@ -2795,7 +2795,7 @@ components: noradSatelliteID: type: integer minimum: 0 - maximum: 99999 + maximum: 339999 GroundStationIdList: type: array items: diff --git a/providers/src/aws/v00.00.00000/services/guardduty.yaml b/providers/src/aws/v00.00.00000/services/guardduty.yaml index fa7cac83..e963fa21 100644 --- a/providers/src/aws/v00.00.00000/services/guardduty.yaml +++ b/providers/src/aws/v00.00.00000/services/guardduty.yaml @@ -339,6 +339,37 @@ paths: application/json: schema: $ref: "#/components/schemas/ListIPSetsOutputDisplay" + /detector/{detector_id}/investigation: + post: + operationId: CreateInvestigation + description: "This API is currently available as a preview. During the preview, you can initiate up to 10 investigations per account per day, with a total limit of 100 investigations per account. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo). Initiates a GuardDuty investigation that automatically analyzes security findings, correlates related activity, performs account-level analysis, and produces a structured investigation summary with recommended next steps. Only the administrator account can create an investigation. Member accounts don't have permission to create investigations from their accounts. To use this operation, the AI_ANALYST feature must be enabled on your detector. This feature uses Amazon Bedrock models that leverage Cross-Region Inference (CRIS), which automatically selects the optimal Amazon Web Services Region within your geography to process the investigation analysis and generate the investigation report. This maximizes available compute resources, model availability, and delivers the best customer experience. Your data remains stored only in the Region where the investigation request originates, however, investigation data and summary results may be processed outside that Region. All data is transmitted encrypted across Amazon's secure network. For more information, see GuardDuty Investigation." + parameters: + - name: detector_id + in: path + required: true + schema: + $ref: "#/components/schemas/DetectorId" + description: The unique ID of the GuardDuty detector for the account in which the investigation is created. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TriggerPrompt: + $ref: "#/components/schemas/TriggerPrompt" + ClientToken: + $ref: "#/components/schemas/ClientToken" + required: + - TriggerPrompt + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateInvestigationResponse" /malware-protection-plan: post: operationId: CreateMalwareProtectionPlan @@ -546,7 +577,7 @@ paths: /detector/{detector_id}/threatentityset: post: operationId: CreateThreatEntitySet - description: Creates a new threat entity set. In a threat entity set, you can provide known malicious IP addresses and domains for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts. + description: Creates a new threat entity set. In a threat entity set, you can provide known malicious threat entities for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts. parameters: - name: detector_id in: path @@ -1759,6 +1790,30 @@ paths: application/json: schema: $ref: "#/components/schemas/GetFindingsStatisticsResponse" + /detector/{detector_id}/investigation/{investigation_id}: + get: + operationId: GetInvestigation + description: "This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo). Retrieves the results and status of a specific GuardDuty investigation. An administrator account can retrieve any investigation within the organization. Member accounts can only retrieve investigations that belong to them." + parameters: + - name: detector_id + in: path + required: true + schema: + $ref: "#/components/schemas/DetectorId" + description: The unique ID of the GuardDuty detector associated with the investigation. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API. + - name: investigation_id + in: path + required: true + schema: + $ref: "#/components/schemas/InvestigationId" + description: The unique identifier of the investigation to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetInvestigationResponse" /invitation/count: get: operationId: GetInvitationsCount @@ -2071,6 +2126,37 @@ paths: application/json: schema: $ref: "#/components/schemas/ListFindingsOutputDisplay" + /detector/{detector_id}/investigation/list: + post: + operationId: ListInvestigations + description: "This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo). Returns a list of investigations associated with the specified GuardDuty detector. An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them." + parameters: + - name: detector_id + in: path + required: true + schema: + $ref: "#/components/schemas/DetectorId" + description: The unique ID of the GuardDuty detector whose investigations you want to list. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + SortCriteria: + $ref: "#/components/schemas/InvestigationSortCriteria" + MaxResults: + $ref: "#/components/schemas/MaxResults" + NextToken: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListInvestigationsResponse" /invitation: get: operationId: ListInvitations @@ -2584,6 +2670,8 @@ components: - LAMBDA_NETWORK_LOGS - EKS_RUNTIME_MONITORING - RUNTIME_MONITORING + - AI_PROTECTION + - AI_ANALYST FeatureStatus: type: string enum: @@ -2724,6 +2812,23 @@ components: description: The ID of the IPSet resource. required: - IpSetId + TriggerPrompt: + type: string + minLength: 1 + maxLength: 2048 + CreateInvestigationResponse: + type: object + properties: + InvestigationId: + $ref: "#/components/schemas/InvestigationId" + description: The unique identifier of the newly created investigation. + required: + - InvestigationId + InvestigationId: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-fA-F0-9\\-]+" CreateProtectedResource: description: Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource. type: object @@ -3295,6 +3400,7 @@ components: - LAMBDA_NETWORK_LOGS - EKS_RUNTIME_MONITORING - RUNTIME_MONITORING + - AI_PROTECTION OrgFeatureStatus: type: string enum: @@ -3639,6 +3745,8 @@ components: - LAMBDA_NETWORK_LOGS - EKS_RUNTIME_MONITORING - RUNTIME_MONITORING + - AI_PROTECTION + - AI_ANALYST DetectorAdditionalConfigurationResults: type: array items: @@ -3678,10 +3786,23 @@ components: type: object properties: {} description: The tags of the filter resource. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the filter was created. This field is not available for filters that were created before the lifecycle metadata feature was enabled (legacy filters). + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the filter was last updated. For legacy filters, this field is present only after the filter has been updated at least once since the lifecycle metadata feature was enabled. + Version: + $ref: "#/components/schemas/FilterVersion" + description: The version of the filter. Every time the filter is updated, the version increments by 1. This field is not available for legacy filters that were created before the lifecycle metadata feature was enabled. required: - Name - Action - FindingCriteria + FilterVersion: + type: integer + format: int64 + minimum: 1 GetFindingsResponse: type: object properties: @@ -3809,6 +3930,12 @@ components: RecoveryPointDetails: $ref: "#/components/schemas/RecoveryPointDetails" description: Contains details about the backup recovery point that was scanned. + BedrockGuardrailDetails: + $ref: "#/components/schemas/BedrockGuardrailDetails" + description: Contains information about the Bedrock guardrail that was involved in a finding. + ModelDetails: + $ref: "#/components/schemas/ModelDetails" + description: Contains information about the AI models involved in a finding. AccessKeyDetails: description: Contains information about the access keys. type: object @@ -4522,6 +4649,140 @@ components: BackupVaultName: $ref: "#/components/schemas/String" description: The name of the backup vault containing the recovery point. + ContinuousScanDetails: + $ref: "#/components/schemas/ScanConfigurationContinuousScanDetails" + ScanConfigurationContinuousScanDetails: + description: Contains information about the time range within the continuous backup in Amazon Web Services Backup that was scanned for a point-in-time recovery resource. + type: object + properties: + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp representing the start of the time range that was scanned. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp representing the end of the time range that was scanned. + required: + - EndTime + BedrockGuardrailDetails: + description: Contains information about the Bedrock guardrail that was involved in a finding. + type: object + properties: + GuardrailArn: + $ref: "#/components/schemas/BedrockGuardrailDetailsGuardrailArnString" + description: The ARN of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead. + GuardrailVersion: + $ref: "#/components/schemas/BedrockGuardrailDetailsGuardrailVersionString" + description: The version of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead. + Guardrails: + $ref: "#/components/schemas/BedrockGuardrails" + description: The list of Bedrock guardrails associated with the finding. + GuardrailAction: + $ref: "#/components/schemas/GuardrailAction" + description: Indicates whether the guardrail intervened or not. + GuardrailSource: + $ref: "#/components/schemas/GuardrailSource" + description: Indicates whether the guardrail was applied on the input or output of the model invocation. + ContentPolicyFilters: + $ref: "#/components/schemas/ContentPolicyFilters" + description: The list of content policy filters that matched during the guardrail evaluation. + BedrockGuardrailDetailsGuardrailArnString: + type: string + minLength: 0 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+ + BedrockGuardrailDetailsGuardrailVersionString: + type: string + minLength: 1 + maxLength: 8 + pattern: (([1-9][0-9]{0,7})|(DRAFT)) + BedrockGuardrails: + type: array + items: + $ref: "#/components/schemas/BedrockGuardrail" + BedrockGuardrail: + description: Contains information about a Bedrock guardrail associated with a finding. + type: object + properties: + Arn: + $ref: "#/components/schemas/BedrockGuardrailArnString" + description: The ARN of the Bedrock guardrail. + Version: + $ref: "#/components/schemas/BedrockGuardrailVersionString" + description: The version of the Bedrock guardrail. + BedrockGuardrailArnString: + type: string + minLength: 0 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+ + BedrockGuardrailVersionString: + type: string + minLength: 1 + maxLength: 8 + pattern: (([1-9][0-9]{0,7})|(DRAFT)|(ENFORCED)) + GuardrailAction: + type: string + enum: + - GUARDRAIL_INTERVENED + - NONE + GuardrailSource: + type: string + enum: + - INPUT + - OUTPUT + ContentPolicyFilters: + type: array + items: + $ref: "#/components/schemas/ContentPolicyFilter" + ContentPolicyFilter: + description: Contains information about a content policy filter that matched during a guardrail evaluation. + type: object + properties: + Type: + $ref: "#/components/schemas/ContentPolicyFilterType" + description: The type of content that was filtered by the guardrail. + Confidence: + $ref: "#/components/schemas/ConfidenceLevel" + description: The confidence level that the content matched the filter. + Action: + $ref: "#/components/schemas/ContentPolicyFilterAction" + description: The action taken by the guardrail filter. + ContentPolicyFilterType: + type: string + enum: + - PROMPT_ATTACK + - JAILBREAK + - HATE + - INSULTS + - SEXUAL + - VIOLENCE + - MISCONDUCT + ConfidenceLevel: + type: string + enum: + - HIGH + - MEDIUM + - LOW + - NONE + ContentPolicyFilterAction: + type: string + enum: + - BLOCKED + - NONE + ModelDetails: + type: array + items: + $ref: "#/components/schemas/ModelDetail" + ModelDetail: + description: Contains information about the AI model involved in a finding. + type: object + properties: + ModelId: + $ref: "#/components/schemas/ModelDetailModelIdString" + description: The identifier of the AI model. + ModelDetailModelIdString: + type: string + minLength: 1 + maxLength: 2048 Service: description: Contains additional information about the generated finding. type: object @@ -5282,6 +5543,15 @@ components: ThreatFilePath: $ref: "#/components/schemas/String" description: The suspicious file path for which the threat intelligence details were found. + FileOperation: + $ref: "#/components/schemas/String" + description: Represents the type of file operation that triggered the finding, such as Write, Delete, Rename, Link, or Symlink. + FilePath: + $ref: "#/components/schemas/String" + description: The path of the sensitive file that was modified. Modification includes write, delete, rename, link, or symlink operations. This field is indexed for filtering. + RelatedFilePaths: + $ref: "#/components/schemas/RelatedFilePathsList" + description: All file paths modified by the same process that triggered the finding, up to a maximum of 25 paths. FlagsList: type: array items: @@ -5290,6 +5560,10 @@ components: type: array items: $ref: "#/components/schemas/String" + RelatedFilePathsList: + type: array + items: + $ref: "#/components/schemas/String" Detection: description: Contains information about the detected behavior. type: object @@ -6096,6 +6370,11 @@ components: - CRYPTOMINING_DOMAIN - CRYPTOMINING_PROCESS - MALICIOUS_FILE + - VULNERABILITY + - MALICIOUS_PACKAGE + - MISCONFIGURATION + - REACHABILITY + - SENSITIVE_DATA IndicatorValues: type: array items: @@ -6420,6 +6699,149 @@ components: - DELETED minLength: 1 maxLength: 300 + GetInvestigationResponse: + type: object + properties: + Investigation: + $ref: "#/components/schemas/Investigation" + description: The details and results of the requested investigation. + required: + - Investigation + Investigation: + description: Contains the details and results of a GuardDuty investigation. + type: object + properties: + InvestigationId: + $ref: "#/components/schemas/InvestigationId" + description: The unique identifier of the investigation. + Status: + $ref: "#/components/schemas/InvestigationStatus" + description: The current status of the investigation. Possible values are RUNNING, COMPLETED, and FAILED. + TriggerPrompt: + $ref: "#/components/schemas/TriggerPrompt" + description: The natural-language prompt that initiated this investigation. + TriggeredBy: + $ref: "#/components/schemas/TriggeredBy" + description: The account that initiated the investigation. + Metadata: + $ref: "#/components/schemas/InvestigationMetadata" + description: Metadata about the product and version that produced the investigation. + Cloud: + $ref: "#/components/schemas/CloudDetails" + description: Details about the cloud environment in which the investigation was performed, including the provider, region, and account. + RiskLevel: + $ref: "#/components/schemas/RiskLevel" + description: The assessed risk level of the investigated threat. Possible values are Info, Low, Medium, High, and Critical. + Risk: + $ref: "#/components/schemas/RiskDetails" + description: A human-readable description of the assessed risk. + Confidence: + $ref: "#/components/schemas/Confidence" + description: The confidence level of the investigation's assessment. Possible values are Unknown, Low, Medium, and High. + Summary: + $ref: "#/components/schemas/String" + description: A structured summary of the investigation findings, including affected resources, threat assessment, and recommended remediation steps. + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp at which the investigation started. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp at which the investigation completed. + Error: + $ref: "#/components/schemas/InvestigationErrorDetails" + description: Details about the error if the investigation status is FAILED. + required: + - InvestigationId + - Status + - TriggerPrompt + - TriggeredBy + InvestigationStatus: + type: string + enum: + - RUNNING + - COMPLETED + - FAILED + minLength: 1 + maxLength: 300 + TriggeredBy: + type: string + minLength: 0 + maxLength: 256 + InvestigationMetadata: + description: Contains metadata about the product and version that produced an investigation. + type: object + properties: + Version: + $ref: "#/components/schemas/String" + description: The version of the investigation engine that produced the results. + Product: + $ref: "#/components/schemas/Product" + description: Information about the product that produced the investigation. + required: + - Version + - Product + Product: + description: Contains information about the product that produced an investigation. + type: object + properties: + Name: + $ref: "#/components/schemas/String" + description: The name of the product. + Feature: + $ref: "#/components/schemas/String" + description: The specific feature within the product that produced the investigation. + required: + - Name + CloudDetails: + description: Contains details about the cloud environment associated with an investigation. + type: object + properties: + Provider: + $ref: "#/components/schemas/CloudProvider" + description: The cloud provider. Currently, only AWS is supported. + Region: + $ref: "#/components/schemas/String" + description: The Amazon Web Services Region in which the investigated resource resides. + Account: + $ref: "#/components/schemas/String" + description: The Amazon Web Services account ID of the investigated resource. + required: + - Provider + - Region + - Account + CloudProvider: + type: string + enum: + - AWS + minLength: 1 + maxLength: 50 + RiskLevel: + type: string + enum: + - Info + - Low + - Medium + - High + - Critical + minLength: 1 + maxLength: 300 + RiskDetails: + type: string + minLength: 0 + maxLength: 1024 + Confidence: + type: string + enum: + - Unknown + - Low + - Medium + - High + minLength: 1 + maxLength: 50 + InvestigationErrorDetails: + type: string + minLength: 0 + maxLength: 2048 GetInvitationsCountResponse: type: object properties: @@ -6539,6 +6961,7 @@ components: - EC2_RECOVERY_POINT - S3_RECOVERY_POINT - S3_BUCKET + - S3_POINT_IN_TIME_RECOVERY NonNegativeInteger: type: integer minimum: 0 @@ -6633,6 +7056,9 @@ components: BackupVaultName: $ref: "#/components/schemas/NonEmptyString" description: The name of the Amazon Web Services Backup vault that contains the recovery point for the scanned. + ContinuousScanDetails: + $ref: "#/components/schemas/ScanConfigurationContinuousScanDetails" + description: The time range within the continuous backup in Amazon Web Services Backup that was scanned for a point-in-time recovery resource. GetMalwareScanResultDetails: description: Contains information about the results of the malware scan. type: object @@ -7026,6 +7452,7 @@ components: - EKS_RUNTIME_MONITORING - EC2_RUNTIME_MONITORING - FARGATE_RUNTIME_MONITORING + - AI_PROTECTION GetThreatEntitySetResponse: type: object properties: @@ -7223,6 +7650,7 @@ components: - FARGATE_RUNTIME_MONITORING - RDS_DBI_PROTECTION_PROVISIONED - RDS_DBI_PROTECTION_SERVERLESS + - AI_PROTECTION GetUsageStatisticsResponse: type: object properties: @@ -7593,6 +8021,79 @@ components: type: array items: $ref: "#/components/schemas/ListIPSetsRowDisplay" + InvestigationSortCriteria: + description: Contains information about the criteria used for sorting investigations. + type: object + properties: + AttributeName: + $ref: "#/components/schemas/InvestigationSortField" + description: The attribute by which to sort investigations. + OrderBy: + $ref: "#/components/schemas/OrderBy" + description: The order in which the sorted results are to be displayed. + InvestigationSortField: + type: string + enum: + - START_TIME + - END_TIME + - STATUS + - RISK_LEVEL + - CONFIDENCE + NextToken: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[a-zA-Z0-9+/=_\\-]+" + ListInvestigationsResponse: + type: object + properties: + Investigations: + $ref: "#/components/schemas/InvestigationSummaries" + description: A list of investigation summaries associated with the specified detector. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination parameter to be used on the next list operation to retrieve more items. + required: + - Investigations + InvestigationSummaries: + type: array + items: + $ref: "#/components/schemas/InvestigationSummary" + InvestigationSummary: + description: Contains summary information about a GuardDuty investigation. + type: object + properties: + InvestigationId: + $ref: "#/components/schemas/InvestigationId" + description: The unique identifier of the investigation. + Status: + $ref: "#/components/schemas/InvestigationStatus" + description: The current status of the investigation. + TriggerPrompt: + $ref: "#/components/schemas/TriggerPrompt" + description: The natural-language prompt that initiated this investigation. + RiskLevel: + $ref: "#/components/schemas/RiskLevel" + description: The assessed risk level of the investigated threat. + Confidence: + $ref: "#/components/schemas/Confidence" + description: The confidence level of the investigation's assessment. + Title: + $ref: "#/components/schemas/InvestigationTitle" + description: A short title summarizing the investigation. + AccountId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services account ID associated with the investigation. + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp at which the investigation started. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp at which the investigation completed. + InvestigationTitle: + type: string + minLength: 0 + maxLength: 1024 ListInvitationsResponse: type: object properties: @@ -7877,8 +8378,23 @@ components: BackupVaultName: $ref: "#/components/schemas/String" description: The name of the Amazon Web Services Backup vault that contains the name of the recovery point to be scanned. + ContinuousScanDetails: + $ref: "#/components/schemas/ContinuousScanDetails" + description: Contains information about the time range within the continuous backup in Amazon Web Services Backup to scan. required: - BackupVaultName + ContinuousScanDetails: + description: Contains information about the time range within the continuous backup in Amazon Web Services Backup to scan for a point-in-time recovery resource. + type: object + properties: + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp representing the start of the time range to scan. Reserved for internal use. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp representing the end of the time range to scan. + required: + - EndTime StartMalwareScanResponse: type: object properties: @@ -8526,6 +9042,56 @@ components: - $ref: "#/components/x-stackQL-resources/ip_sets/methods/update_ip_set" delete: - $ref: "#/components/x-stackQL-resources/ip_sets/methods/delete_ip_set" + investigations: + id: aws.guardduty.investigations + name: investigations + title: investigations + methods: + create_investigation: + operation: + $ref: "#/paths/~1detector~1{detector_id}~1investigation/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_investigation: + operation: + $ref: "#/paths/~1detector~1{detector_id}~1investigation~1{investigation_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Investigation + list_investigations: + operation: + $ref: "#/paths/~1detector~1{detector_id}~1investigation~1list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Investigations + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/investigations/methods/get_investigation" + - $ref: "#/components/x-stackQL-resources/investigations/methods/list_investigations" + insert: + - $ref: "#/components/x-stackQL-resources/investigations/methods/create_investigation" + update: [] + delete: [] malware_protection_plans: id: aws.guardduty.malware_protection_plans name: malware_protection_plans diff --git a/providers/src/aws/v00.00.00000/services/healthlake.yaml b/providers/src/aws/v00.00.00000/services/healthlake.yaml index 3456834b..3915ebab 100644 --- a/providers/src/aws/v00.00.00000/services/healthlake.yaml +++ b/providers/src/aws/v00.00.00000/services/healthlake.yaml @@ -18,6 +18,59 @@ servers: description: AWS region description: Regional endpoint for healthlake paths: + /CreateDataTransformationProfile: + post: + operationId: CreateDataTransformationProfile + description: Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.CreateDataTransformationProfile + default: HealthLake.CreateDataTransformationProfile + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)). + Source: + $ref: "#/components/schemas/CreateDataTransformationProfileSource" + description: The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3. + KmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest. + ProfileDescription: + $ref: "#/components/schemas/ProfileDescription" + description: A human-readable description of the profile's purpose. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: A name for the data transformation profile. + Tags: + $ref: "#/components/schemas/TagMap" + description: The tags to associate with the profile at creation time. + ClientToken: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error. + required: + - SourceFormat + - Source + - ProfileName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDataTransformationProfileResponse" /CreateFHIRDatastore: post: operationId: CreateFHIRDatastore @@ -60,6 +113,15 @@ paths: IdentityProviderConfiguration: $ref: "#/components/schemas/IdentityProviderConfiguration" description: The identity provider configuration to use for the data store. + AnalyticsConfiguration: + $ref: "#/components/schemas/AnalyticsConfiguration" + description: The analytics configuration for the data store. + NlpConfiguration: + $ref: "#/components/schemas/NlpConfiguration" + description: The natural language processing (NLP) configuration for the data store. + ProfileConfiguration: + $ref: "#/components/schemas/ProfileConfiguration" + description: The profile configuration for the data store. required: - DatastoreTypeVersion responses: @@ -69,6 +131,39 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateFHIRDatastoreResponse" + /DeleteDataTransformationProfile: + post: + operationId: DeleteDataTransformationProfile + description: Deletes a data transformation profile and all its versions, including the DRAFT and all published versions. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.DeleteDataTransformationProfile + default: HealthLake.DeleteDataTransformationProfile + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile to delete. + required: + - ProfileId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDataTransformationProfileResponse" /DeleteFHIRDatastore: post: operationId: DeleteFHIRDatastore @@ -102,6 +197,39 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteFHIRDatastoreResponse" + /DescribeDataTransformationJob: + post: + operationId: DescribeDataTransformationJob + description: Describes a data transformation job, including its current status, configuration, and progress information. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.DescribeDataTransformationJob + default: HealthLake.DescribeDataTransformationJob + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + JobId: + $ref: "#/components/schemas/DataTransformationJobId" + description: The unique identifier of the data transformation job to describe. + required: + - JobId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeDataTransformationJobResponse" /DescribeFHIRDatastore: post: operationId: DescribeFHIRDatastore @@ -209,6 +337,166 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeFHIRImportJobResponse" + /GetDataTransformationProfile: + post: + operationId: GetDataTransformationProfile + description: Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.GetDataTransformationProfile + default: HealthLake.GetDataTransformationProfile + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile to retrieve. + ProfileVersion: + $ref: "#/components/schemas/ProfileVersion" + description: The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version. + required: + - ProfileId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDataTransformationProfileResponse" + /ListDataTransformationJobs: + post: + operationId: ListDataTransformationJobs + description: Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.ListDataTransformationJobs + default: HealthLake.ListDataTransformationJobs + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token from a previous response. Pass this value to retrieve the next page of results. + JobStatus: + $ref: "#/components/schemas/TransformationJobStatus" + description: Filters the results to include only jobs with the specified status. + JobName: + $ref: "#/components/schemas/DataTransformationJobName" + description: Filters the results to include only jobs with the specified name. + SubmittedAfter: + $ref: "#/components/schemas/DateTime" + description: Filters the results to include only jobs submitted at or after this timestamp. + SubmittedBefore: + $ref: "#/components/schemas/DateTime" + description: Filters the results to include only jobs submitted at or before this timestamp. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDataTransformationJobsResponse" + /ListDataTransformationProfileVersions: + post: + operationId: ListDataTransformationProfileVersions + description: Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.ListDataTransformationProfileVersions + default: HealthLake.ListDataTransformationProfileVersions + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile whose versions to list. + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token from a previous response. Pass this value to retrieve the next page of results. + required: + - ProfileId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDataTransformationProfileVersionsResponse" + /ListDataTransformationProfiles: + post: + operationId: ListDataTransformationProfiles + description: Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.ListDataTransformationProfiles + default: HealthLake.ListDataTransformationProfiles + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: Filters the results by source data format. + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token from a previous response. Pass this value to retrieve the next page of results. + required: + - SourceFormat + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDataTransformationProfilesResponse" /ListFHIRDatastores: post: operationId: ListFHIRDatastores @@ -283,10 +571,10 @@ paths: $ref: "#/components/schemas/JobStatus" description: Limits the response to export jobs with the specified job status. SubmittedBefore: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Limits the response to FHIR export jobs submitted before a user- specified date. SubmittedAfter: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Limits the response to FHIR export jobs submitted after a user-specified date. required: - DatastoreId @@ -334,10 +622,10 @@ paths: $ref: "#/components/schemas/JobStatus" description: Limits the response to the import job with the specified job status. SubmittedBefore: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Limits the response to FHIR import jobs submitted before a user- specified date. SubmittedAfter: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Limits the response to FHIR import jobs submitted after a user-specified date. required: - DatastoreId @@ -381,6 +669,107 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" + /PublishDataTransformationProfile: + post: + operationId: PublishDataTransformationProfile + description: Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.PublishDataTransformationProfile + default: HealthLake.PublishDataTransformationProfile + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile to publish. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format of the profile. + FromExistingVersion: + $ref: "#/components/schemas/ProfileVersion" + description: The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version. + ChangeDescription: + $ref: "#/components/schemas/ChangeDescription" + description: A description of what changed or why this version is being published. + required: + - ProfileId + - SourceFormat + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PublishDataTransformationProfileResponse" + /StartDataTransformationJob: + post: + operationId: StartDataTransformationJob + description: Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.StartDataTransformationJob + default: HealthLake.StartDataTransformationJob + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + InputDataConfig: + $ref: "#/components/schemas/TransformationInputDataConfig" + description: The Amazon S3 location and format of the source files to transform. + OutputDataConfig: + $ref: "#/components/schemas/TransformationOutputDataConfig" + description: The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration. + DataAccessRoleArn: + $ref: "#/components/schemas/DataTransformationIamRoleArn" + description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations. + ClientToken: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error. + JobName: + $ref: "#/components/schemas/DataTransformationJobName" + description: A descriptive name for the data transformation job. + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the data transformation profile to use for conversion. + DriftDetectionEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files. + ProvenanceEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false. + required: + - InputDataConfig + - OutputDataConfig + - DataAccessRoleArn + - ClientToken + - ProfileId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartDataTransformationJobResponse" /StartFHIRExportJob: post: operationId: StartFHIRExportJob @@ -469,6 +858,15 @@ paths: ValidationLevel: $ref: "#/components/schemas/ValidationLevel" description: The validation level of the import job. + ProfileId: + $ref: "#/components/schemas/BoundedLengthString" + InputFormat: + $ref: "#/components/schemas/BoundedLengthString" + DriftDetectionEnabled: + $ref: "#/components/schemas/HealthLakeBoolean" + ProvenanceEnabled: + $ref: "#/components/schemas/DefaultEnabledBoolean" + description: Specifies whether to enable provenance for the import job. required: - InputDataConfig - JobOutputDataConfig @@ -554,6 +952,138 @@ paths: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" + /UpdateDataTransformationProfile: + post: + operationId: UpdateDataTransformationProfile + description: Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.UpdateDataTransformationProfile + default: HealthLake.UpdateDataTransformationProfile + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile to update. + ProfileMapping: + $ref: "#/components/schemas/ProfileMapping" + description: The new profile content for the DRAFT version. This is a full replacement of all profile files. + ChangeDescription: + $ref: "#/components/schemas/ChangeDescription" + description: A description of what changed in this update. + required: + - ProfileId + - ProfileMapping + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDataTransformationProfileResponse" + /UpdateFHIRDatastore: + post: + operationId: UpdateFHIRDatastore + description: Update the properties of a FHIR-enabled data store. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.UpdateFHIRDatastore + default: HealthLake.UpdateFHIRDatastore + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + DatastoreId: + $ref: "#/components/schemas/DatastoreId" + description: The data store identifier. + DatastoreName: + $ref: "#/components/schemas/DatastoreName" + description: The data store name. + AnalyticsConfiguration: + $ref: "#/components/schemas/AnalyticsConfiguration" + description: The analytics configuration for the data store. + NlpConfiguration: + $ref: "#/components/schemas/NlpConfiguration" + description: The natural language processing (NLP) configuration for the data store. + ProfileConfiguration: + $ref: "#/components/schemas/ProfileConfiguration" + description: The profile configuration for the data store. + IdentityProviderConfiguration: + $ref: "#/components/schemas/IdentityProviderConfiguration" + description: The identity provider configuration for the data store. + required: + - DatastoreId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateFHIRDatastoreResponse" + /UpdateProfileWithAgent: + post: + operationId: UpdateProfileWithAgent + description: Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - HealthLake.UpdateProfileWithAgent + default: HealthLake.UpdateProfileWithAgent + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile to update via the agent. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format for the transformation. + InputMessage: + $ref: "#/components/schemas/AgentInputMessage" + description: The message to send to the agent. + ConversationId: + $ref: "#/components/schemas/ConversationIdString" + description: The conversation identifier for multi-turn interactions. Omit to start a new conversation. + required: + - ProfileId + - SourceFormat + - InputMessage + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateProfileWithAgentResponse" components: parameters: X-Amz-Content-Sha256: @@ -599,12 +1129,151 @@ components: schema: type: string schemas: + SourceFormat: + type: string + enum: + - CCDA + - CSV + CreateDataTransformationProfileSource: + description: "The source for initial content when creating a data transformation profile. Specify exactly one variant: a built-in starter profile, an existing profile version to clone, raw profile content, or a sample data file." + type: object + properties: + StarterProfile: + $ref: "#/components/schemas/StarterProfileSource" + description: Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA). + ExistingVersionedProfileId: + $ref: "#/components/schemas/ExistingVersionedProfileSource" + description: Creates the profile by cloning an existing profile at a specific version. + ProfileMapping: + $ref: "#/components/schemas/ProfileMappingSource" + description: Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows. + SampleData: + $ref: "#/components/schemas/SampleDataSource" + description: Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV). + StarterProfileSource: + description: Identifies a built-in starter profile to use as the source when creating a data transformation profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA). + type: object + properties: + StarterProfileName: + $ref: "#/components/schemas/String" + description: The name of the built-in starter profile. + required: + - StarterProfileName + String: + type: string + ExistingVersionedProfileSource: + description: Identifies an existing data transformation profile and version to clone when creating a new profile. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/String" + description: The unique identifier of the existing profile to clone from. + Version: + $ref: "#/components/schemas/Integer" + description: The version number of the existing profile to clone from. + required: + - ProfileId + - Version + Integer: + type: integer + ProfileMappingSource: + description: Contains raw content to use as the source when creating a data transformation profile directly from a mapping. + type: object + properties: + ProfileMapping: + type: object + properties: {} + description: The content as a map of file paths to profile strings. + required: + - ProfileMapping + SampleDataSource: + description: Identifies a sample data file in Amazon S3 to use as the source when creating a data transformation profile. Valid only when the source format is Comma-separated values (CSV). + type: object + properties: + S3Uri: + $ref: "#/components/schemas/SampleDataS3Uri" + description: The Amazon S3 URI of the sample data file. + required: + - S3Uri + SampleDataS3Uri: + type: string + minLength: 1 + maxLength: 1024 + pattern: s3://[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9](/.*)? + KmsKeyId: + type: string + minLength: 1 + maxLength: 2048 + ProfileDescription: + type: string + minLength: 0 + maxLength: 1000 + ProfileNameString: + type: string + minLength: 1 + maxLength: 256 + TagMap: + description: A map of tag keys to tag values associated with the resource. + type: object + properties: {} + ClientToken: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9-]+" + CreateDataTransformationProfileResponse: + description: The response from the CreateDataTransformationProfile operation. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the created profile. + Version: + $ref: "#/components/schemas/ProfileVersion" + description: The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format of the profile. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format. Always FHIR_R4. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the created profile. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the profile was last updated. + required: + - ProfileId + - Version + - SourceFormat + - TargetFormat + - ProfileName + - LastUpdatedAt + ProfileIdString: + type: string + minLength: 32 + maxLength: 32 + pattern: "[a-f0-9]{32}" + ProfileVersion: + type: integer + minimum: 0 + maximum: 99 + TargetFormat: + type: string + enum: + - FHIR_R4 + DateTime: + type: string + format: date-time DatastoreName: + description: The name of a data store. type: string minLength: 1 maxLength: 256 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*) FHIRVersion: + description: The FHIR version supported by the data store. type: string enum: - R4 @@ -635,6 +1304,7 @@ components: - CUSTOMER_MANAGED_KMS_KEY - AWS_OWNED_KMS_KEY EncryptionKeyID: + description: The identifier of an encryption key. type: string minLength: 1 maxLength: 400 @@ -649,14 +1319,16 @@ components: required: - PreloadDataType PreloadDataType: + description: The type of preloaded data. type: string enum: - SYNTHEA ClientTokenString: + description: A client-provided idempotency token. type: string minLength: 1 maxLength: 64 - pattern: ^[a-zA-Z0-9-]+$ + pattern: "[a-zA-Z0-9-]+" TagList: type: array items: @@ -678,12 +1350,12 @@ components: type: string minLength: 1 maxLength: 128 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) TagValue: type: string minLength: 0 maxLength: 256 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) IdentityProviderConfiguration: description: The identity provider configuration selected when the data store was created. type: object @@ -692,7 +1364,7 @@ components: $ref: "#/components/schemas/AuthorizationStrategy" description: The authorization strategy selected when the HealthLake data store is created. HealthLake provides support for both SMART on FHIR V1 and V2 as described below. SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions. SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create, read, update, delete, and search permissions. AWS_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR. FineGrainedAuthorizationEnabled: - $ref: "#/components/schemas/Boolean" + $ref: "#/components/schemas/HealthLakeBoolean" description: The parameter to enable SMART on FHIR fine-grained authorization for the data store. Metadata: $ref: "#/components/schemas/ConfigurationMetadata" @@ -708,7 +1380,8 @@ components: - SMART_ON_FHIR_V1 - SMART_ON_FHIR - AWS_AUTH - Boolean: + HealthLakeBoolean: + description: A boolean value. type: boolean ConfigurationMetadata: type: string @@ -717,6 +1390,53 @@ components: minLength: 49 maxLength: 256 pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_\.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))? + AnalyticsConfiguration: + description: The analytics configuration for a data store. + type: object + properties: + Status: + $ref: "#/components/schemas/AnalyticsStatus" + description: The status of the analytics configuration. + AnalyticsStatus: + type: string + enum: + - ENABLED + - ENABLING + - DISABLED + - DISABLING + - PAUSING + - PAUSED + NlpConfiguration: + description: The natural language processing (NLP) configuration for a data store. + type: object + properties: + Status: + $ref: "#/components/schemas/NlpStatus" + description: The status of the NLP configuration. + NlpStatus: + type: string + enum: + - ENABLED + - ENABLING + - DISABLED + - DISABLING + ProfileConfiguration: + description: The profile configuration for a data store. + type: object + properties: + DefaultProfiles: + $ref: "#/components/schemas/DefaultProfiles" + description: The list of default profiles for the data store. + DefaultProfiles: + type: array + items: + $ref: "#/components/schemas/HealthLakeString" + HealthLakeString: + description: A general-purpose string value. + type: string + minLength: 0 + maxLength: 10000 + pattern: "[\\P{M}\\p{M}]{0,10000}" CreateFHIRDatastoreResponse: type: object properties: @@ -738,14 +1458,17 @@ components: - DatastoreStatus - DatastoreEndpoint DatastoreId: + description: The identifier of a data store. type: string minLength: 1 maxLength: 32 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*) DatastoreArn: + description: The ARN of a data store. type: string - pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+? + pattern: arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+? DatastoreStatus: + description: The status of a data store. type: string enum: - CREATING @@ -753,11 +1476,30 @@ components: - DELETING - DELETED - CREATE_FAILED + - UPDATING + - UPDATE_FAILED BoundedLengthString: + description: A bounded-length string value. type: string minLength: 1 maxLength: 5000 pattern: "[\\P{M}\\p{M}]{1,5000}" + DeleteDataTransformationProfileResponse: + description: The response from the DeleteDataTransformationProfile operation. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the deleted profile. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the deleted profile. + DeletionTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the profile was deleted. + required: + - ProfileId + - DeletionTime DeleteFHIRDatastoreResponse: type: object properties: @@ -774,10 +1516,168 @@ components: $ref: "#/components/schemas/BoundedLengthString" description: The AWS endpoint of the data store to be deleted. required: - - DatastoreId - - DatastoreArn - - DatastoreStatus - - DatastoreEndpoint + - DatastoreId + - DatastoreArn + - DatastoreStatus + - DatastoreEndpoint + DataTransformationJobId: + type: string + minLength: 1 + maxLength: 32 + pattern: "[a-zA-Z0-9-]+" + DescribeDataTransformationJobResponse: + description: The response from the DescribeDataTransformationJob operation. + type: object + properties: + TransformationJobProperties: + $ref: "#/components/schemas/TransformationJobProperties" + description: The properties of the data transformation job, including status, configuration, and progress information. + required: + - TransformationJobProperties + TransformationJobProperties: + description: Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling DescribeDataTransformationJob. + type: object + properties: + JobId: + $ref: "#/components/schemas/DataTransformationJobId" + description: The unique identifier of the data transformation job. + JobStatus: + $ref: "#/components/schemas/TransformationJobStatus" + description: The current status of the data transformation job. + InputDataConfig: + $ref: "#/components/schemas/TransformationInputDataConfig" + description: The Amazon S3 location and format of the source files for this job. + OutputDataConfig: + $ref: "#/components/schemas/TransformationOutputDataConfig" + description: The Amazon S3 location and encryption configuration for the converted output. + DataAccessRoleArn: + $ref: "#/components/schemas/DataTransformationIamRoleArn" + description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files. + SubmitTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the job was submitted. + JobName: + $ref: "#/components/schemas/DataTransformationJobName" + description: The name of the data transformation job. + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the data transformation profile used for this job. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the data transformation profile used for this job. + ProfileVersion: + $ref: "#/components/schemas/Integer" + description: The version number of the data transformation profile used for this job. + EndTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the job completed or failed. + DriftDetectionEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files. + ProvenanceEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. + Message: + $ref: "#/components/schemas/BoundedString" + description: An informational message about the job, such as an error description if the job failed. + JobProgressReport: + $ref: "#/components/schemas/TransformationJobProgressReport" + description: The progress report for the data transformation job, including counts of files processed and resources generated. + required: + - JobId + - JobStatus + - InputDataConfig + - OutputDataConfig + - DataAccessRoleArn + - SubmitTime + TransformationJobStatus: + type: string + enum: + - SUBMITTED + - QUEUED + - IN_PROGRESS + - COMPLETED + - COMPLETED_WITH_ERRORS + - FAILED + TransformationInputDataConfig: + description: The Amazon S3 location and source format configuration for input data in a transformation job. + type: object + properties: + S3Uri: + $ref: "#/components/schemas/DataTransformationS3Uri" + description: The Amazon S3 URI of the input data to transform. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The format of the source data files (C-CDA or CSV). + required: + - S3Uri + DataTransformationS3Uri: + type: string + minLength: 8 + maxLength: 2048 + pattern: s3://[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9](/.+)? + TransformationOutputDataConfig: + description: The Amazon S3 output location and encryption configuration for a transformation job. + type: object + properties: + S3Configuration: + $ref: "#/components/schemas/DataTransformationS3Configuration" + description: The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration. + required: + - S3Configuration + DataTransformationS3Configuration: + description: The Amazon S3 output configuration for a data transformation job, including the output location and encryption settings. + type: object + properties: + S3Uri: + $ref: "#/components/schemas/DataTransformationS3Uri" + description: The Amazon S3 URI where AWS HealthLake writes the converted output files. + KmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3. + required: + - S3Uri + - KmsKeyId + DataTransformationIamRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ + DataTransformationJobName: + type: string + minLength: 1 + maxLength: 64 + pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*" + Boolean: + type: boolean + BoundedString: + type: string + minLength: 1 + maxLength: 2048 + TransformationJobProgressReport: + description: Contains progress metrics for a data transformation job, including counts of files scanned, converted, and failed. + type: object + properties: + TotalFilesScanned: + $ref: "#/components/schemas/Long" + description: The total number of source files scanned by the job. + TotalFilesConverted: + $ref: "#/components/schemas/Long" + description: The total number of source files successfully converted. + TotalFilesFailed: + $ref: "#/components/schemas/Long" + description: The total number of source files that failed conversion. + TotalResourcesGenerated: + $ref: "#/components/schemas/Long" + description: The total number of FHIR R4 resources generated across all converted files. + required: + - TotalFilesScanned + - TotalFilesConverted + - TotalFilesFailed + - TotalResourcesGenerated + Long: + type: integer + format: int64 DescribeFHIRDatastoreResponse: type: object properties: @@ -803,13 +1703,13 @@ components: $ref: "#/components/schemas/DatastoreStatus" description: The data store status. CreatedAt: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: The time the data store was created. DatastoreTypeVersion: $ref: "#/components/schemas/FHIRVersion" description: The FHIR release version supported by the data store. Current support is for version R4. DatastoreEndpoint: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/HealthLakeString" description: The AWS endpoint for the data store. SseConfiguration: $ref: "#/components/schemas/SseConfiguration" @@ -823,19 +1723,25 @@ components: ErrorCause: $ref: "#/components/schemas/ErrorCause" description: The error cause for the current data store operation. + NlpConfiguration: + $ref: "#/components/schemas/NlpConfiguration" + description: The natural language processing (NLP) configuration for the data store. + AnalyticsConfiguration: + $ref: "#/components/schemas/AnalyticsConfiguration" + description: The analytics configuration for the data store. + ProfileConfiguration: + $ref: "#/components/schemas/ProfileConfiguration" + description: The profile configuration for the data store. required: - DatastoreId - DatastoreArn - DatastoreStatus - DatastoreTypeVersion - DatastoreEndpoint - Timestamp: + HealthLakeTimestamp: + description: A timestamp value. type: string format: date-time - String: - type: string - maxLength: 10000 - pattern: "[\\P{M}\\p{M}]{0,10000}" ErrorCause: description: The error information for CreateFHIRDatastore and DeleteFHIRDatastore actions. type: object @@ -856,10 +1762,11 @@ components: - RETRYABLE_ERROR - NON_RETRYABLE_ERROR JobId: + description: The unique identifier of a job. type: string minLength: 1 maxLength: 32 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*) DescribeFHIRExportJobResponse: type: object properties: @@ -882,10 +1789,10 @@ components: $ref: "#/components/schemas/JobStatus" description: The export job status. SubmitTime: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: The time the export job was initiated. EndTime: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: The time the export job completed. DatastoreId: $ref: "#/components/schemas/DatastoreId" @@ -906,11 +1813,13 @@ components: - DatastoreId - OutputDataConfig JobName: + description: The human-readable name of a job. type: string minLength: 1 maxLength: 64 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*) JobStatus: + description: The status of a job. type: string enum: - SUBMITTED @@ -944,19 +1853,23 @@ components: - S3Uri - KmsKeyId S3Uri: + description: The S3 URI for data import or export. type: string + minLength: 0 maxLength: 1024 pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)? IamRoleArn: + description: The IAM role ARN for data access. type: string minLength: 20 maxLength: 2048 pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ Message: + description: A message associated with a job or error. type: string minLength: 1 maxLength: 2048 - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*) DescribeFHIRImportJobResponse: type: object properties: @@ -979,10 +1892,10 @@ components: $ref: "#/components/schemas/JobStatus" description: The import job status. SubmitTime: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: The time the import job was submitted for processing. EndTime: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: The time the import job was completed. DatastoreId: $ref: "#/components/schemas/DatastoreId" @@ -1042,21 +1955,236 @@ components: TotalNumberOfFilesReadWithCustomerError: $ref: "#/components/schemas/GenericLong" description: The number of files that failed to be read from the S3 input bucket due to customer error. + TotalNumberOfScannedNonFhirFiles: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR files scanned from the S3 input bucket. + TotalSizeOfScannedNonFhirFilesInMB: + $ref: "#/components/schemas/GenericDouble" + description: The size (in MB) of non-FHIR files scanned from the S3 input bucket. + TotalNumberOfImportedNonFhirFiles: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR files imported. + TotalNumberOfNonFhirResourcesScanned: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR resources scanned from the S3 input bucket. + TotalNumberOfNonFhirResourcesImported: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR resources imported. + TotalNumberOfNonFhirResourcesWithCustomerError: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR resources that failed due to customer error. + TotalNumberOfNonFhirFilesReadWithCustomerError: + $ref: "#/components/schemas/GenericLong" + description: The number of non-FHIR files that failed to be read from the S3 input bucket due to customer error. Throughput: $ref: "#/components/schemas/GenericDouble" description: The transaction rate the import job is processed at. + TotalFilesConverted: + $ref: "#/components/schemas/GenericLong" + description: Number of CCDA files successfully transformed during the import's transformation phase. Populated only for import jobs that use the two-Step-Function (transformation + ingestion) flow; null for legacy single-SF imports and for pure FHIR imports that skip transformation. + TotalResourcesGenerated: + $ref: "#/components/schemas/GenericLong" + description: Number of FHIR resources produced by the transformation phase. Populated only for import jobs that use the two-Step-Function flow; null for legacy single-SF imports and for pure FHIR imports. GenericLong: + description: A long integer value. type: integer format: int64 GenericDouble: + description: A double-precision floating-point number. type: number format: double ValidationLevel: + description: The level of FHIR validation to apply. type: string enum: - strict - structure-only - minimal + GetDataTransformationProfileResponse: + description: The response from the GetDataTransformationProfile operation. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile. + Version: + $ref: "#/components/schemas/ProfileVersion" + description: The version number of the retrieved profile. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format of the profile. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format of the profile. + ProfileMapping: + type: object + properties: {} + description: The profile content as a map of file paths to content strings. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the profile. + ProfileDescription: + $ref: "#/components/schemas/ProfileDescription" + description: The description of the profile. + ChangeDescription: + $ref: "#/components/schemas/ChangeDescription" + description: A description of what changed in this version. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when this version was last updated. + required: + - ProfileId + - Version + - SourceFormat + - TargetFormat + - ProfileMapping + - LastUpdatedAt + ChangeDescription: + type: string + minLength: 0 + maxLength: 1000 + MaxResults: + type: integer + minimum: 1 + maximum: 100 + DataTransformationNextToken: + type: string + minLength: 1 + maxLength: 2048 + ListDataTransformationJobsResponse: + description: The response from the ListDataTransformationJobs operation. + type: object + properties: + Items: + $ref: "#/components/schemas/TransformationJobSummaryList" + description: The list of data transformation job summaries. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token to use in the next request. If this value is null, there are no more results. + required: + - Items + TransformationJobSummaryList: + type: array + items: + $ref: "#/components/schemas/TransformationJobSummary" + TransformationJobSummary: + description: Contains summary information about a data transformation job. To retrieve full job details, call DescribeDataTransformationJob. + type: object + properties: + JobId: + $ref: "#/components/schemas/DataTransformationJobId" + description: The unique identifier of the job. + JobStatus: + $ref: "#/components/schemas/TransformationJobStatus" + description: The current status of the job. + SubmitTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the job was submitted. + JobName: + $ref: "#/components/schemas/DataTransformationJobName" + description: The name of the job. + EndTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the job completed. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format for this job. + required: + - JobId + - JobStatus + - SubmitTime + ListDataTransformationProfileVersionsResponse: + description: The response from the ListDataTransformationProfileVersions operation. + type: object + properties: + Items: + $ref: "#/components/schemas/DataTransformationProfileVersionSummaryList" + description: The list of data transformation profile version summaries. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token to use in the next request. If this value is null, there are no more results. + required: + - Items + DataTransformationProfileVersionSummaryList: + type: array + items: + $ref: "#/components/schemas/DataTransformationProfileVersionSummary" + DataTransformationProfileVersionSummary: + description: Contains summary information about a specific version of a data transformation profile. To retrieve profile content, call GetDataTransformationProfile. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile. + Version: + $ref: "#/components/schemas/ProfileVersion" + description: The version number. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format that this profile converts from. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format of the profile. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the profile. + ChangeDescription: + $ref: "#/components/schemas/ChangeDescription" + description: A description of what changed in this version. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when this version was last updated. + required: + - ProfileId + - Version + - SourceFormat + - TargetFormat + ListDataTransformationProfilesResponse: + description: The response from the ListDataTransformationProfiles operation. + type: object + properties: + Items: + $ref: "#/components/schemas/DataTransformationProfileSummaryList" + description: The list of data transformation profile summaries. + NextToken: + $ref: "#/components/schemas/DataTransformationNextToken" + description: The pagination token to use in the next request. If this value is null, there are no more results. + required: + - Items + DataTransformationProfileSummaryList: + type: array + items: + $ref: "#/components/schemas/DataTransformationProfileSummary" + DataTransformationProfileSummary: + description: Contains summary information about a data transformation profile. To retrieve profile content, call GetDataTransformationProfile. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the profile. + Version: + $ref: "#/components/schemas/ProfileVersion" + description: The latest version number of the profile. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format that this profile converts from. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format of the profile. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the profile. + ProfileDescription: + $ref: "#/components/schemas/ProfileDescription" + description: A description of the profile's purpose. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the profile was last updated. + required: + - ProfileId + - Version + - SourceFormat + - TargetFormat DatastoreFilter: description: The filters applied to a data store query. type: object @@ -1068,16 +2196,19 @@ components: $ref: "#/components/schemas/DatastoreStatus" description: Filter data store results by status. CreatedBefore: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Filter to set cutoff dates for records. All data stores created before the specified date are included in the results. CreatedAfter: - $ref: "#/components/schemas/Timestamp" + $ref: "#/components/schemas/HealthLakeTimestamp" description: Filter to set cutoff dates for records. All data stores created after the specified date are included in the results. NextToken: + description: An opaque pagination token. type: string + minLength: 0 maxLength: 8192 pattern: \p{ASCII}{0,8192} MaxResultsInteger: + description: The maximum number of results to return per page. type: integer minimum: 1 maximum: 500 @@ -1130,13 +2261,54 @@ components: type: string minLength: 1 maxLength: 1011 - pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:datastore\/fhir\/.{32} + pattern: arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:(datastore\/fhir\/.{32}|dataTransformationProfile\/[a-f0-9]{32}) ListTagsForResourceResponse: type: object properties: Tags: $ref: "#/components/schemas/TagList" description: Returns a list of tags associated with a data store. + PublishDataTransformationProfileResponse: + description: The response from the PublishDataTransformationProfile operation. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the published profile. + Version: + $ref: "#/components/schemas/ProfileVersion" + description: The new version number that was created. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format of the profile. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format of the profile. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the published profile. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the profile was last updated. + required: + - ProfileId + - Version + - SourceFormat + - TargetFormat + - LastUpdatedAt + StartDataTransformationJobResponse: + description: The response from the StartDataTransformationJob operation. + type: object + properties: + JobId: + $ref: "#/components/schemas/DataTransformationJobId" + description: The unique identifier assigned to the data transformation job. + JobStatus: + $ref: "#/components/schemas/TransformationJobStatus" + description: The initial status of the data transformation job. + required: + - JobId + - JobStatus StartFHIRExportJobResponse: type: object properties: @@ -1152,6 +2324,9 @@ components: required: - JobId - JobStatus + DefaultEnabledBoolean: + description: Specifies whether the feature is enabled. Defaults to true when not specified. + type: boolean StartFHIRImportJobResponse: type: object properties: @@ -1175,7 +2350,203 @@ components: $ref: "#/components/schemas/TagKey" UntagResourceResponse: type: object + ProfileMapping: + type: object + properties: {} + UpdateDataTransformationProfileResponse: + description: The response from the UpdateDataTransformationProfile operation. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/ProfileIdString" + description: The unique identifier of the updated profile. + SourceFormat: + $ref: "#/components/schemas/SourceFormat" + description: The source data format of the profile. + TargetFormat: + $ref: "#/components/schemas/TargetFormat" + description: The target output format of the profile. + ProfileName: + $ref: "#/components/schemas/ProfileNameString" + description: The name of the updated profile. + LastUpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the profile was last updated. + required: + - ProfileId + - SourceFormat + - TargetFormat + - LastUpdatedAt + UpdateFHIRDatastoreResponse: + type: object + properties: + DatastoreProperties: + $ref: "#/components/schemas/DatastoreProperties" + description: The data store properties. + required: + - DatastoreProperties + AgentInputMessage: + description: Represents a message sent to the agent during chat-based profile customization. + type: object + properties: + Body: + $ref: "#/components/schemas/AgentMessageString" + description: The text of your message to the agent. + Type: + $ref: "#/components/schemas/AgentInputMessageType" + description: "The type of input message, which determines how the agent processes your request. Valid values: normal: A regular message to the agent. confirmation_response: A response to a confirmation request from the agent." + required: + - Body + - Type + AgentMessageString: + type: string + minLength: 1 + maxLength: 40960 + AgentInputMessageType: + type: string + enum: + - normal + - confirmation_response + ConversationIdString: + type: string + minLength: 1 + maxLength: 36 + UpdateProfileWithAgentResponse: + description: The response from the UpdateProfileWithAgent operation. + type: object + properties: + AgentResponse: + $ref: "#/components/schemas/AgentOutputMessage" + description: The response message from the agent. + ConversationId: + $ref: "#/components/schemas/ConversationIdString" + description: The conversation identifier to use for follow-up messages in this conversation. + required: + - AgentResponse + - ConversationId + AgentOutputMessage: + description: Represents a response message from the agent during chat-based profile customization. + type: object + properties: + Body: + $ref: "#/components/schemas/AgentMessageString" + description: The text of the agent's response. + Type: + $ref: "#/components/schemas/AgentOutputMessageType" + description: The type of output message, which indicates how to interpret the agent's response. + OptionsList: + $ref: "#/components/schemas/DataTransformationChatOptionsList" + description: A list of selectable options presented when the response type is options. + required: + - Body + - Type + AgentOutputMessageType: + type: string + enum: + - INITIAL_GREETING + - normal + - confirmation + - complete + - error + - options + - choices + DataTransformationChatOptionsList: + type: array + items: + $ref: "#/components/schemas/DataTransformationChatOptionString" + DataTransformationChatOptionString: + type: string + minLength: 1 + maxLength: 1024 x-stackQL-resources: + data_transformation_profiles: + id: aws.healthlake.data_transformation_profiles + name: data_transformation_profiles + title: data_transformation_profiles + methods: + create_data_transformation_profile: + operation: + $ref: "#/paths/~1CreateDataTransformationProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_data_transformation_profile: + operation: + $ref: "#/paths/~1DeleteDataTransformationProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_data_transformation_profile: + operation: + $ref: "#/paths/~1GetDataTransformationProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_data_transformation_profiles: + operation: + $ref: "#/paths/~1ListDataTransformationProfiles/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_data_transformation_profile: + operation: + $ref: "#/paths/~1UpdateDataTransformationProfile/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_transformation_profiles/methods/get_data_transformation_profile" + - $ref: "#/components/x-stackQL-resources/data_transformation_profiles/methods/list_data_transformation_profiles" + insert: + - $ref: "#/components/x-stackQL-resources/data_transformation_profiles/methods/create_data_transformation_profile" + update: + - $ref: "#/components/x-stackQL-resources/data_transformation_profiles/methods/update_data_transformation_profile" + delete: + - $ref: "#/components/x-stackQL-resources/data_transformation_profiles/methods/delete_data_transformation_profile" fhir_datastores: id: aws.healthlake.fhir_datastores name: fhir_datastores @@ -1234,15 +2605,76 @@ components: config: requestBodyTranslate: algorithm: naive + update_fhir_datastore: + operation: + $ref: "#/paths/~1UpdateFHIRDatastore/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/fhir_datastores/methods/describe_fhir_datastore" - $ref: "#/components/x-stackQL-resources/fhir_datastores/methods/list_fhir_datastores" insert: - $ref: "#/components/x-stackQL-resources/fhir_datastores/methods/create_fhir_datastore" - update: [] + update: + - $ref: "#/components/x-stackQL-resources/fhir_datastores/methods/update_fhir_datastore" delete: - $ref: "#/components/x-stackQL-resources/fhir_datastores/methods/delete_fhir_datastore" + data_transformation_jobs: + id: aws.healthlake.data_transformation_jobs + name: data_transformation_jobs + title: data_transformation_jobs + methods: + describe_data_transformation_job: + operation: + $ref: "#/paths/~1DescribeDataTransformationJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.TransformationJobProperties + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_data_transformation_jobs: + operation: + $ref: "#/paths/~1ListDataTransformationJobs/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_transformation_jobs/methods/describe_data_transformation_job" + - $ref: "#/components/x-stackQL-resources/data_transformation_jobs/methods/list_data_transformation_jobs" + insert: [] + update: [] + delete: [] fhir_export_jobs: id: aws.healthlake.fhir_export_jobs name: fhir_export_jobs @@ -1321,6 +2753,38 @@ components: insert: [] update: [] delete: [] + data_transformation_profile_versions: + id: aws.healthlake.data_transformation_profile_versions + name: data_transformation_profile_versions + title: data_transformation_profile_versions + methods: + list_data_transformation_profile_versions: + operation: + $ref: "#/paths/~1ListDataTransformationProfileVersions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Items + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_transformation_profile_versions/methods/list_data_transformation_profile_versions" + insert: [] + update: [] + delete: [] tags: id: aws.healthlake.tags name: tags @@ -1373,3 +2837,27 @@ components: - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" delete: [] + profile_with_agents: + id: aws.healthlake.profile_with_agents + name: profile_with_agents + title: profile_with_agents + methods: + update_profile_with_agent: + operation: + $ref: "#/paths/~1UpdateProfileWithAgent/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/profile_with_agents/methods/update_profile_with_agent" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/iam.yaml b/providers/src/aws/v00.00.00000/services/iam.yaml index 5a1d611c..e44f05d7 100644 --- a/providers/src/aws/v00.00.00000/services/iam.yaml +++ b/providers/src/aws/v00.00.00000/services/iam.yaml @@ -50,6 +50,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/AcceptDelegationRequestRequest" + /?Action=AcquireRole&Version=2010-05-08: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_AcquireRole + description: Creates an IAM role from the specified role template. The new role takes its configuration—including its name, path, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—from the role template version that you specify. For more information about roles, see IAM roles in the IAM User Guide. If the template version defines parameters, use the ReplacementValues parameter to supply the values that the service substitutes into the role during creation. + parameters: + - name: TemplateArn + in: query + required: true + description: The Amazon Resource Name (ARN) of the role template to create the role from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + schema: + $ref: "#/components/schemas/arnType" + - name: TemplateMinorVersion + in: query + required: false + description: The minor version of the role template to use. If you do not specify a minor version, the service uses the template's default minor version. + schema: + $ref: "#/components/schemas/integerType" + - name: ReplacementValues + in: query + required: false + description: A map of values to substitute for the parameters that are defined in the role template version. Each key is a parameter name from the template, and each value is a structure that contains the replacement values for that parameter. + schema: + $ref: "#/components/schemas/mapStringReplacementValueEntry" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AcquireRoleOutputDisplay" + post: + operationId: POST_AcquireRole + description: Creates an IAM role from the specified role template. The new role takes its configuration—including its name, path, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—from the role template version that you specify. For more information about roles, see IAM roles in the IAM User Guide. If the template version defines parameters, use the ReplacementValues parameter to supply the values that the service substitutes into the role during creation. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/AcquireRoleOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/AcquireRoleRequest" /?Action=AddClientIDToOpenIDConnectProvider&Version=2010-05-08: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -1075,7 +1129,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreateServiceSpecificCredential - description: Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can create service-specific credentials for Amazon Bedrock, Amazon CloudWatch Logs, CodeCommit and Amazon Keyspaces (for Apache Cassandra). You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about service-specific credentials, see Service-specific credentials for IAM users in the IAM User Guide. + description: "Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide." parameters: - name: UserName in: query @@ -1092,7 +1146,7 @@ paths: - name: CredentialAgeDays in: query required: false - description: The number of days until the service specific credential expires. This field is only valid for Bedrock and CloudWatch Logs API keys and must be a positive integer. When not specified, the credential will not expire. + description: The number of days until the service specific credential expires. This field is only valid for services that support long-term API keys and must be a positive integer. When not specified, the credential will not expire. To see which services support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide. schema: $ref: "#/components/schemas/credentialAgeDays" responses: @@ -1104,7 +1158,7 @@ paths: $ref: "#/components/schemas/CreateServiceSpecificCredentialOutputDisplay" post: operationId: POST_CreateServiceSpecificCredential - description: Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can create service-specific credentials for Amazon Bedrock, Amazon CloudWatch Logs, CodeCommit and Amazon Keyspaces (for Apache Cassandra). You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about service-specific credentials, see Service-specific credentials for IAM users in the IAM User Guide. + description: "Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide." responses: "200": description: Success @@ -2723,6 +2777,42 @@ paths: schema: $ref: "#/components/schemas/GetAccountPasswordPolicyOutputDisplay" parameters: [] + /?Action=GetAccountProperties&Version=2010-05-08: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetAccountProperties + description: Retrieves the account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager. The service returns properties as key-value pairs in Namespace/PropertyName format. Each namespace groups related configuration settings. Use PutAccountProperties to modify these properties. + parameters: [] + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetAccountPropertiesOutputDisplay" + post: + operationId: POST_GetAccountProperties + description: Retrieves the account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager. The service returns properties as key-value pairs in Namespace/PropertyName format. Each namespace groups related configuration settings. Use PutAccountProperties to modify these properties. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetAccountPropertiesOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetAccountPropertiesRequest" /?Action=GetAccountSummary&Version=2010-05-08: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -2807,7 +2897,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_GetContextKeysForPrincipalPolicy - description: "Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy." + description: "Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included." parameters: - name: PolicySourceArn in: query @@ -2830,7 +2920,7 @@ paths: $ref: "#/components/schemas/GetContextKeysForPrincipalPolicyOutputDisplay" post: operationId: POST_GetContextKeysForPrincipalPolicy - description: "Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy." + description: "Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included." responses: "200": description: Success @@ -3518,6 +3608,54 @@ paths: text/xml: schema: $ref: "#/components/schemas/GetRolePolicyRequest" + /?Action=GetRoleTemplateVersion&Version=2010-05-08: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_GetRoleTemplateVersion + description: Retrieves information about a version of the specified role template. Role templates define a reusable configuration—including role name and path patterns, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—that you use to create IAM roles with AcquireRole. If you do not specify a minor version, the service returns the template's default minor version. + parameters: + - name: TemplateArn + in: query + required: true + description: The Amazon Resource Name (ARN) of the role template whose version you want to retrieve. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + schema: + $ref: "#/components/schemas/arnType" + - name: MinorVersion + in: query + required: false + description: The minor version of the role template to retrieve. If you do not specify a minor version, the service returns the template's default minor version. + schema: + $ref: "#/components/schemas/minorVersionType" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetRoleTemplateVersionOutputDisplay" + post: + operationId: POST_GetRoleTemplateVersion + description: Retrieves information about a version of the specified role template. Role templates define a reusable configuration—including role name and path patterns, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—that you use to create IAM roles with AcquireRole. If you do not specify a minor version, the service returns the template's default minor version. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/GetRoleTemplateVersionOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/GetRoleTemplateVersionRequest" /?Action=GetSAMLProvider&Version=2010-05-08: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -5527,7 +5665,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_ListServiceSpecificCredentials - description: Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide. + description: "Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide." parameters: - name: UserName in: query @@ -5568,7 +5706,7 @@ paths: $ref: "#/components/schemas/ListServiceSpecificCredentialsOutputDisplay" post: operationId: POST_ListServiceSpecificCredentials - description: Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide. + description: "Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide." responses: "200": description: Success @@ -5852,6 +5990,48 @@ paths: text/xml: schema: $ref: "#/components/schemas/ListVirtualMFADevicesRequest" + /?Action=PutAccountProperties&Version=2010-05-08: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_PutAccountProperties + description: Sets account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager. Specify properties as key-value pairs in Namespace/PropertyName format. All properties in a single request must belong to the same namespace. Use GetAccountProperties to view the current properties. + parameters: + - name: Properties + in: query + required: false + description: A map of property key-value pairs to set. All keys must belong to the same namespace. Each key uses the format Namespace/PropertyName. The key must contain exactly one / separating the namespace from the property name, and cannot start or end with /. The service validates each value based on the property key's expected type. For example, boolean properties expect true or false. + schema: + $ref: "#/components/schemas/accountPropertiesMapType" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/PutAccountPropertiesOutputDisplay" + post: + operationId: POST_PutAccountProperties + description: Sets account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager. Specify properties as key-value pairs in Namespace/PropertyName format. All properties in a single request must belong to the same namespace. Use GetAccountProperties to view the current properties. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/PutAccountPropertiesOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/PutAccountPropertiesRequest" /?Action=PutGroupPolicy&Version=2010-05-08: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -6449,7 +6629,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_SimulateCustomPolicy - description: Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account. If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. + description: Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account. If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. parameters: - name: PolicyInputList in: query @@ -6463,6 +6643,12 @@ paths: description: "The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF) The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)" schema: $ref: "#/components/schemas/SimulationPolicyListType" + - name: OrderedOrganizationPolicyInputList + in: query + required: false + description: An ordered list of service control policies (SCPs) to include in the simulation. Each element represents one level of an Organizations hierarchy, from the organization root to the account. The simulator evaluates SCPs in the order that you provide, consistent with how Organizations enforces SCPs. The first element must represent the organization root, and the last element must represent the account. Any elements between them represent organizational units (OUs) in descending order. Use this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy. + schema: + $ref: "#/components/schemas/OrganizationPolicyListType" - name: ActionNames in: query required: true @@ -6490,7 +6676,7 @@ paths: - name: CallerArn in: query required: false - description: The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. + description: The ARN of the IAM user, group, or role that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You cannot specify the ARN of an assumed role, federated user, or a service principal. schema: $ref: "#/components/schemas/ResourceNameType" - name: ContextEntries @@ -6526,7 +6712,7 @@ paths: $ref: "#/components/schemas/SimulateCustomPolicyOutputDisplay" post: operationId: POST_SimulateCustomPolicy - description: Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account. If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. + description: Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account. If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. responses: "200": description: Success @@ -6551,7 +6737,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_SimulatePrincipalPolicy - description: "Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide." + description: "Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. For cross-account simulations, EvalDecisionDetails returns the decision for each policy type (identity-based policy, resource-based policy, and permissions boundary). This helps you identify which policy type is responsible for an allow or deny decision when policies span multiple accounts. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide." parameters: - name: PolicySourceArn in: query @@ -6571,6 +6757,12 @@ paths: description: "The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF) The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)" schema: $ref: "#/components/schemas/SimulationPolicyListType" + - name: PolicyExclusionList + in: query + required: false + description: A list of policies to exclude from the simulation. Use this parameter to test what the simulation result would be if a policy were removed, without changing which policies are actually attached to the principal identified by PolicySourceArn. Each entry is a PolicyIdentifier that identifies one or more policies to exclude by policy type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to. Syntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed positions, cause the request to fail with an InvalidInput error. Syntactically valid identifiers that don't match any attached policy are ignored. Resource control policies (RCPs) are not supported in this release; identifiers that target RCPs are also ignored. + schema: + $ref: "#/components/schemas/PolicyExclusionsListType" - name: ActionNames in: query required: true @@ -6598,7 +6790,7 @@ paths: - name: CallerArn in: query required: false - description: The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + description: The ARN of the IAM user, group, or role that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user, group, or role that you specify in PolicySourceArn. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies. You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN of an assumed role, federated user, or a service principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user, group, or role. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. schema: $ref: "#/components/schemas/ResourceNameType" - name: ContextEntries @@ -6634,7 +6826,7 @@ paths: $ref: "#/components/schemas/SimulatePrincipalPolicyOutputDisplay" post: operationId: POST_SimulatePrincipalPolicy - description: "Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide." + description: "Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. For cross-account simulations, EvalDecisionDetails returns the decision for each policy type (identity-based policy, resource-based policy, and permissions boundary). This helps you identify which policy type is responsible for an allow or deny decision when policies span multiple accounts. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide." responses: "200": description: Success @@ -8257,6 +8449,72 @@ components: type: string minLength: 20 maxLength: 2048 + integerType: + type: integer + mapStringReplacementValueEntry: + type: object + properties: {} + RoleDisplay: + type: object + properties: + Path: + type: string + description: The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide. + RoleName: + type: string + description: The friendly name that identifies the role. + RoleId: + type: string + description: The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide. + Arn: + type: string + description: The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide. + CreateDate: + type: string + description: The date and time, in ISO 8601 date-time format, when the role was created. + AssumeRolePolicyDocument: + type: string + description: The policy that grants an entity permission to assume the role. + Description: + type: string + description: A description of the role that you provide. + MaxSessionDuration: + type: integer + description: The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter. + PermissionsBoundary: + type: string + description: The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide. + Tags: + type: string + description: A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. + RoleLastUsed: + type: string + description: Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide. + SourceRoleTemplate: + type: string + description: Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole. + AcquireRoleOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/RoleDisplay" + AcquireRoleRequest: + type: object + properties: + TemplateArn: + $ref: "#/components/schemas/arnType" + description: The Amazon Resource Name (ARN) of the role template to create the role from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + TemplateMinorVersion: + $ref: "#/components/schemas/integerType" + description: The minor version of the role template to use. If you do not specify a minor version, the service uses the template's default minor version. + ReplacementValues: + type: object + properties: {} + description: A map of values to substitute for the parameters that are defined in the role template version. Each key is a parameter name from the template, and each value is a structure that contains the replacement values for that parameter. + required: + - TemplateArn clientIDType: type: string minLength: 1 @@ -8881,42 +9139,6 @@ components: type: integer minimum: 3600 maximum: 43200 - RoleDisplay: - type: object - properties: - Path: - type: string - description: The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide. - RoleName: - type: string - description: The friendly name that identifies the role. - RoleId: - type: string - description: The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide. - Arn: - type: string - description: The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide. - CreateDate: - type: string - description: The date and time, in ISO 8601 date-time format, when the role was created. - AssumeRolePolicyDocument: - type: string - description: The policy that grants an entity permission to assume the role. - Description: - type: string - description: A description of the role that you provide. - MaxSessionDuration: - type: integer - description: The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter. - PermissionsBoundary: - type: string - description: The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide. - Tags: - type: string - description: A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. - RoleLastUsed: - type: string - description: Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide. CreateRoleOutputDisplay: type: object properties: @@ -9090,7 +9312,7 @@ components: description: The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials. CredentialAgeDays: $ref: "#/components/schemas/credentialAgeDays" - description: The number of days until the service specific credential expires. This field is only valid for Bedrock and CloudWatch Logs API keys and must be a positive integer. When not specified, the credential will not expire. + description: The number of days until the service specific credential expires. This field is only valid for services that support long-term API keys and must be a positive integer. When not specified, the credential will not expire. To see which services support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide. required: - UserName - ServiceName @@ -9814,6 +10036,21 @@ components: type: array items: $ref: "#/components/schemas/PasswordPolicyDisplay" + GetAccountPropertiesResponseDisplay: + type: object + properties: + Properties: + type: string + description: A map of account property key-value pairs. Keys are in the format Namespace/PropertyName. + GetAccountPropertiesOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/GetAccountPropertiesResponseDisplay" + GetAccountPropertiesRequest: + type: object GetAccountSummaryResponseDisplay: type: object properties: @@ -10323,6 +10560,98 @@ components: required: - RoleName - PolicyName + minorVersionType: + type: integer + RoleTemplateVersionDisplay: + type: object + properties: + TemplateArn: + type: string + description: The Amazon Resource Name (ARN) that identifies the role template. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + TemplateName: + type: string + description: The friendly name that identifies the role template. + TemplateVersionId: + type: string + description: The identifier of the role template version. + Description: + type: string + description: The description of the role template. + MajorVersion: + type: integer + description: The major version number of the role template. + DefaultMinorVersion: + type: integer + description: The minor version that the service uses by default when you create a role from this template without specifying a minor version. + ManagedByType: + type: string + description: Indicates that the role template is managed by an Amazon Web Services service. + ManagedByValue: + type: string + description: The identifier of the Amazon Web Services service that manages the role template. + Enabled: + type: boolean + description: Specifies whether the role template is enabled. When a template is disabled, you cannot create roles from it. + MinorVersion: + type: integer + description: The minor version number of this role template version. + RoleNamePattern: + type: string + description: The pattern that is used to generate the name of a role that is created from this template. The pattern can include @{parameter} placeholders that are replaced with the values you supply in the ReplacementValues parameter of AcquireRole. + RolePathPattern: + type: string + description: The pattern that is used to generate the path of a role that is created from this template. + RoleDescriptionPattern: + type: string + description: The pattern that is used to generate the description of a role that is created from this template. + AssumeRolePolicyDocumentTemplate: + type: string + description: The trust policy template that grants an entity permission to assume roles that you create from this template. + InlinePolicyTemplates: + type: string + description: A list of inline policy templates that the service embeds in roles that you create from this template. + ManagedPolicyArns: + type: string + description: A list of the ARNs of the managed policies that the service attaches to roles that you create from this template. + PermissionBoundaryArn: + type: string + description: The ARN of the policy that sets the permissions boundary for roles that you create from this template. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + ParametersDefinition: + type: string + description: A list of the parameters that are defined for this role template version. You supply values for these parameters when you create a role with AcquireRole. + RoleTagsTemplate: + type: string + description: A list of tag templates that are applied to roles that are created from this template. + MaxSessionDuration: + type: integer + description: The maximum session duration (in seconds) for roles that are created from this template. + VersionEnabled: + type: boolean + description: Specifies whether this specific minor version of the role template is enabled. + CreateTimestamp: + type: string + description: The date and time, in ISO 8601 date-time format, when the role template version was created. + UpdateTimestamp: + type: string + description: The date and time, in ISO 8601 date-time format, when the role template version was last updated. + GetRoleTemplateVersionOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/RoleTemplateVersionDisplay" + GetRoleTemplateVersionRequest: + type: object + properties: + TemplateArn: + $ref: "#/components/schemas/arnType" + description: The Amazon Resource Name (ARN) of the role template whose version you want to retrieve. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + MinorVersion: + $ref: "#/components/schemas/minorVersionType" + description: The minor version of the role template to retrieve. If you do not specify a minor version, the service returns the template's default minor version. + required: + - TemplateArn GetSAMLProviderResponseDisplay: type: object properties: @@ -11576,6 +11905,28 @@ components: MaxItems: $ref: "#/components/schemas/maxItemsType" description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + accountPropertiesMapType: + type: object + properties: {} + PutAccountPropertiesResponseDisplay: + type: object + properties: {} + PutAccountPropertiesOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/PutAccountPropertiesResponseDisplay" + PutAccountPropertiesRequest: + type: object + properties: + Properties: + type: object + properties: {} + description: A map of property key-value pairs to set. All keys must belong to the same namespace. Each key uses the format Namespace/PropertyName. The key must contain exactly one / separating the namespace from the property name, and cannot start or end with /. The service validates each value based on the property key's expected type. For example, boolean properties expect true or false. + required: + - Properties PutGroupPolicyRequest: type: object properties: @@ -11770,6 +12121,17 @@ components: description: The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide. required: - GlobalEndpointTokenVersion + OrganizationPolicyListType: + type: array + items: + $ref: "#/components/schemas/OrderedOrganizationPolicyType" + OrderedOrganizationPolicyType: + description: Represents one level of an Organizations hierarchy—the organization root, an organizational unit (OU), or an account—together with the service control policies (SCPs) that apply at that level. Each element in the list represents one level of the hierarchy, ordered from the organization root down to the account. For more information about SCPs, see Service control policies (SCPs) in the Organizations User Guide. + type: object + properties: + ServiceControlPolicyInputList: + $ref: "#/components/schemas/SimulationPolicyListType" + description: A list of SCP documents that apply at this level of the Organizations hierarchy. Each document is specified as a string containing the complete, valid JSON text of an SCP. ActionNameListType: type: array items: @@ -11840,25 +12202,25 @@ components: description: The name of the API operation tested on the indicated resource. EvalResourceName: type: string - description: The ARN of the resource that the indicated API operation was tested on. + description: The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults. If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead. EvalDecision: type: string description: The result of the simulation. MatchedStatements: type: string - description: A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result. + description: A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result. In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here. MissingContextValues: type: string - description: A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. + description: A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here. OrganizationsDecisionDetail: type: string - description: A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization. + description: A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization. For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults. PermissionsBoundaryDecisionDetail: type: string description: Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity. EvalDecisionDetails: type: string - description: Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision. If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned. When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account. If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned. + description: Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision. In the top-level result, this map reports the most restrictive decision per policy type across all requested resources. If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned. When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account. If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned. ResourceSpecificResults: type: string description: The individual results of the simulation of the API operation specified in EvalActionName on each resource. @@ -11878,6 +12240,9 @@ components: PermissionsBoundaryPolicyInputList: $ref: "#/components/schemas/SimulationPolicyListType" description: "The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF) The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)" + OrderedOrganizationPolicyInputList: + $ref: "#/components/schemas/OrganizationPolicyListType" + description: An ordered list of service control policies (SCPs) to include in the simulation. Each element represents one level of an Organizations hierarchy, from the organization root to the account. The simulator evaluates SCPs in the order that you provide, consistent with how Organizations enforces SCPs. The first element must represent the organization root, and the last element must represent the account. Any elements between them represent organizational units (OUs) in descending order. Use this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy. ActionNames: $ref: "#/components/schemas/ActionNameListType" description: A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name. @@ -11892,7 +12257,7 @@ components: description: "An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn. The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root." CallerArn: $ref: "#/components/schemas/ResourceNameType" - description: The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. + description: The ARN of the IAM user, group, or role that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You cannot specify the ARN of an assumed role, federated user, or a service principal. ContextEntries: $ref: "#/components/schemas/ContextEntryListType" description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. @@ -11908,6 +12273,60 @@ components: required: - PolicyInputList - ActionNames + PolicyExclusionsListType: + type: array + items: + $ref: "#/components/schemas/PolicyIdentifier" + PolicyIdentifier: + description: Identifies one or more policies as a union type. Specify exactly one of PolicyType, PolicyArn, or InlinePolicyIdentifier to identify policies by their type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to. + type: object + properties: + PolicyType: + $ref: "#/components/schemas/PolicyIdentifierPolicyType" + description: The policy type to identify. All policies of the specified type are matched. + PolicyArn: + $ref: "#/components/schemas/arnType" + description: "The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a customer managed policy that is attached to an IAM user, group, or role. Wildcard characters are supported in the resource name portion of the ARN to match multiple managed policies: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character). For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference." + InlinePolicyIdentifier: + $ref: "#/components/schemas/InlinePolicyIdentifierType" + description: An inline policy identifier consisting of a policy name and the entity it is attached to. Wildcard characters (* and ?) in the entity name can match multiple entities. + PolicyIdentifierPolicyType: + type: string + enum: + - inline + - aws-managed + - user-managed + - permission-boundary + - scp + - rcp + InlinePolicyIdentifierType: + description: Identifies one or more inline policies that are embedded in IAM users, groups, or roles, by the name of the policy together with the type and name of the entity that it is attached to. Wildcard characters in the entity name can match multiple entities, so a single identifier can select more than one attached inline policy. + type: object + properties: + PolicyName: + $ref: "#/components/schemas/policyNameType" + description: The name of the inline policy. + AttachmentType: + $ref: "#/components/schemas/AttachmentType" + description: The type of IAM entity that the inline policy is attached to. + AttachmentName: + $ref: "#/components/schemas/AttachmentName" + description: "The name of the IAM user, group, or role that the inline policy is attached to. Wildcard characters are supported to match multiple entities: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character)." + required: + - PolicyName + - AttachmentType + - AttachmentName + AttachmentType: + type: string + enum: + - user + - group + - role + AttachmentName: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\w+=,.@-]+" SimulatePrincipalPolicyOutputDisplay: type: object properties: @@ -11927,6 +12346,9 @@ components: PermissionsBoundaryPolicyInputList: $ref: "#/components/schemas/SimulationPolicyListType" description: "The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF) The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)" + PolicyExclusionList: + $ref: "#/components/schemas/PolicyExclusionsListType" + description: A list of policies to exclude from the simulation. Use this parameter to test what the simulation result would be if a policy were removed, without changing which policies are actually attached to the principal identified by PolicySourceArn. Each entry is a PolicyIdentifier that identifies one or more policies to exclude by policy type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to. Syntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed positions, cause the request to fail with an InvalidInput error. Syntactically valid identifiers that don't match any attached policy are ignored. Resource control policies (RCPs) are not supported in this release; identifiers that target RCPs are also ignored. ActionNames: $ref: "#/components/schemas/ActionNameListType" description: A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser. @@ -11941,7 +12363,7 @@ components: description: An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn. CallerArn: $ref: "#/components/schemas/ResourceNameType" - description: The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. + description: The ARN of the IAM user, group, or role that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user, group, or role that you specify in PolicySourceArn. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies. You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN of an assumed role, federated user, or a service principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user, group, or role. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. ContextEntries: $ref: "#/components/schemas/ContextEntryListType" description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. @@ -14647,6 +15069,55 @@ components: insert: [] update: [] delete: [] + account_properties: + id: aws.iam.account_properties + name: account_properties + title: account_properties + methods: + get_account_properties: + operation: + $ref: "#/paths/~1?Action=GetAccountProperties&Version=2010-05-08/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetAccountPropertiesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + put_account_properties: + operation: + $ref: "#/paths/~1?Action=PutAccountProperties&Version=2010-05-08/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/PutAccountPropertiesOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/account_properties/methods/get_account_properties" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/account_properties/methods/put_account_properties" + delete: [] account_summaries: id: aws.iam.account_summaries name: account_summaries @@ -14903,6 +15374,36 @@ components: insert: [] update: [] delete: [] + role_template_versions: + id: aws.iam.role_template_versions + name: role_template_versions + title: role_template_versions + methods: + get_role_template_version: + operation: + $ref: "#/paths/~1?Action=GetRoleTemplateVersion&Version=2010-05-08/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetRoleTemplateVersionOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/role_template_versions/methods/get_role_template_version" + insert: [] + update: [] + delete: [] service_last_accessed_details_with_entities: id: aws.iam.service_last_accessed_details_with_entities name: service_last_accessed_details_with_entities diff --git a/providers/src/aws/v00.00.00000/services/imagebuilder.yaml b/providers/src/aws/v00.00.00000/services/imagebuilder.yaml index ea3ccd6f..133c0ef5 100644 --- a/providers/src/aws/v00.00.00000/services/imagebuilder.yaml +++ b/providers/src/aws/v00.00.00000/services/imagebuilder.yaml @@ -343,6 +343,8 @@ paths: $ref: "#/components/schemas/AdditionalInstanceConfiguration" amiTags: $ref: "#/components/schemas/TagMap" + amiWatermarks: + $ref: "#/components/schemas/AmiWatermarksList" clientToken: $ref: "#/components/schemas/ClientToken" required: @@ -665,7 +667,7 @@ paths: /DistributeImage: put: operationId: DistributeImage - description: DistributeImage distributes existing AMIs to additional regions and accounts without rebuilding the image. + description: Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built. parameters: [] requestBody: required: true @@ -2977,10 +2979,10 @@ components: properties: imageLogGroupName: $ref: "#/components/schemas/LogGroupName" - description: The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name. + description: Specifies the CloudWatch Logs log group name for image build logs. The log group name can contain alphanumeric characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names not starting with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified, defaults to /aws/imagebuilder/image-name. pipelineLogGroupName: $ref: "#/components/schemas/LogGroupName" - description: The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name. + description: Specifies the CloudWatch Logs log group name for pipeline execution logs. The log group name can contain alphanumeric characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names not starting with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified, defaults to /aws/imagebuilder/pipeline/pipeline-name. CreateImagePipelineResponse: type: object properties: @@ -3018,6 +3020,17 @@ components: minLength: 1 maxLength: 21847 pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ + AmiWatermarksList: + description: A list of AMI watermark names to attach to the output AMI. Names are case-sensitive. The recipe does not allow duplicate names. + type: array + items: + $ref: "#/components/schemas/AmiWatermarkName" + AmiWatermarkName: + description: The name of an AMI watermark. AMI watermarks are lineage markers that Image Builder attaches to output AMIs during the build process. AMI watermarks automatically propagate to derivative AMIs when the source AMI is copied or distributed. + type: string + minLength: 3 + maxLength: 128 + pattern: ^[A-Za-z0-9()\[\]./'@_\-][A-Za-z0-9 ()\[\]./'@_\-]{1,126}[A-Za-z0-9()\[\]./'@_\-]$ CreateImageRecipeResponse: type: object properties: @@ -3896,6 +3909,9 @@ components: type: object properties: {} description: Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution. + amiWatermarks: + $ref: "#/components/schemas/AmiWatermarksList" + description: The AMI watermark names attached to the output AMI from this recipe. AMI watermarks are lineage markers that automatically propagate to derivative AMIs when the source AMI is copied or distributed. Arn: type: string InfrastructureConfiguration: diff --git a/providers/src/aws/v00.00.00000/services/inspector2.yaml b/providers/src/aws/v00.00.00000/services/inspector2.yaml index 1af76de0..15c14ec8 100644 --- a/providers/src/aws/v00.00.00000/services/inspector2.yaml +++ b/providers/src/aws/v00.00.00000/services/inspector2.yaml @@ -362,6 +362,41 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateCodeSecurityScanConfigurationResponse" + /connector/create: + post: + operationId: CreateConnector + description: Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/String" + name: + $ref: "#/components/schemas/ConnectorName" + provider: + $ref: "#/components/schemas/ConnectorCloudProvider" + description: + $ref: "#/components/schemas/ConnectorDescription" + providerDetail: + $ref: "#/components/schemas/ProviderDetailCreate" + tags: + $ref: "#/components/schemas/ConnectorTagMap" + required: + - name + - provider + - providerDetail + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateConnectorResponse" /filters/create: post: operationId: CreateFilter @@ -522,6 +557,29 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteCodeSecurityScanConfigurationResponse" + /connector/delete: + post: + operationId: DeleteConnector + description: Deletes a connector from your account. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + connectorArn: + $ref: "#/components/schemas/ConnectorArn" + required: + - connectorArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteConnectorResponse" /filters/delete: post: operationId: DeleteFilter @@ -848,8 +906,17 @@ paths: /configuration/get: post: operationId: GetConfiguration - description: Retrieves setting configurations for Inspector scans. + description: Retrieves setting configurations for Amazon Inspector scans. If you specify an accountId, this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an accountId, this operation returns your own scan configuration. parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" responses: "200": description: Success @@ -1206,6 +1273,56 @@ paths: application/json: schema: $ref: "#/components/schemas/ListCodeSecurityScanConfigurationsResponse" + /connectorscanconfigurations/list: + post: + operationId: ListConnectorScanConfigurations + description: Lists scan configurations for Amazon Web Services Config connectors. Results are paginated. Use the nextToken parameter to retrieve the next page of results. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + awsConfigConnectorArns: + $ref: "#/components/schemas/AwsConfigConnectorArnList" + maxResults: + $ref: "#/components/schemas/ListConnectorScanConfigurationsMaxResults" + nextToken: + $ref: "#/components/schemas/ConnectorNextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListConnectorScanConfigurationsResponse" + /connector/list: + post: + operationId: ListConnectors + description: Lists connectors in your account. Results are paginated. Use the nextToken parameter to retrieve the next page of results. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/Integer" + nextToken: + $ref: "#/components/schemas/ConnectorNextToken" + filterCriteria: + $ref: "#/components/schemas/ConnectorFilterCriteria" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListConnectorsResponse" /coverage/list: post: operationId: ListCoverage @@ -1755,7 +1872,7 @@ paths: /configuration/update: post: operationId: UpdateConfiguration - description: Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting. + description: Updates the scan configuration for your Amazon Inspector account. If you don't specify an accountId, this operation updates the delegated administrator's configuration and propagates it to member accounts that have not been individually configured. If you specify an accountId, this operation updates that member account's configuration. Only the delegated administrator can specify an accountId; member accounts cannot call this operation. parameters: [] requestBody: required: false @@ -1764,10 +1881,14 @@ paths: schema: type: object properties: + accountId: + $ref: "#/components/schemas/AccountId" ecrConfiguration: $ref: "#/components/schemas/EcrConfiguration" ec2Configuration: $ref: "#/components/schemas/Ec2Configuration" + updateConfigurationInheritance: + $ref: "#/components/schemas/UpdateConfigurationInheritance" responses: "200": description: Success @@ -1775,6 +1896,59 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateConfigurationResponse" + /connector/update: + post: + operationId: UpdateConnector + description: Updates the description or provider-specific configuration details of an existing connector. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + connectorArn: + $ref: "#/components/schemas/ConnectorArn" + description: + $ref: "#/components/schemas/ConnectorDescription" + providerDetail: + $ref: "#/components/schemas/ProviderDetailUpdate" + required: + - connectorArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateConnectorResponse" + /connectorscanconfiguration/update: + post: + operationId: UpdateConnectorScanConfiguration + description: Updates scan configuration settings for resources associated with an Amazon Web Services Config connector. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + awsConfigConnectorArn: + $ref: "#/components/schemas/AwsConfigConnectorArn" + scanConfiguration: + $ref: "#/components/schemas/ConnectorScanConfiguration" + required: + - awsConfigConnectorArn + - scanConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateConnectorScanConfigurationResponse" /ec2deepinspectionconfiguration/update: post: operationId: UpdateEc2DeepInspectionConfiguration @@ -2574,6 +2748,9 @@ components: status: $ref: "#/components/schemas/FreeTrialStatus" description: The order to sort results by. + cloudProvider: + $ref: "#/components/schemas/CloudProvider" + description: The cloud provider associated with the free trial information. required: - type_ - start @@ -2587,6 +2764,9 @@ components: - LAMBDA - LAMBDA_CODE - CODE_REPOSITORY + - VM + - CONTAINER_IMAGE + - SERVERLESS_FUNCTION Timestamp: type: string format: date-time @@ -2595,6 +2775,12 @@ components: enum: - ACTIVE - INACTIVE + CloudProvider: + type: string + enum: + - AWS + - AZURE + - NOT_APPLICABLE FreeTrialInfoErrorList: type: array items: @@ -3011,6 +3197,116 @@ components: description: The Amazon Resource Name (ARN) of the created scan configuration. required: - scanConfigurationArn + ConnectorName: + type: string + minLength: 1 + maxLength: 50 + pattern: "[\\p{L}\\p{N}_-]+" + ConnectorCloudProvider: + type: string + enum: + - AZURE + ConnectorDescription: + type: string + minLength: 0 + maxLength: 200 + pattern: "[^\\p{C}]*" + ProviderDetailCreate: + description: The provider-specific configuration details for creating a connector. + type: object + properties: + azure: + $ref: "#/components/schemas/AzureProviderDetailCreate" + description: The Azure-specific details for creating a connector. + AzureProviderDetailCreate: + description: The Azure-specific configuration details for creating a connector, including the Amazon Web Services Config connector association, scan scope, and regions to scan. + type: object + properties: + awsConfigConnectorArn: + $ref: "#/components/schemas/AwsConfigConnectorArn" + description: The ARN of the Amazon Web Services Config connector to associate with this connector. + scopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfigurationInput" + description: The scope configuration that defines which Azure resources to scan. + azureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The Azure regions to scan. + autoInstallVMScanner: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to automatically install the VM scanner on connected Azure resources. Defaults to true. + required: + - awsConfigConnectorArn + - scopeConfiguration + - azureRegions + AwsConfigConnectorArn: + type: string + minLength: 1 + maxLength: 512 + pattern: arn:([^:]+):config:([^:]+):([^:]+):connector/([^/]+)/([^/]+)/([^/:\s]+) + AzureScopeConfigurationInput: + description: The scope of Azure resources to scan, defined separately for VM, container image, and serverless scanning. Provide this when you create or update an Azure connector. + type: object + properties: + vmScanning: + $ref: "#/components/schemas/ScopeConfigurationInput" + description: The scope configuration input for VM scanning. + containerImageScanning: + $ref: "#/components/schemas/ScopeConfigurationInput" + description: The scope configuration input for container image scanning. + serverlessScanning: + $ref: "#/components/schemas/ScopeConfigurationInput" + description: The scope configuration input for serverless scanning. + ScopeConfigurationInput: + description: The scope of resources to scan for a single scanning type. Provide this as part of an AzureScopeConfigurationInput when you create or update a connector. + type: object + properties: + scopeType: + $ref: "#/components/schemas/ScopeType" + description: The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions. + scopeValues: + $ref: "#/components/schemas/ScopeValueList" + description: The list of scope values. For subscription-level scope, these are Azure subscription IDs. + required: + - scopeType + ScopeType: + type: string + enum: + - TENANT + - SUBSCRIPTION + ScopeValueList: + type: array + items: + $ref: "#/components/schemas/ScopeValue" + ScopeValue: + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + AzureRegionList: + type: array + items: + $ref: "#/components/schemas/AzureRegion" + AzureRegion: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9-]+" + ConnectorTagMap: + type: object + properties: {} + CreateConnectorResponse: + type: object + properties: + connectorArn: + $ref: "#/components/schemas/ConnectorArn" + description: The Amazon Resource Name (ARN) of the created connector. + required: + - connectorArn + ConnectorArn: + type: string + minLength: 1 + maxLength: 256 + pattern: arn:aws(-[a-z]+)*:inspector2:[a-z0-9-]+:[0-9]{12}:connector/([a-f0-9-]+|aws-service-connector/.+/[a-f0-9-]+) FilterAction: type: string enum: @@ -3162,6 +3458,63 @@ components: codeRepositoryProviderType: $ref: "#/components/schemas/StringFilterList" description: Filter criteria for findings based on the repository provider type (such as GitHub, GitLab, etc.). + cloudProvider: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the cloud provider. + cloudProviderRegion: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the cloud provider region. + cloudProviderAccountId: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the cloud provider account ID. + cloudProviderOrgId: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the cloud provider organization ID. + cloudVmImageReference: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the image reference of a VM instance. + cloudVmNetworkId: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the network ID of a VM instance. + cloudVmSubnetIds: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the subnet IDs of a VM instance. + cloudImageRepositoryName: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the repository name of a container image. + cloudImageRegistry: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the registry of a container image. + cloudImageDigest: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the digest of a container image. + cloudImageTags: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the tags of a container image. + cloudImagePushedAt: + $ref: "#/components/schemas/DateFilterList" + description: Filter criteria for when a container image was pushed. + cloudImageArchitecture: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the architecture of a container image. + cloudImageLastInUseAt: + $ref: "#/components/schemas/DateFilterList" + description: Filter criteria for the last time a container image was in use. + cloudImageInUseCount: + $ref: "#/components/schemas/NumberFilterList" + description: Filter criteria for the in-use count of a container image. + cloudServerlessFunctionName: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the name of a serverless function. + cloudServerlessFunctionRuntime: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the runtime of a serverless function. + cloudServerlessFunctionLastModifiedAt: + $ref: "#/components/schemas/DateFilterList" + description: Filter criteria for when a serverless function was last modified. + cloudServerlessFunctionExecutionRole: + $ref: "#/components/schemas/StringFilterList" + description: Filter criteria for the execution role of a serverless function. StringFilterList: type: array items: @@ -3374,6 +3727,39 @@ components: lambdaFunctionTags: $ref: "#/components/schemas/ResourceMapFilterList" description: The Amazon Web Services Lambda function tags used as resource filter criteria. + cloudProvider: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud providers used as resource filter criteria. + cloudProviderAccountId: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud provider account IDs used as resource filter criteria. + cloudProviderOrgId: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud provider organization IDs used as resource filter criteria. + cloudProviderRegion: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud provider regions used as resource filter criteria. + cloudVmInstanceTags: + $ref: "#/components/schemas/ResourceMapFilterList" + description: The cloud VM instance tags used as resource filter criteria. + cloudContainerImageTags: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud container image tags used as resource filter criteria. + cloudContainerRepositoryName: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud container repository names used as resource filter criteria. + cloudContainerRegistryName: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud container registry names used as resource filter criteria. + cloudServerlessFunctionName: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud serverless function names used as resource filter criteria. + cloudServerlessFunctionRuntime: + $ref: "#/components/schemas/ResourceStringFilterList" + description: The cloud serverless function runtimes used as resource filter criteria. + cloudServerlessFunctionTags: + $ref: "#/components/schemas/ResourceMapFilterList" + description: The cloud serverless function tags used as resource filter criteria. ResourceStringFilterList: type: array items: @@ -3455,6 +3841,8 @@ components: scanConfigurationArn: $ref: "#/components/schemas/ScanConfigurationArn" description: The Amazon Resource Name (ARN) of the deleted scan configuration. + DeleteConnectorResponse: + type: object DeleteFilterResponse: type: object properties: @@ -3611,8 +3999,8 @@ components: ResourceId: type: string minLength: 10 - maxLength: 341 - pattern: .*(^arn:.*:ecr:.*:\d{12}:repository\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$|(^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$)|(^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:codesecurity-integration\/[a-f0-9-]{36}\/project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$)).* + maxLength: 1024 + pattern: .*(^arn:.*:ecr:.*:\d{12}:repository\/[a-zA-Z0-9._\/-]+(\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$|(^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$)|(^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:codesecurity-integration\/[a-f0-9-]{36}\/project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$))|(^\/subscriptions\/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}\/resourcegroups\/[a-z0-9_\-\.()]+\/providers\/(microsoft\.compute\/virtualmachines\/[a-z0-9_\-]+|microsoft\.web\/sites\/[a-z0-9_\-]+|microsoft\.containerregistry\/registries\/[a-z0-9_\-]+(\/repositories\/[a-z0-9_\-\/]+\/images?\/sha256:[a-f0-9]{64})?)$).* CisScanResultDetailsFilterCriteria: description: The CIS scan result details filter criteria. type: object @@ -3798,7 +4186,7 @@ components: - resourceId ClusterForImageFilterCriteriaResourceIdString: type: string - pattern: arn:.*:ecr:.*:\d{12}:repository\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\/sha256:[a-z0-9]{64})? + pattern: arn:.*:ecr:.*:\d{12}:repository\/[a-zA-Z0-9._\/-]+(\/sha256:[a-z0-9]{64})? GetClustersForImageRequestMaxResultsInteger: type: integer minimum: 1 @@ -3958,13 +4346,13 @@ components: lastUpdateOn: $ref: "#/components/schemas/Timestamp" description: The timestamp when the code security integration was last updated. + authorizationUrl: + $ref: "#/components/schemas/AuthorizationUrl" + description: The URL used to authorize the integration with the repository provider. This is only returned if reauthorization is required to fix a connection issue. Otherwise, it is null. tags: type: object properties: {} description: The tags associated with the code security integration. - authorizationUrl: - $ref: "#/components/schemas/AuthorizationUrl" - description: The URL used to authorize the integration with the repository provider. This is only returned if reauthorization is required to fix a connection issue. Otherwise, it is null. required: - integrationArn - name @@ -4082,6 +4470,8 @@ components: - DAYS_14 - DAYS_60 - DAYS_90 + - DAYS_3 + - DAYS_7 EcrRescanDurationStatus: type: string enum: @@ -4099,6 +4489,8 @@ components: - DAYS_60 - DAYS_90 - DAYS_180 + - DAYS_3 + - DAYS_7 EcrPullDateRescanMode: type: string enum: @@ -4111,6 +4503,9 @@ components: scanModeState: $ref: "#/components/schemas/Ec2ScanModeState" description: An object that contains details about the state of the Amazon EC2 scan mode. + vmScannerState: + $ref: "#/components/schemas/VMScannerState" + description: An object that contains details about the state of the Amazon Inspector VM scanner. Ec2ScanModeState: description: The state of your Amazon EC2 scan mode configuration. type: object @@ -4131,6 +4526,25 @@ components: enum: - SUCCESS - PENDING + VMScannerState: + description: The state of the Amazon Inspector VM scanner. + type: object + properties: + activated: + $ref: "#/components/schemas/Boolean" + description: Whether the VM scanner is activated. + activatedAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the VM scanner was activated. + status: + $ref: "#/components/schemas/VMScannerStatus" + description: The status of the VM scanner. + VMScannerStatus: + type: string + enum: + - SUCCESS + - PENDING + - FAILED GetDelegatedAdminAccountResponse: type: object properties: @@ -4185,7 +4599,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: (?:/(?:\.[-\w]+|[-\w]+(?:\.[-\w]+)?))+/? + pattern: (?:(?:/(?:\.[-\w]+|[-\w]+(?:[. ][-\w]+)*))+/?|[A-Za-z]:\\(?:[-\w]+(?:[. ][-\w]+)*\\)*[-\w]+(?:[. ][-\w]+)*) ScanType: type: string enum: @@ -4200,6 +4614,9 @@ components: - AWS_ECR_REPOSITORY - AWS_LAMBDA_FUNCTION - CODE_REPOSITORY + - Microsoft.Compute/virtualMachines + - Microsoft.ContainerRegistry/registry/containerImage + - Microsoft.Web/sites GetEncryptionKeyResponse: type: object properties: @@ -4928,10 +5345,6 @@ components: lastUpdateOn: $ref: "#/components/schemas/Timestamp" description: The timestamp when the code security integration was last updated. - tags: - type: object - properties: {} - description: The tags associated with the code security integration. required: - integrationArn - name @@ -5008,10 +5421,6 @@ components: scopeSettings: $ref: "#/components/schemas/ScopeSettings" description: The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector. - tags: - type: object - properties: {} - description: The tags associated with the scan configuration. required: - scanConfigurationArn - name @@ -5022,56 +5431,394 @@ components: minLength: 12 maxLength: 34 pattern: .*(^\d{12}$)|(^o-[a-z0-9]{10,32}$).* - ListCoverageMaxResults: + AwsConfigConnectorArnList: + type: array + items: + $ref: "#/components/schemas/AwsConfigConnectorArn" + ListConnectorScanConfigurationsMaxResults: type: integer minimum: 1 - maximum: 200 - CoverageFilterCriteria: - description: A structure that identifies filter criteria for GetCoverageStatistics. + maximum: 50 + ConnectorNextToken: + type: string + minLength: 1 + maxLength: 1024 + ListConnectorScanConfigurationsResponse: type: object properties: - scanStatusCode: - $ref: "#/components/schemas/CoverageStringFilterList" - description: "The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException." - scanStatusReason: - $ref: "#/components/schemas/CoverageStringFilterList" - description: The scan status reason to filter on. - accountId: - $ref: "#/components/schemas/CoverageStringFilterList" - description: An array of Amazon Web Services account IDs to return coverage statistics for. - resourceId: - $ref: "#/components/schemas/CoverageStringFilterList" - description: An array of Amazon Web Services resource IDs to return coverage statistics for. - resourceType: - $ref: "#/components/schemas/CoverageStringFilterList" - description: An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT. - scanType: - $ref: "#/components/schemas/CoverageStringFilterList" - description: An array of Amazon Inspector scan types to return coverage statistics for. - ecrRepositoryName: - $ref: "#/components/schemas/CoverageStringFilterList" - description: The Amazon ECR repository name to filter on. - ecrImageTags: - $ref: "#/components/schemas/CoverageStringFilterList" - description: The Amazon ECR image tags to filter on. - ec2InstanceTags: - $ref: "#/components/schemas/CoverageMapFilterList" - description: The Amazon EC2 instance tags to filter on. - lambdaFunctionName: - $ref: "#/components/schemas/CoverageStringFilterList" - description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names. - lambdaFunctionTags: - $ref: "#/components/schemas/CoverageMapFilterList" - description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag. - lambdaFunctionRuntime: - $ref: "#/components/schemas/CoverageStringFilterList" - description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime. - lastScannedAt: - $ref: "#/components/schemas/CoverageDateFilterList" - description: Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range. - scanMode: + scanConfigurations: + $ref: "#/components/schemas/ConnectorScanConfigurationItemList" + description: A list of scan configuration items. + nextToken: + $ref: "#/components/schemas/ConnectorNextToken" + description: A pagination token. If this value is not null, there are additional results available. Use this token in the nextToken parameter of a subsequent request to retrieve the next page of results. + required: + - scanConfigurations + ConnectorScanConfigurationItemList: + type: array + items: + $ref: "#/components/schemas/ConnectorScanConfigurationItem" + ConnectorScanConfigurationItem: + description: Represents a scan configuration and the connectors it applies to. Returned in the results of a ListConnectorScanConfigurations request. + type: object + properties: + awsConfigConnectorArn: + $ref: "#/components/schemas/AwsConfigConnectorArn" + description: The ARN of the Amazon Web Services Config connector. + connectorArns: + $ref: "#/components/schemas/ConnectorArnList" + description: The list of connector ARNs associated with this Amazon Web Services Config connector. + scanConfiguration: + $ref: "#/components/schemas/ConnectorScanConfiguration" + description: The scan configuration settings. + required: + - awsConfigConnectorArn + - connectorArns + - scanConfiguration + ConnectorArnList: + type: array + items: + $ref: "#/components/schemas/ConnectorArn" + ConnectorScanConfiguration: + description: The scan settings that Amazon Inspector applies to resources discovered through a connector. + type: object + properties: + containerImageScanning: + $ref: "#/components/schemas/ConnectorContainerImageScanConfiguration" + description: The container image scanning configuration, including push and pull duration settings. + ConnectorContainerImageScanConfiguration: + description: The container image scanning settings for a connector, including how long pushed and pulled images continue to be rescanned for vulnerabilities. + type: object + properties: + pushDuration: + $ref: "#/components/schemas/ContainerImageRescanDuration" + description: The amount of time after a container image is pushed to a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are LIFETIME, DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180. + pullDuration: + $ref: "#/components/schemas/ContainerImagePullDateRescanDuration" + description: The amount of time after a container image is last pulled from a repository during which Amazon Inspector continues to rescan the image for vulnerabilities. Valid values are DAYS_3, DAYS_7, DAYS_14, DAYS_30, DAYS_60, DAYS_90, and DAYS_180. + ContainerImageRescanDuration: + type: string + enum: + - LIFETIME + - DAYS_3 + - DAYS_7 + - DAYS_30 + - DAYS_180 + - DAYS_14 + - DAYS_60 + - DAYS_90 + ContainerImagePullDateRescanDuration: + type: string + enum: + - DAYS_3 + - DAYS_7 + - DAYS_14 + - DAYS_30 + - DAYS_60 + - DAYS_90 + - DAYS_180 + ConnectorFilterCriteria: + description: Contains the filter criteria for narrowing the results returned by a ListConnectors request. You can filter by connector ARN, Amazon Web Services account ID, Amazon Web Services Config connector ARN, connector type, or cloud provider. + type: object + properties: + connectorArns: + $ref: "#/components/schemas/ConnectorArnFilterList" + description: Filter by connector ARNs. + accounts: + $ref: "#/components/schemas/StringFilterList" + description: Filter by Amazon Web Services account IDs. + awsConfigConnectorArns: + $ref: "#/components/schemas/AwsConfigConnectorArnFilterList" + description: Filter by Amazon Web Services Config connector ARNs. + connectorType: + $ref: "#/components/schemas/ConnectorTypeFilterList" + description: Filter by connector type. + provider: + $ref: "#/components/schemas/ProviderFilterList" + description: Filter by cloud provider. + ConnectorArnFilterList: + type: array + items: + $ref: "#/components/schemas/ConnectorArnFilter" + ConnectorArnFilter: + description: A filter that matches connectors by connector ARN. + type: object + properties: + comparison: + $ref: "#/components/schemas/ConnectorArnComparison" + description: The comparison operator for the connector ARN filter. + value: + $ref: "#/components/schemas/ConnectorArn" + description: The connector ARN value to filter by. + required: + - comparison + - value + ConnectorArnComparison: + type: string + enum: + - EQUALS + AwsConfigConnectorArnFilterList: + type: array + items: + $ref: "#/components/schemas/AwsConfigConnectorArnFilter" + AwsConfigConnectorArnFilter: + description: A filter that matches connectors by the ARN of the associated Amazon Web Services Config connector. + type: object + properties: + comparison: + $ref: "#/components/schemas/AwsConfigConnectorArnComparison" + description: The comparison operator for the Amazon Web Services Config connector ARN filter. + value: + $ref: "#/components/schemas/AwsConfigConnectorArn" + description: The Amazon Web Services Config connector ARN value to filter by. + required: + - comparison + - value + AwsConfigConnectorArnComparison: + type: string + enum: + - EQUALS + ConnectorTypeFilterList: + type: array + items: + $ref: "#/components/schemas/ConnectorTypeFilter" + ConnectorTypeFilter: + description: A filter that matches connectors by connector type. + type: object + properties: + comparison: + $ref: "#/components/schemas/ConnectorTypeComparison" + description: The comparison operator for the connector type filter. + value: + $ref: "#/components/schemas/ConnectorType" + description: The connector type value to filter by. + required: + - comparison + - value + ConnectorTypeComparison: + type: string + enum: + - EQUALS + ConnectorType: + type: string + enum: + - CUSTOMER_MANAGED + - SERVICE_LINKED + ProviderFilterList: + type: array + items: + $ref: "#/components/schemas/ProviderFilter" + ProviderFilter: + description: A filter that matches connectors by cloud provider. + type: object + properties: + comparison: + $ref: "#/components/schemas/ProviderComparison" + description: The comparison operator for the provider filter. + value: + $ref: "#/components/schemas/ConnectorCloudProvider" + description: The cloud provider value to filter by. + required: + - comparison + - value + ProviderComparison: + type: string + enum: + - EQUALS + ListConnectorsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/ConnectorList" + description: A list of connectors. + nextToken: + $ref: "#/components/schemas/ConnectorNextToken" + description: A pagination token. If this value is not null, there are additional results available. Use this token in the nextToken parameter of a subsequent request to retrieve the next page of results. + required: + - items_ + ConnectorList: + type: array + items: + $ref: "#/components/schemas/Connector" + Connector: + description: Describes a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning. + type: object + properties: + connectorArn: + $ref: "#/components/schemas/ConnectorArn" + description: The Amazon Resource Name (ARN) of the connector. + name: + $ref: "#/components/schemas/ConnectorName" + description: The name of the connector. + description: + $ref: "#/components/schemas/ConnectorDescription" + description: A description of the connector. + provider: + $ref: "#/components/schemas/ConnectorCloudProvider" + description: The cloud provider for the connector. + enablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector, which indicates whether the connector is active and scanning resources. + enablementStatusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current enablement status of the connector. + health: + $ref: "#/components/schemas/ConnectorHealth" + description: The health of the connector, which indicates whether Amazon Inspector can reach and scan the connected resources. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the connector was created. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the connector was last updated. + azureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The Azure regions configured for the connector. + awsConfigConnectorArn: + $ref: "#/components/schemas/AwsConfigConnectorArn" + description: The ARN of the Amazon Web Services Config connector associated with this connector. + scopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfiguration" + description: The Azure scope configuration for the connector. + tags: + type: object + properties: {} + description: The tags associated with the connector. + autoInstallVMScanner: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the VM scanner is automatically installed on connected resources. + required: + - connectorArn + - provider + - createdAt + - updatedAt + EnablementStatus: + type: string + enum: + - ENABLED + - PENDING_ENABLEMENT + - FAILED_TO_ENABLE + - PENDING_UPDATE + - FAILED_TO_UPDATE + - PENDING_DELETION + - DELETED + - FAILED_TO_DELETE + ConnectorHealth: + description: The health and connectivity status of a connector, including the last time the status was checked and any diagnostic message. Returned as part of the Connector structure. + type: object + properties: + connectorStatus: + $ref: "#/components/schemas/ConnectorHealthStatus" + description: The health status of the connector. + lastCheckedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the connector health was last checked. + message: + $ref: "#/components/schemas/String" + description: A message providing additional details about the connector health status. + required: + - connectorStatus + - lastCheckedAt + ConnectorHealthStatus: + type: string + enum: + - CONNECTED + - DEGRADED + - FAILED_TO_CONNECT + - PENDING_AUTHORIZATION + - PENDING_CONFIGURATION + - UNKNOWN + SyntheticTimestamp_date_time: + type: string + format: date-time + AzureScopeConfiguration: + description: The scope of Azure resources that Amazon Inspector scans, defined separately for VM, container image, and serverless scanning. Returned as part of a connector's configuration. + type: object + properties: + vmScanning: + $ref: "#/components/schemas/ScopeConfiguration" + description: The scope configuration for VM scanning. + containerImageScanning: + $ref: "#/components/schemas/ScopeConfiguration" + description: The scope configuration for container image scanning. + serverlessScanning: + $ref: "#/components/schemas/ScopeConfiguration" + description: The scope configuration for serverless scanning. + ScopeConfiguration: + description: The scope of resources that Amazon Inspector scans for a single scanning type, including the scope level, the targeted resources, and the current state. + type: object + properties: + scopeType: + $ref: "#/components/schemas/ScopeType" + description: The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions. + scopeValues: + $ref: "#/components/schemas/ScopeValueList" + description: The list of scope values. For subscription-level scope, these are Azure subscription IDs. + state: + $ref: "#/components/schemas/ScopeState" + description: The current state of the scope configuration. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the current state of the scope configuration. + required: + - scopeType + ScopeState: + type: string + enum: + - ACTIVE + - PENDING + - ERROR + - DISABLED + ListCoverageMaxResults: + type: integer + minimum: 1 + maximum: 200 + CoverageFilterCriteria: + description: A structure that identifies filter criteria for GetCoverageStatistics. + type: object + properties: + scanStatusCode: + $ref: "#/components/schemas/CoverageStringFilterList" + description: "The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException." + scanStatusReason: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The scan status reason to filter on. + accountId: + $ref: "#/components/schemas/CoverageStringFilterList" + description: An array of Amazon Web Services account IDs to return coverage statistics for. + resourceId: + $ref: "#/components/schemas/CoverageStringFilterList" + description: An array of Amazon Web Services resource IDs to return coverage statistics for. + resourceType: + $ref: "#/components/schemas/CoverageStringFilterList" + description: An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT. + scanType: + $ref: "#/components/schemas/CoverageStringFilterList" + description: An array of Amazon Inspector scan types to return coverage statistics for. + ecrRepositoryName: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The Amazon ECR repository name to filter on. + ecrImageTags: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The Amazon ECR image tags to filter on. + ec2InstanceTags: + $ref: "#/components/schemas/CoverageMapFilterList" + description: The Amazon EC2 instance tags to filter on. + lambdaFunctionName: + $ref: "#/components/schemas/CoverageStringFilterList" + description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names. + lambdaFunctionTags: + $ref: "#/components/schemas/CoverageMapFilterList" + description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag. + lambdaFunctionRuntime: + $ref: "#/components/schemas/CoverageStringFilterList" + description: Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime. + lastScannedAt: + $ref: "#/components/schemas/CoverageDateFilterList" + description: Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range. + scanMode: $ref: "#/components/schemas/CoverageStringFilterList" - description: The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_AGENTLESS. + description: The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED, EC2_AGENTLESS, and EC2_INSPECTOR_AGENT_BASED. imagePulledAt: $ref: "#/components/schemas/CoverageDateFilterList" description: The date an image was last pulled at. @@ -5093,6 +5840,39 @@ components: lastScannedCommitId: $ref: "#/components/schemas/CoverageStringFilterList" description: Filter criteria for code repositories based on the ID of the last scanned commit. + cloudProvider: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud provider to filter coverage results by. + cloudProviderAccountId: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud provider account ID to filter coverage results by. + cloudProviderRegion: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud provider region to filter coverage results by. + cloudVmInstanceTags: + $ref: "#/components/schemas/CoverageMapFilterList" + description: The cloud VM instance tags to filter coverage results by. + cloudContainerImageTags: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud container image tags to filter coverage results by. + cloudContainerRepositoryName: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud container repository name to filter coverage results by. + cloudContainerRegistryName: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud container registry name to filter coverage results by. + cloudServerlessFunctionName: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud serverless function name to filter coverage results by. + cloudServerlessFunctionRuntime: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud serverless function runtime to filter coverage results by. + cloudServerlessFunctionTags: + $ref: "#/components/schemas/CoverageMapFilterList" + description: The cloud serverless function tags to filter coverage results by. + cloudProviderOrgId: + $ref: "#/components/schemas/CoverageStringFilterList" + description: The cloud provider organization ID to filter coverage results by. CoverageStringFilterList: type: array items: @@ -5212,6 +5992,21 @@ components: scanMode: $ref: "#/components/schemas/ScanMode" description: The scan method that is applied to the instance. + provider: + $ref: "#/components/schemas/Provider" + description: The cloud provider of the covered resource. + providerAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud provider account ID of the covered resource. + providerOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud provider organization ID of the covered resource. + providerRegion: + $ref: "#/components/schemas/ProviderRegion" + description: The cloud provider region of the covered resource. + providerPartition: + $ref: "#/components/schemas/ProviderPartition" + description: The cloud provider partition of the covered resource. required: - resourceType - resourceId @@ -5225,6 +6020,11 @@ components: - AWS_ECR_REPOSITORY - AWS_LAMBDA_FUNCTION - CODE_REPOSITORY + - Microsoft.Compute/virtualMachines + - Microsoft.ContainerRegistry/registry/containerImage + - Microsoft.ContainerRegistry/registry/containerRepository + - Microsoft.Web/sites + - Microsoft.ContainerRegistry/registries ScanStatus: description: The status of the scan. type: object @@ -5280,6 +6080,8 @@ components: - SCAN_IN_PROGRESS - IMAGE_ARCHIVED - UNSUPPORTED_CODE_ARTIFACTS + - RESOURCE_UNMANAGED + - RESOURCE_STOPPED ResourceScanMetadata: description: An object that contains details about the metadata for an Amazon ECR resource. type: object @@ -5299,6 +6101,21 @@ components: codeRepository: $ref: "#/components/schemas/CodeRepositoryMetadata" description: Contains metadata about scan coverage for a code repository resource. + vmInstance: + $ref: "#/components/schemas/VmInstanceMetadata" + description: The VM instance metadata associated with a covered resource. + containerImage: + $ref: "#/components/schemas/ContainerImageMetadata" + description: The container image metadata associated with a covered resource. + containerRepository: + $ref: "#/components/schemas/ContainerRepositoryMetadata" + description: The container repository metadata associated with a covered resource. + containerRegistry: + $ref: "#/components/schemas/ContainerRegistryMetadata" + description: The container registry metadata associated with a covered resource. + serverlessFunction: + $ref: "#/components/schemas/ServerlessFunctionMetadata" + description: The serverless function metadata associated with a covered resource. EcrRepositoryMetadata: description: Information on the Amazon ECR repository metadata associated with a finding. type: object @@ -5406,6 +6223,9 @@ components: - RUBY_3_2 - DOTNET_10 - NODEJS_24_X + - NODEJS_22_X + - JAVA_21 + - JAVA_25 CodeRepositoryMetadata: description: Contains metadata information about a code repository that is being scanned by Amazon Inspector. type: object @@ -5505,11 +6325,116 @@ components: description: The timestamp when the last on-demand scan was performed. scanStatus: $ref: "#/components/schemas/ScanStatus" + VmInstanceMetadata: + description: Contains metadata about a virtual machine (VM) instance associated with a covered resource. + type: object + properties: + tags: + type: object + properties: {} + description: The tags associated with the VM instance. + platform: + $ref: "#/components/schemas/VmPlatform" + description: The platform of the VM instance. + inventoryHash: + $ref: "#/components/schemas/VmInstanceMetadataInventoryHashString" + description: The inventory hash of the VM instance. + vmImageReference: + $ref: "#/components/schemas/VmInstanceMetadataVmImageReferenceString" + description: The image reference of the VM instance. + VmPlatform: + type: string + enum: + - WINDOWS + - LINUX + - UNKNOWN + VmInstanceMetadataInventoryHashString: + type: string + minLength: 0 + maxLength: 256 + VmInstanceMetadataVmImageReferenceString: + type: string + minLength: 1 + maxLength: 1024 + ContainerImageMetadata: + description: Contains metadata about a container image associated with a covered resource. + type: object + properties: + imageTags: + $ref: "#/components/schemas/TagList" + description: The tags attached to the container image. + imagePulledAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the container image was pulled. + lastInUseAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The last time the container image was in use. + inUseCount: + $ref: "#/components/schemas/Long" + description: The number of times the container image is in use. + ContainerRepositoryMetadata: + description: Contains metadata about a container repository associated with a covered resource. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the container repository. + scanFrequency: + $ref: "#/components/schemas/String" + description: The scan frequency for the container repository. + ContainerRegistryMetadata: + description: Contains metadata about a container registry associated with a covered resource. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the container registry. + ServerlessFunctionMetadata: + description: Contains metadata about a serverless function associated with a covered resource. + type: object + properties: + serverlessFunctionName: + $ref: "#/components/schemas/String" + description: The name of the serverless function. + runtime: + $ref: "#/components/schemas/String" + description: The runtime of the serverless function. + functionTags: + type: object + properties: {} + description: The tags associated with the serverless function. ScanMode: type: string enum: - EC2_SSM_AGENT_BASED - EC2_AGENTLESS + - EC2_INSPECTOR_AGENT_BASED + - VM_INSPECTOR_AGENT_BASED + Provider: + type: string + enum: + - AWS + - AZURE + ProviderAccountId: + type: string + minLength: 12 + maxLength: 36 + pattern: (\d{12}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}) + ProviderOrgId: + type: string + minLength: 12 + maxLength: 36 + pattern: (o-[a-z0-9]{10,32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}) + ProviderRegion: + type: string + minLength: 1 + maxLength: 64 + pattern: ([a-z]{2}(-[a-z]+)+-\d+|[a-z][a-z0-9]+) + ProviderPartition: + type: string + minLength: 1 + maxLength: 64 + pattern: (aws(-[a-z]+)*|Azure[A-Za-z]+) GroupKey: type: string enum: @@ -5518,6 +6443,10 @@ components: - ACCOUNT_ID - RESOURCE_TYPE - ECR_REPOSITORY_NAME + - PROVIDER + - PROVIDER_ACCOUNT_ID + - PROVIDER_REGION + - PROVIDER_ORG_ID ListCoverageStatisticsResponse: type: object properties: @@ -5662,6 +6591,9 @@ components: - AWS_LAMBDA_FUNCTION - LAMBDA_LAYER - CODE_REPOSITORY + - VM_INSTANCE + - CONTAINER_IMAGE + - SERVERLESS_FUNCTION ListFindingAggregationsMaxResults: type: integer minimum: 1 @@ -5706,6 +6638,15 @@ components: codeRepositoryAggregation: $ref: "#/components/schemas/CodeRepositoryAggregation" description: An object that contains details about an aggregation request based on code repositories. + vmInstanceAggregation: + $ref: "#/components/schemas/VmInstanceAggregation" + description: An object that contains details about an aggregation request based on virtual machine (VM) instances. + containerImageAggregation: + $ref: "#/components/schemas/ContainerImageAggregation" + description: An object that contains details about an aggregation request based on container images. + serverlessFunctionAggregation: + $ref: "#/components/schemas/ServerlessFunctionAggregation" + description: An object that contains details about an aggregation request based on serverless functions. AccountAggregation: description: An object that contains details about an aggregation response based on Amazon Web Services accounts. type: object @@ -5735,6 +6676,9 @@ components: - AWS_ECR_CONTAINER_IMAGE - AWS_LAMBDA_FUNCTION - CODE_REPOSITORY + - Microsoft.Compute/virtualMachines + - Microsoft.ContainerRegistry/registry/containerImage + - Microsoft.Web/sites SortOrder: type: string enum: @@ -5867,6 +6811,21 @@ components: layerHashes: $ref: "#/components/schemas/StringFilterList" description: The hashes associated with the layers. + cloudProviders: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud providers to aggregate findings for. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud account IDs to aggregate findings for. + cloudOrgIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud organization IDs to aggregate findings for. + cloudRegions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud regions to aggregate findings for. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudPartitions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud partitions to aggregate findings for. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." sortOrder: $ref: "#/components/schemas/SortOrder" description: The order to sort results by. @@ -5931,15 +6890,15 @@ components: resourceType: $ref: "#/components/schemas/AggregationResourceType" description: The resource type to aggregate on. + findingType: + $ref: "#/components/schemas/AggregationFindingType" + description: The type of finding to aggregate on. sortOrder: $ref: "#/components/schemas/SortOrder" description: The order to sort results by. sortBy: $ref: "#/components/schemas/TitleSortBy" description: The value to sort results by. - findingType: - $ref: "#/components/schemas/AggregationFindingType" - description: The type of finding to aggregate on. TitleSortBy: type: string enum: @@ -6024,6 +6983,148 @@ components: - CRITICAL - HIGH - ALL + VmInstanceAggregation: + description: An aggregation of information about VM instances. + type: object + properties: + resourceIds: + $ref: "#/components/schemas/StringFilterList" + description: The resource IDs to aggregate findings for. + operatingSystems: + $ref: "#/components/schemas/StringFilterList" + description: The operating systems to aggregate findings for. + instanceTags: + $ref: "#/components/schemas/MapFilterList" + description: The instance tags to aggregate findings for. + vmImageReferences: + $ref: "#/components/schemas/StringFilterList" + description: The VM image references to aggregate findings for. + cloudProviders: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud providers to aggregate findings for. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudPartitions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud partitions to aggregate findings for. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud regions to aggregate findings for. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud organization IDs to aggregate findings for. + cloudAccountIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud account IDs to aggregate findings for. + sortOrder: + $ref: "#/components/schemas/SortOrder" + description: The order to sort results by. Valid values are ASC and DESC. + sortBy: + $ref: "#/components/schemas/VmInstanceSortBy" + description: The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, ALL, or NETWORK_FINDINGS. + VmInstanceSortBy: + type: string + enum: + - CRITICAL + - HIGH + - ALL + - NETWORK_FINDINGS + ContainerImageAggregation: + description: An aggregation of information about container images. + type: object + properties: + resourceIds: + $ref: "#/components/schemas/StringFilterList" + description: The resource IDs to aggregate findings for. + imageDigests: + $ref: "#/components/schemas/StringFilterList" + description: The image digests to aggregate findings for. + repositories: + $ref: "#/components/schemas/StringFilterList" + description: The image repositories to aggregate findings for. + registries: + $ref: "#/components/schemas/StringFilterList" + description: The image registries to aggregate findings for. + architectures: + $ref: "#/components/schemas/StringFilterList" + description: The image architectures to aggregate findings for. + imageTags: + $ref: "#/components/schemas/StringFilterList" + description: The image tags to aggregate findings for. + cloudProviders: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud providers to aggregate findings for. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudPartitions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud partitions to aggregate findings for. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud regions to aggregate findings for. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud organization IDs to aggregate findings for. + cloudAccountIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud account IDs to aggregate findings for. + lastInUseAt: + $ref: "#/components/schemas/DateFilterList" + description: The last in-use timestamps to aggregate findings for. + inUseCount: + $ref: "#/components/schemas/NumberFilterList" + description: The in-use counts to aggregate findings for. + sortOrder: + $ref: "#/components/schemas/SortOrder" + description: The order to sort results by. Valid values are ASC and DESC. + sortBy: + $ref: "#/components/schemas/ContainerImageSortBy" + description: The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL. + ContainerImageSortBy: + type: string + enum: + - CRITICAL + - HIGH + - ALL + ServerlessFunctionAggregation: + description: An aggregation of information about serverless functions. + type: object + properties: + resourceIds: + $ref: "#/components/schemas/StringFilterList" + description: The resource IDs to aggregate findings for. + functionNames: + $ref: "#/components/schemas/StringFilterList" + description: The function names to aggregate findings for. + runtimes: + $ref: "#/components/schemas/StringFilterList" + description: The runtimes to aggregate findings for. + functionTags: + $ref: "#/components/schemas/MapFilterList" + description: The function tags to aggregate findings for. + cloudProviders: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud providers to aggregate findings for. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudPartitions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud partitions to aggregate findings for. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegions: + $ref: "#/components/schemas/StringFilterList" + description: "The cloud regions to aggregate findings for. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud organization IDs to aggregate findings for. + cloudAccountIds: + $ref: "#/components/schemas/StringFilterList" + description: The cloud account IDs to aggregate findings for. + sortOrder: + $ref: "#/components/schemas/SortOrder" + description: The order to sort results by. Valid values are ASC and DESC. + sortBy: + $ref: "#/components/schemas/ServerlessFunctionSortBy" + description: The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL. + ServerlessFunctionSortBy: + type: string + enum: + - CRITICAL + - HIGH + - ALL ListFindingAggregationsResponse: type: object properties: @@ -6082,6 +7183,15 @@ components: codeRepositoryAggregation: $ref: "#/components/schemas/CodeRepositoryAggregationResponse" description: An object that contains details about an aggregation response based on code repositories. + vmInstanceAggregation: + $ref: "#/components/schemas/VmInstanceAggregationResponse" + description: An object that contains details about an aggregation response based on VM instances. + containerImageAggregation: + $ref: "#/components/schemas/ContainerImageAggregationResponse" + description: An object that contains details about an aggregation response based on container images. + serverlessFunctionAggregation: + $ref: "#/components/schemas/ServerlessFunctionAggregationResponse" + description: An object that contains details about an aggregation response based on serverless functions. AccountAggregationResponse: description: An aggregation of findings by Amazon Web Services account ID. type: object @@ -6124,6 +7234,21 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: The Amazon Web Services account ID for the AMI. + cloudProvider: + $ref: "#/components/schemas/Provider" + description: "The cloud service provider associated with this Amazon Machine Image (AMI) aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudPartition: + $ref: "#/components/schemas/ProviderPartition" + description: "The cloud infrastructure partition associated with this AMI aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegion: + $ref: "#/components/schemas/ProviderRegion" + description: "The cloud Region associated with this AMI aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud organization ID for the AMI aggregation. + cloudAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud account ID for the AMI aggregation. severityCounts: $ref: "#/components/schemas/SeverityCounts" description: An object that contains the count of matched findings per severity. @@ -6213,6 +7338,21 @@ components: fixAvailableCount: $ref: "#/components/schemas/Long" description: Details about the number of fixes. + cloudProvider: + $ref: "#/components/schemas/String" + description: "The cloud service provider associated with this finding type aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountId: + $ref: "#/components/schemas/String" + description: The cloud account ID for the finding type aggregation. + cloudOrgId: + $ref: "#/components/schemas/String" + description: The cloud organization ID for the finding type aggregation. + cloudRegion: + $ref: "#/components/schemas/String" + description: "The cloud Region associated with this finding type aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudPartition: + $ref: "#/components/schemas/String" + description: "The cloud infrastructure partition associated with this finding type aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." ImageLayerAggregationResponse: description: A response that contains the results of a finding aggregation by image layer. type: object @@ -6229,6 +7369,21 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: The ID of the Amazon Web Services account that owns the container image hosting the layer image. + cloudProvider: + $ref: "#/components/schemas/String" + description: "The cloud service provider associated with this image layer aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountId: + $ref: "#/components/schemas/String" + description: The cloud account ID for the image layer aggregation. + cloudOrgId: + $ref: "#/components/schemas/String" + description: The cloud organization ID for the image layer aggregation. + cloudRegion: + $ref: "#/components/schemas/String" + description: "The cloud Region associated with this image layer aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudPartition: + $ref: "#/components/schemas/String" + description: "The cloud infrastructure partition associated with this image layer aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." severityCounts: $ref: "#/components/schemas/SeverityCounts" description: An object that represents the count of matched findings per severity. @@ -6262,6 +7417,21 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: The ID of the Amazon Web Services account associated with the findings. + cloudProvider: + $ref: "#/components/schemas/Provider" + description: "The cloud service provider associated with this repository aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudPartition: + $ref: "#/components/schemas/ProviderPartition" + description: "The cloud infrastructure partition associated with this repository aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegion: + $ref: "#/components/schemas/ProviderRegion" + description: "The cloud Region associated with this repository aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud organization ID for the repository aggregation. + cloudAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud account ID for the repository aggregation. severityCounts: $ref: "#/components/schemas/SeverityCounts" description: An object that represent the count of matched findings per severity. @@ -6366,6 +7536,158 @@ components: description: The resource ID of the code repository. required: - projectNames + VmInstanceAggregationResponse: + description: A response that contains the results of a VM instance aggregation. + type: object + properties: + resourceId: + $ref: "#/components/schemas/NonEmptyString" + description: The resource ID for the VM instance. + cloudProvider: + $ref: "#/components/schemas/Provider" + description: "The cloud service provider associated with this VM instance aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud account ID for the VM instance aggregation. + cloudPartition: + $ref: "#/components/schemas/ProviderPartition" + description: "The cloud infrastructure partition associated with this VM instance aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegion: + $ref: "#/components/schemas/ProviderRegion" + description: "The cloud Region associated with this VM instance aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud organization ID for the VM instance aggregation. + vmImageReference: + $ref: "#/components/schemas/String" + description: The VM image reference for the VM instance. + operatingSystem: + $ref: "#/components/schemas/String" + description: The operating system of the VM instance. + tags: + type: object + properties: {} + description: The tags attached to the VM instance. + accountId: + $ref: "#/components/schemas/String" + description: The account ID associated with the VM instance. + severityCounts: + $ref: "#/components/schemas/SeverityCounts" + networkFindings: + $ref: "#/components/schemas/Long" + description: The number of network findings for the VM instance. This field applies only to Amazon Web Services resources. + exploitAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with an exploit available for the VM instance. + fixAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with a fix available for the VM instance. + required: + - resourceId + ContainerImageAggregationResponse: + description: A response that contains the results of a container image aggregation. + type: object + properties: + resourceId: + $ref: "#/components/schemas/NonEmptyString" + description: The resource ID for the container image. + cloudProvider: + $ref: "#/components/schemas/Provider" + description: "The cloud service provider associated with this container image aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud account ID for the container image aggregation. + cloudPartition: + $ref: "#/components/schemas/ProviderPartition" + description: "The cloud infrastructure partition associated with this container image aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegion: + $ref: "#/components/schemas/ProviderRegion" + description: "The cloud Region associated with this container image aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud organization ID for the container image aggregation. + imageDigest: + $ref: "#/components/schemas/String" + description: The image digest for the container image. + repository: + $ref: "#/components/schemas/String" + description: The repository for the container image. + registry: + $ref: "#/components/schemas/String" + description: The registry for the container image. + architecture: + $ref: "#/components/schemas/String" + description: The architecture of the container image. + imageTags: + $ref: "#/components/schemas/StringList" + description: The image tags attached to the container image. + accountId: + $ref: "#/components/schemas/String" + description: The account ID associated with the container image. + severityCounts: + $ref: "#/components/schemas/SeverityCounts" + lastInUseAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The last time the container image was in use. + inUseCount: + $ref: "#/components/schemas/Long" + description: The number of times the container image is in use. + exploitAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with an exploit available for the container image. + fixAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with a fix available for the container image. + required: + - resourceId + ServerlessFunctionAggregationResponse: + description: A response that contains the results of a serverless function aggregation. + type: object + properties: + resourceId: + $ref: "#/components/schemas/NonEmptyString" + description: The resource ID for the serverless function. + cloudProvider: + $ref: "#/components/schemas/Provider" + description: "The cloud service provider associated with this serverless function aggregation. Valid values: AWS – Findings from Amazon Web Services resources. AZURE – Findings from Microsoft Azure resources." + cloudAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud account ID for the serverless function aggregation. + cloudPartition: + $ref: "#/components/schemas/ProviderPartition" + description: "The cloud infrastructure partition associated with this serverless function aggregation. Valid values: aws – Amazon Web Services commercial Regions. aws-cn – Amazon Web Services China Regions. aws-us-gov – Amazon Web Services GovCloud (US) Regions. AzureCloud – Azure commercial Regions." + cloudRegion: + $ref: "#/components/schemas/ProviderRegion" + description: "The cloud Region associated with this serverless function aggregation. The value format depends on the cloud provider: An Amazon Web Services Region, such as us-east-1. An Azure region, such as eastus." + cloudOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud organization ID for the serverless function aggregation. + functionName: + $ref: "#/components/schemas/String" + description: The name of the serverless function. + runtime: + $ref: "#/components/schemas/String" + description: The runtime of the serverless function. + tags: + type: object + properties: {} + description: The tags attached to the serverless function. + accountId: + $ref: "#/components/schemas/String" + description: The account ID associated with the serverless function. + severityCounts: + $ref: "#/components/schemas/SeverityCounts" + lastModifiedAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the serverless function was last modified. + exploitAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with an exploit available for the serverless function. + fixAvailableActiveFindingsCount: + $ref: "#/components/schemas/Long" + description: The number of active findings with a fix available for the serverless function. + required: + - resourceId ListFindingsMaxResults: type: integer minimum: 1 @@ -6567,6 +7889,15 @@ components: details: $ref: "#/components/schemas/ResourceDetails" description: An object that contains details about the resource involved in a finding. + provider: + $ref: "#/components/schemas/Provider" + description: The cloud provider of the resource. + providerAccountId: + $ref: "#/components/schemas/ProviderAccountId" + description: The cloud provider account ID of the resource. + providerOrgId: + $ref: "#/components/schemas/ProviderOrgId" + description: The cloud provider organization ID of the resource. required: - type_ - id @@ -6586,6 +7917,15 @@ components: codeRepository: $ref: "#/components/schemas/CodeRepositoryDetails" description: Contains details about a code repository resource associated with a finding. + vm: + $ref: "#/components/schemas/Vm" + description: An object that contains details about a VM instance involved in the finding. + image: + $ref: "#/components/schemas/Image" + description: An object that contains details about a container image involved in the finding. + serverlessFunction: + $ref: "#/components/schemas/ServerlessFunction" + description: An object that contains details about a serverless function involved in the finding. AwsEc2InstanceDetails: description: Details of the Amazon EC2 instance involved in a finding. type: object @@ -6810,6 +8150,139 @@ components: enum: - GITHUB - GITLAB_SELF_MANAGED + Vm: + description: Contains details about a VM instance involved in a finding. + type: object + properties: + type_: + $ref: "#/components/schemas/NonEmptyString" + description: The type of the VM instance. + vmName: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the VM instance. + vmImageReference: + $ref: "#/components/schemas/NonEmptyString" + description: The image reference of the VM instance. + ipV4Addresses: + $ref: "#/components/schemas/IpV4AddressList" + description: The IPv4 addresses of the VM instance. + ipV6Addresses: + $ref: "#/components/schemas/IpV6AddressList" + description: The IPv6 addresses of the VM instance. + networkId: + $ref: "#/components/schemas/NonEmptyString" + description: The network ID associated with the VM instance. + subnetIds: + $ref: "#/components/schemas/CloudSubnetIdList" + description: The subnet IDs of the VM instance. + securityGroupIds: + $ref: "#/components/schemas/CloudSecurityGroupIdList" + description: The security group IDs associated with the VM instance. + launchedAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the VM instance was launched. + platform: + $ref: "#/components/schemas/Platform" + description: The platform of the VM instance. + executionRole: + $ref: "#/components/schemas/NonEmptyString" + description: The execution role of the VM instance. + keyName: + $ref: "#/components/schemas/NonEmptyString" + description: The key name associated with the VM instance. + CloudSubnetIdList: + type: array + items: + $ref: "#/components/schemas/NonEmptyString" + CloudSecurityGroupIdList: + type: array + items: + $ref: "#/components/schemas/NonEmptyString" + Image: + description: Contains details about a container image involved in a finding. + type: object + properties: + repositoryName: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the repository the container image resides in. + registry: + $ref: "#/components/schemas/NonEmptyString" + description: The registry for the container image. + imageTags: + $ref: "#/components/schemas/ImageTagList" + description: The image tags attached to the container image. + imageDigest: + $ref: "#/components/schemas/NonEmptyString" + description: The image digest of the container image. + pushedAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the container image was pushed. + architecture: + $ref: "#/components/schemas/NonEmptyString" + description: The architecture of the container image. + author: + $ref: "#/components/schemas/String" + description: The author of the container image. + inUseCount: + $ref: "#/components/schemas/ImageInUseCountLong" + description: The number of times the container image is in use. + lastInUseAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The last time the container image was in use. + platform: + $ref: "#/components/schemas/Platform" + description: The platform of the container image. + ImageInUseCountLong: + type: integer + format: int64 + minimum: 0 + ServerlessFunction: + description: Contains details about a serverless function involved in a finding. + type: object + properties: + serverlessFunctionName: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the serverless function. + runtime: + $ref: "#/components/schemas/NonEmptyString" + description: The runtime of the serverless function. + version: + $ref: "#/components/schemas/NonEmptyString" + description: The version of the serverless function. + codeDigest: + $ref: "#/components/schemas/NonEmptyString" + description: The code digest of the serverless function. + lastModifiedAt: + $ref: "#/components/schemas/DateTimeTimestamp" + description: The date and time the serverless function was last modified. + networkId: + $ref: "#/components/schemas/NonEmptyString" + description: The network ID associated with the serverless function. + subnetIds: + $ref: "#/components/schemas/CloudSubnetIdList" + description: The subnet IDs associated with the serverless function. + securityGroupIds: + $ref: "#/components/schemas/CloudSecurityGroupIdList" + description: The security group IDs associated with the serverless function. + executionRole: + $ref: "#/components/schemas/NonEmptyString" + description: The execution role of the serverless function. + packageType: + $ref: "#/components/schemas/PackageType" + description: The package type of the serverless function. + architectures: + $ref: "#/components/schemas/ArchitectureList" + description: The architectures of the serverless function. + layers: + $ref: "#/components/schemas/ServerlessFunctionLayerList" + description: The layers of the serverless function. + ServerlessFunctionLayerList: + type: array + items: + $ref: "#/components/schemas/ServerlessFunctionLayerUrn" + ServerlessFunctionLayerUrn: + type: string + pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+ InspectorScoreDetails: description: Information about the Amazon Inspector score given to a finding. type: object @@ -7280,6 +8753,9 @@ components: currency: $ref: "#/components/schemas/Currency" description: The currency type used when calculating usage data. + cloudProvider: + $ref: "#/components/schemas/CloudProvider" + description: The cloud provider associated with the usage information. UsageType: type: string enum: @@ -7292,6 +8768,10 @@ components: - CODE_REPOSITORY_IAC - CODE_REPOSITORY_SCA - EC2_AGENTLESS_INSTANCE_HOURS + - AZURE_CONTAINER_IMAGE_INITIAL_SCAN + - AZURE_CONTAINER_IMAGE_RESCAN + - AZURE_VM_AGENT_BASED_INSTANCE_HOURS + - AZURE_SERVERLESS_FUNCTION_HOURS UsageValue: type: number format: double @@ -7788,10 +9268,56 @@ components: scanMode: $ref: "#/components/schemas/Ec2ScanMode" description: The scan method that is applied to the instance. + activateVMScanner: + $ref: "#/components/schemas/Boolean" + description: Whether to activate Amazon Inspector VM scanner for Amazon EC2 scanning. required: - scanMode + UpdateConfigurationInheritance: + description: The per-scan-type inheritance reset settings for the UpdateConfiguration operation. Each member is independently optional. Including a member in this structure resets that scan type's configuration to inherit from the delegated administrator. + type: object + properties: + ec2Configuration: + $ref: "#/components/schemas/InheritanceMode" + description: The inheritance mode for Amazon EC2 scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account's Amazon EC2 scan configuration to inherit from the delegated administrator. If omitted, the member account's existing Amazon EC2 scan configuration is not changed. + ecrConfiguration: + $ref: "#/components/schemas/InheritanceMode" + description: The inheritance mode for Amazon ECR scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account's Amazon ECR scan configuration to inherit from the delegated administrator. If omitted, the member account's existing Amazon ECR scan configuration is not changed. + InheritanceMode: + description: The inheritance behavior for a scan-type configuration. Used with UpdateConfigurationInheritance to reset a member account's configuration to inherit from the delegated administrator. The only valid value is INHERIT_FROM_ADMIN, which resets the member account's configuration so that it inherits scan settings from the delegated administrator. + type: string + enum: + - INHERIT_FROM_ADMIN UpdateConfigurationResponse: type: object + ProviderDetailUpdate: + description: The provider-specific configuration details for updating a connector. + type: object + properties: + azure: + $ref: "#/components/schemas/AzureProviderDetailUpdate" + description: The Azure-specific details for updating a connector. + AzureProviderDetailUpdate: + description: The Azure-specific configuration details for updating a connector, including the scan scope and regions to scan. + type: object + properties: + azureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The updated Azure regions to scan. + scopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfigurationInput" + description: The updated scope configuration that defines which Azure resources to scan. + autoInstallVMScanner: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to automatically install the VM scanner on connected Azure resources. + UpdateConnectorResponse: + type: object + properties: + connectorArn: + $ref: "#/components/schemas/ConnectorArn" + description: The Amazon Resource Name (ARN) of the updated connector. + UpdateConnectorScanConfigurationResponse: + type: object UpdateEc2DeepInspectionConfigurationResponse: type: object properties: @@ -8268,6 +9794,72 @@ components: - $ref: "#/components/x-stackQL-resources/code_security_scan_configurations/methods/update_code_security_scan_configuration" delete: - $ref: "#/components/x-stackQL-resources/code_security_scan_configurations/methods/delete_code_security_scan_configuration" + connectors: + id: aws.inspector2.connectors + name: connectors + title: connectors + methods: + create_connector: + operation: + $ref: "#/paths/~1connector~1create/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_connector: + operation: + $ref: "#/paths/~1connector~1delete/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_connectors: + operation: + $ref: "#/paths/~1connector~1list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_connector: + operation: + $ref: "#/paths/~1connector~1update/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/connectors/methods/list_connectors" + insert: + - $ref: "#/components/x-stackQL-resources/connectors/methods/create_connector" + update: + - $ref: "#/components/x-stackQL-resources/connectors/methods/update_connector" + delete: + - $ref: "#/components/x-stackQL-resources/connectors/methods/delete_connector" filters: id: aws.inspector2.filters name: filters @@ -8571,6 +10163,11 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive update_configuration: operation: $ref: "#/paths/~1configuration~1update/post" @@ -8825,6 +10422,48 @@ components: insert: [] update: [] delete: [] + connector_scan_configurations: + id: aws.inspector2.connector_scan_configurations + name: connector_scan_configurations + title: connector_scan_configurations + methods: + list_connector_scan_configurations: + operation: + $ref: "#/paths/~1connectorscanconfigurations~1list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.scanConfigurations + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_connector_scan_configuration: + operation: + $ref: "#/paths/~1connectorscanconfiguration~1update/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/connector_scan_configurations/methods/list_connector_scan_configurations" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/connector_scan_configurations/methods/update_connector_scan_configuration" + delete: [] coverages: id: aws.inspector2.coverages name: coverages diff --git a/providers/src/aws/v00.00.00000/services/invoicing.yaml b/providers/src/aws/v00.00.00000/services/invoicing.yaml index 14181435..59870ee4 100644 --- a/providers/src/aws/v00.00.00000/services/invoicing.yaml +++ b/providers/src/aws/v00.00.00000/services/invoicing.yaml @@ -90,6 +90,9 @@ paths: ResourceTags: $ref: "#/components/schemas/ResourceTagList" description: The tag structure that contains a tag key and value. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - InvoiceReceiver responses: @@ -204,6 +207,9 @@ paths: InvoiceUnitArn: $ref: "#/components/schemas/InvoiceUnitArnString" description: The ARN to identify an invoice unit. This information can't be modified or deleted. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - InvoiceUnitArn responses: @@ -237,6 +243,9 @@ paths: ProcurementPortalPreferenceArn: $ref: "#/components/schemas/ProcurementPortalPreferenceArnString" description: The Amazon Resource Name (ARN) of the procurement portal preference to delete. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - ProcurementPortalPreferenceArn responses: @@ -377,7 +386,7 @@ paths: description: Filters you can use to customize your invoice summary. NextToken: $ref: "#/components/schemas/NextTokenString" - description: The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. + description: The token for the next set of results. (You received this token from a previous call.) MaxResults: $ref: "#/components/schemas/InvoiceSummariesMaxResults" description: The maximum number of invoice summaries a paginated response can contain. @@ -544,6 +553,9 @@ paths: Contacts: $ref: "#/components/schemas/Contacts" description: Updated list of contact information for portal administrators and technical contacts. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - ProcurementPortalPreferenceArn - EinvoiceDeliveryEnabled @@ -556,6 +568,42 @@ paths: application/json: schema: $ref: "#/components/schemas/PutProcurementPortalPreferenceResponse" + /SendProcurementPortalValidation: + post: + operationId: SendProcurementPortalValidation + description: This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Sends a validation request for a procurement portal preference. This operation initiates the validation process by issuing a validation code that confirms ownership and connectivity of the configured procurement portal endpoint. Use VerifyProcurementPortalValidation to submit the received code and complete validation. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Invoicing.SendProcurementPortalValidation + default: Invoicing.SendProcurementPortalValidation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProcurementPortalPreferenceArn: + $ref: "#/components/schemas/ProcurementPortalPreferenceArnString" + description: The Amazon Resource Name (ARN) of the procurement portal preference to validate. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. + required: + - ProcurementPortalPreferenceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SendProcurementPortalValidationResponse" /TagResource: post: operationId: TagResource @@ -663,6 +711,9 @@ paths: Rule: $ref: "#/components/schemas/InvoiceUnitRule" description: The InvoiceUnitRule object used to update invoice units. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - InvoiceUnitArn responses: @@ -708,6 +759,9 @@ paths: PurchaseOrderRetrievalPreferenceStatusReason: $ref: "#/components/schemas/BasicString" description: The reason for the purchase order retrieval preference status update, providing context for the change. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. required: - ProcurementPortalPreferenceArn responses: @@ -717,6 +771,46 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateProcurementPortalPreferenceStatusResponse" + /VerifyProcurementPortalValidation: + post: + operationId: VerifyProcurementPortalValidation + description: This feature API is subject to changing at any time. For more information, see the Amazon Web Services Service Terms (Betas and Previews). Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling SendProcurementPortalValidation to confirm ownership and connectivity of the configured procurement portal endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Invoicing.VerifyProcurementPortalValidation + default: Invoicing.VerifyProcurementPortalValidation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ProcurementPortalPreferenceArn: + $ref: "#/components/schemas/ProcurementPortalPreferenceArnString" + description: The Amazon Resource Name (ARN) of the procurement portal preference to validate. + Code: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: The validation code received from the procurement portal in response to a previous SendProcurementPortalValidation request. + ClientToken: + $ref: "#/components/schemas/BasicStringWithoutSpace" + description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request. + required: + - ProcurementPortalPreferenceArn + - Code + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/VerifyProcurementPortalValidationResponse" components: parameters: X-Amz-Content-Sha256: @@ -1305,6 +1399,7 @@ components: type: string enum: - PENDING_VERIFICATION + - VALIDATED - TEST_INITIALIZED - TEST_INITIALIZATION_FAILED - TEST_FAILED @@ -1403,7 +1498,7 @@ components: description: List of key (summary level) invoice details without line item details. NextToken: $ref: "#/components/schemas/NextTokenString" - description: The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. + description: The token to use to retrieve the next set of results, or null if there are no more results. required: - InvoiceSummaries InvoiceSummaries: @@ -1820,6 +1915,14 @@ components: description: The Amazon Resource Name (ARN) of the updated procurement portal preference. required: - ProcurementPortalPreferenceArn + SendProcurementPortalValidationResponse: + type: object + properties: + ProcurementPortalPreferenceArn: + $ref: "#/components/schemas/ProcurementPortalPreferenceArnString" + description: The Amazon Resource Name (ARN) of the procurement portal preference for which the validation request was sent. + required: + - ProcurementPortalPreferenceArn TagResourceResponse: type: object ResourceTagKeyList: @@ -1842,6 +1945,14 @@ components: description: The Amazon Resource Name (ARN) of the procurement portal preference with updated status. required: - ProcurementPortalPreferenceArn + VerifyProcurementPortalValidationResponse: + type: object + properties: + ProcurementPortalPreferenceArn: + $ref: "#/components/schemas/ProcurementPortalPreferenceArnString" + description: The Amazon Resource Name (ARN) of the procurement portal preference for which validation was completed. + required: + - ProcurementPortalPreferenceArn x-stackQL-resources: invoice_profiles: id: aws.invoicing.invoice_profiles @@ -2034,6 +2145,19 @@ components: config: requestBodyTranslate: algorithm: naive + send_procurement_portal_validation: + operation: + $ref: "#/paths/~1SendProcurementPortalValidation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive update_procurement_portal_preference_status: operation: $ref: "#/paths/~1UpdateProcurementPortalPreferenceStatus/post" @@ -2047,6 +2171,19 @@ components: config: requestBodyTranslate: algorithm: naive + verify_procurement_portal_validation: + operation: + $ref: "#/paths/~1VerifyProcurementPortalValidation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/procurement_portal_preferences/methods/get_procurement_portal_preference" diff --git a/providers/src/aws/v00.00.00000/services/iot.yaml b/providers/src/aws/v00.00.00000/services/iot.yaml index 1a9edf78..c6038def 100644 --- a/providers/src/aws/v00.00.00000/services/iot.yaml +++ b/providers/src/aws/v00.00.00000/services/iot.yaml @@ -4841,7 +4841,7 @@ paths: /things/{thing_name}/connectivity-data: post: operationId: GetThingConnectivityData - description: Retrieves the live connectivity status per device. + description: Retrieves the live connectivity status per device. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's thingConnectivityIndexingMode was enabled, the response will have the connected field set to false with no additional session details. parameters: - name: thing_name in: path @@ -4849,6 +4849,15 @@ paths: schema: $ref: "#/components/schemas/ConnectivityApiThingName" description: The name of your IoT thing. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + includeSocketInformation: + $ref: "#/components/schemas/Boolean" responses: "200": description: Success @@ -7245,7 +7254,7 @@ paths: /indices/search: post: operationId: SearchIndex - description: The query search index. Requires permission to access the SearchIndex action. + description: Searches the specified index. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's thingConnectivityIndexingMode was enabled, the connectivity object for this device in the response will have the connected field set to false with no additional session details. Requires permission to access the SearchIndex action. parameters: [] requestBody: required: true @@ -10857,7 +10866,7 @@ components: description: Maximum size of a message batch, in bytes. batchAcrossTopics: $ref: "#/components/schemas/BatchAcrossTopics" - description: Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false. + description: "Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false. When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic. Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the batchAcrossTopics setting." MaxBatchOpenMs: type: integer minimum: 5 @@ -13238,6 +13247,9 @@ components: geoLocations: $ref: "#/components/schemas/GeoLocationsFilter" description: The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference. + connectivity: + $ref: "#/components/schemas/ConnectivityFilter" + description: Provides additional connectivity filter selections for the fleet indexing configuration. NamedShadowNamesFilter: type: array items: @@ -13268,6 +13280,21 @@ components: enum: - LatLon - LonLat + ConnectivityFilter: + description: Provides connectivity filter selections for the fleet indexing configuration. + type: object + properties: + includeSocketInformation: + $ref: "#/components/schemas/FleetIndexingApiList" + description: A list of fleet indexing APIs for which to enable socket information retrieval. Currently, the only supported value is GET_THING_CONNECTIVITY_DATA. + FleetIndexingApiList: + type: array + items: + $ref: "#/components/schemas/FleetIndexingApi" + FleetIndexingApi: + type: string + enum: + - GET_THING_CONNECTIVITY_DATA ThingGroupIndexingConfiguration: description: Thing group indexing configuration. type: object @@ -13627,10 +13654,37 @@ components: description: A Boolean that indicates the connectivity status. timestamp: $ref: "#/components/schemas/Timestamp" - description: The timestamp of when the event occurred. + description: The timestamp of when the device connected or disconnected. disconnectReason: $ref: "#/components/schemas/DisconnectReasonValue" - description: The reason why the client is disconnecting. + description: The reason that the client is disconnected. + sourceIp: + $ref: "#/components/schemas/SourceIp" + description: The IP address of the client that initiated the connection. + sourcePort: + $ref: "#/components/schemas/SourcePort" + description: The client's source port. + targetIp: + $ref: "#/components/schemas/TargetIp" + description: The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. + targetPort: + $ref: "#/components/schemas/TargetPort" + description: The port number of the Amazon Web Services IoT Core endpoint that the client connected to. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint. + keepAliveDuration: + $ref: "#/components/schemas/KeepAliveDuration" + description: The keep-alive interval in seconds that the client specified when establishing the connection. + cleanSession: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the client is using a clean session. Returns true for clean sessions. + sessionExpiry: + $ref: "#/components/schemas/SessionExpiry" + description: The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects. + clientId: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client. DisconnectReasonValue: type: string enum: @@ -13643,11 +13697,27 @@ components: - MQTT_KEEP_ALIVE_TIMEOUT - SERVER_ERROR - SERVER_INITIATED_DISCONNECT + - API_INITIATED_DISCONNECT - THROTTLED - WEBSOCKET_TTL_EXPIRATION - CUSTOMAUTH_TTL_EXPIRATION - UNKNOWN - NONE + SourceIp: + type: string + SourcePort: + type: integer + TargetIp: + type: string + TargetPort: + type: integer + VpcEndpointId: + type: string + KeepAliveDuration: + type: integer + SessionExpiry: + type: integer + format: int64 GetTopicRuleResponse: description: The output from the GetTopicRule operation. type: object @@ -15628,10 +15698,22 @@ components: description: True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected. timestamp: $ref: "#/components/schemas/ConnectivityTimestamp" - description: The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing. + description: The epoch time (in milliseconds) when the thing last connected or disconnected. disconnectReason: $ref: "#/components/schemas/DisconnectReason" - description: The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing. + description: The reason that the client is disconnected. + keepAliveDuration: + $ref: "#/components/schemas/KeepAliveDuration" + description: The keep-alive interval in seconds that the client specified when establishing the connection. + cleanSession: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the client is using a clean session. Returns true for clean sessions. + sessionExpiry: + $ref: "#/components/schemas/SessionExpiry" + description: The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects. + clientId: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client. ConnectivityTimestamp: type: integer format: int64 @@ -19351,6 +19433,11 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/thing_connectivity_datas/methods/get_thing_connectivity_data" diff --git a/providers/src/aws/v00.00.00000/services/iot_data.yaml b/providers/src/aws/v00.00.00000/services/iot_data.yaml index 3e08f4a2..d23ca1e4 100644 --- a/providers/src/aws/v00.00.00000/services/iot_data.yaml +++ b/providers/src/aws/v00.00.00000/services/iot_data.yaml @@ -19,29 +19,52 @@ paths: /connections/{client_id}: delete: operationId: DeleteConnection - description: Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state. + description: Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state. Requires permission to access the DeleteConnection action. parameters: - name: client_id in: path required: true schema: $ref: "#/components/schemas/ClientId" - description: The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($). + description: The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. - name: cleanSession in: query required: false schema: $ref: "#/components/schemas/CleanSession" - description: Specifies whether to remove the client's session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state). + description: Specifies whether to remove the client's persistent session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to FALSE (preserves the session state). - name: preventWillMessage in: query required: false schema: $ref: "#/components/schemas/PreventWillMessage" - description: Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message). + description: Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to ensure that LWT is published. By default, this is set to FALSE (LWT message is published). responses: "200": description: Success + get: + operationId: GetConnection + description: Retrieves connection information for the specified MQTT client. Requires permission to access the GetConnection action. + parameters: + - name: client_id + in: path + required: true + schema: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client to retrieve connection information. The client ID can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. + - name: includeSocketInformation + in: query + required: false + schema: + $ref: "#/components/schemas/IncludeSocketInformation" + description: Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetConnectionResponse" /things/{thing_name}/shadow: delete: operationId: DeleteThingShadow @@ -195,6 +218,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListRetainedMessagesResponse" + /connections/{client_id}/subscriptions: + get: + operationId: ListSubscriptions + description: Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions. Requires permission to access the ListSubscriptions action. + parameters: + - name: client_id + in: path + required: true + schema: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of subscriptions to return in a single request. By default, this is set to 20. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSubscriptionsResponse" /topics/{topic}: post: operationId: Publish @@ -266,6 +319,81 @@ paths: responses: "200": description: Success + /connections/{client_id}/messages: + post: + operationId: SendDirectMessage + description: Sends an MQTT message directly to a specific client identified by its client ID. SendDirectMessage targets a single client ID. The receiving client does not need to subscribe to the topic, but the receiver's policy must allow iot:Receive on the specified topic. Requires permission to access the SendDirectMessage action. For more information about messaging costs, see Amazon Web Services IoT Core pricing. + parameters: + - name: client_id + in: path + required: true + schema: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client to send the message to. Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas. + - name: topic + in: query + required: true + schema: + $ref: "#/components/schemas/Topic" + description: The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas. + - name: contentType + in: query + required: false + schema: + $ref: "#/components/schemas/ContentType" + description: The MQTT5 content type property forwarded to the receiving client (for example, application/json). + - name: responseTopic + in: query + required: false + schema: + $ref: "#/components/schemas/ResponseTopic" + description: A UTF-8 encoded string that's used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas. + - name: confirmation + in: query + required: false + schema: + $ref: "#/components/schemas/Confirmation" + description: "A Boolean value that specifies whether to wait for delivery confirmation from the receiving client. When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504. When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message. Valid values: true | false Default value: false" + - name: timeout + in: query + required: false + schema: + $ref: "#/components/schemas/TimeoutInSeconds" + description: "An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored. The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter. Valid range: 1 to 15 seconds. Default value: 5 seconds." + - name: x-amz-mqtt5-user-properties + in: header + required: false + schema: + $ref: "#/components/schemas/UserProperties" + description: "A JSON string that contains an array of JSON objects. If you don't use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API. For MQTT 3.1.1 clients, user properties are silently dropped. The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded: [{\"deviceName\": \"alpha\"}, {\"deviceCnt\": \"45\"}]" + - name: x-amz-mqtt5-payload-format-indicator + in: header + required: false + schema: + $ref: "#/components/schemas/PayloadFormatIndicator" + description: An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API. + - name: x-amz-mqtt5-correlation-data + in: header + required: false + schema: + $ref: "#/components/schemas/CorrelationData" + description: The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + payload: + $ref: "#/components/schemas/Payload" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SendDirectMessageResponse" components: parameters: X-Amz-Content-Sha256: @@ -342,6 +470,75 @@ components: JsonDocument: type: string format: byte + IncludeSocketInformation: + type: boolean + GetConnectionResponse: + type: object + properties: + connected: + $ref: "#/components/schemas/Connected" + description: The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected. + thingName: + $ref: "#/components/schemas/ThingName" + description: The name of the thing associated with the principal of the MQTT client, if applicable. + cleanSession: + $ref: "#/components/schemas/CleanSession" + description: Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions. + sourceIp: + $ref: "#/components/schemas/SourceIp" + description: The IP address of the client that initiated the connection. + sourcePort: + $ref: "#/components/schemas/SourcePort" + description: The client's source port. + targetIp: + $ref: "#/components/schemas/TargetIp" + description: The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to. + targetPort: + $ref: "#/components/schemas/TargetPort" + description: The port number of the Amazon Web Services IoT Core endpoint that the client connected to. + keepAliveDuration: + $ref: "#/components/schemas/KeepAliveDuration" + description: The keep-alive interval in seconds that the client specified when establishing the connection. + connectedSince: + $ref: "#/components/schemas/Timestamp" + description: Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true. + disconnectedSince: + $ref: "#/components/schemas/Timestamp" + description: Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects. + disconnectReason: + $ref: "#/components/schemas/DisconnectReason" + description: The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons. + sessionExpiry: + $ref: "#/components/schemas/SessionExpiry" + description: The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects. + clientId: + $ref: "#/components/schemas/ClientId" + description: The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint. + Connected: + type: boolean + SourceIp: + type: string + SourcePort: + type: integer + TargetIp: + type: string + TargetPort: + type: integer + KeepAliveDuration: + type: integer + Timestamp: + type: integer + format: int64 + DisconnectReason: + type: string + SessionExpiry: + type: integer + format: int64 + VpcEndpointId: + type: string Topic: type: string GetRetainedMessageResponse: @@ -370,9 +567,6 @@ components: type: integer minimum: 0 maximum: 1 - Timestamp: - type: integer - format: int64 UserPropertiesBlob: type: string format: byte @@ -441,6 +635,34 @@ components: PayloadSize: type: integer format: int64 + ListSubscriptionsResponse: + type: object + properties: + subscriptions: + $ref: "#/components/schemas/SubscriptionList" + description: A list of topic filters and their associated Quality of Service (QoS) levels that the client is subscribed to. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token to use to get the next set of results, or null if there are no additional results. + SubscriptionList: + type: array + items: + $ref: "#/components/schemas/SubscriptionSummary" + SubscriptionSummary: + description: Contains information about a subscription for an MQTT client, including the topic filter and Quality of Service (QoS) level. + type: object + properties: + topicFilter: + $ref: "#/components/schemas/TopicFilter" + description: "The topic filter pattern that the client is subscribed to. May include MQTT wildcards such as + (single-level) and # (multi-level)." + qos: + $ref: "#/components/schemas/Qos" + description: The Quality of Service (QoS) level for the subscription. Valid values are 0 (at most once) and 1 (at least once). + required: + - topicFilter + - qos + TopicFilter: + type: string Retain: type: boolean UserProperties: @@ -459,6 +681,24 @@ components: MessageExpiry: type: integer format: int64 + Confirmation: + type: boolean + TimeoutInSeconds: + type: integer + SendDirectMessageResponse: + description: The output from the SendDirectMessage operation. + type: object + properties: + message: + $ref: "#/components/schemas/ResponseMessage" + description: The status message indicating the result of the operation. + traceId: + $ref: "#/components/schemas/TraceId" + description: A unique identifier for the request. Include this value when contacting Amazon Web Services Support for troubleshooting. + ResponseMessage: + type: string + TraceId: + type: string UpdateThingShadowResponse: description: The output from the UpdateThingShadow operation. type: object @@ -479,8 +719,17 @@ components: openAPIDocKey: "200" request: nativeCasing: pascal + get_connection: + operation: + $ref: "#/paths/~1connections~1{client_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal sqlVerbs: - select: [] + select: + - $ref: "#/components/x-stackQL-resources/connections/methods/get_connection" insert: [] update: [] delete: @@ -579,3 +828,31 @@ components: insert: [] update: [] delete: [] + subscriptions: + id: aws.iot_data.subscriptions + name: subscriptions + title: subscriptions + methods: + list_subscriptions: + operation: + $ref: "#/paths/~1connections~1{client_id}~1subscriptions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.subscriptions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/list_subscriptions" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/iotevents.yaml b/providers/src/aws/v00.00.00000/services/iotevents.yaml deleted file mode 100644 index 0c7cabc0..00000000 --- a/providers/src/aws/v00.00.00000/services/iotevents.yaml +++ /dev/null @@ -1,2504 +0,0 @@ -openapi: 3.0.0 -info: - version: "2018-07-27" - title: AWS IoT Events - description: AWS IoT Events - x-serviceName: iotevents - x-serviceAlias: iotevents - x-protocol: rest-json - x-apiVersion: "2018-07-27" - x-endpointPrefix: iotevents -servers: - - url: https://iotevents.{region}.amazonaws.com - variables: - region: - default: us-east-1 - description: AWS region - description: Regional endpoint for iotevents -paths: - /alarm-models: - post: - operationId: CreateAlarmModel - description: Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - alarmModelDescription: - $ref: "#/components/schemas/AlarmModelDescription" - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - tags: - $ref: "#/components/schemas/Tags" - key: - $ref: "#/components/schemas/AttributeJsonPath" - severity: - $ref: "#/components/schemas/Severity" - alarmRule: - $ref: "#/components/schemas/AlarmRule" - alarmNotification: - $ref: "#/components/schemas/AlarmNotification" - alarmEventActions: - $ref: "#/components/schemas/AlarmEventActions" - alarmCapabilities: - $ref: "#/components/schemas/AlarmCapabilities" - required: - - alarmModelName - - roleArn - - alarmRule - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAlarmModelResponse" - get: - operationId: ListAlarmModels - description: Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model. - parameters: - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListAlarmModelsResponse" - /detector-models: - post: - operationId: CreateDetectorModel - description: Creates a detector model. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - detectorModelDefinition: - $ref: "#/components/schemas/DetectorModelDefinition" - detectorModelDescription: - $ref: "#/components/schemas/DetectorModelDescription" - key: - $ref: "#/components/schemas/AttributeJsonPath" - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - tags: - $ref: "#/components/schemas/Tags" - evaluationMethod: - $ref: "#/components/schemas/EvaluationMethod" - required: - - detectorModelName - - detectorModelDefinition - - roleArn - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDetectorModelResponse" - get: - operationId: ListDetectorModels - description: Lists the detector models you have created. Only the metadata associated with each detector model is returned. - parameters: - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListDetectorModelsResponse" - /inputs: - post: - operationId: CreateInput - description: Creates an input. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - inputName: - $ref: "#/components/schemas/InputName" - inputDescription: - $ref: "#/components/schemas/InputDescription" - inputDefinition: - $ref: "#/components/schemas/InputDefinition" - tags: - $ref: "#/components/schemas/Tags" - required: - - inputName - - inputDefinition - responses: - "201": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateInputResponse" - get: - operationId: ListInputs - description: Lists the inputs you have created. - parameters: - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListInputsResponse" - /alarm-models/{alarm_model_name}: - delete: - operationId: DeleteAlarmModel - description: Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - responses: - "204": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteAlarmModelResponse" - get: - operationId: DescribeAlarmModel - description: Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - - name: version - in: query - required: false - schema: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeAlarmModelResponse" - post: - operationId: UpdateAlarmModel - description: Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - alarmModelDescription: - $ref: "#/components/schemas/AlarmModelDescription" - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - severity: - $ref: "#/components/schemas/Severity" - alarmRule: - $ref: "#/components/schemas/AlarmRule" - alarmNotification: - $ref: "#/components/schemas/AlarmNotification" - alarmEventActions: - $ref: "#/components/schemas/AlarmEventActions" - alarmCapabilities: - $ref: "#/components/schemas/AlarmCapabilities" - required: - - roleArn - - alarmRule - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateAlarmModelResponse" - /detector-models/{detector_model_name}: - delete: - operationId: DeleteDetectorModel - description: Deletes a detector model. Any active instances of the detector model are also deleted. - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model to be deleted. - responses: - "204": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDetectorModelResponse" - get: - operationId: DescribeDetectorModel - description: Describes a detector model. If the version parameter is not specified, information about the latest version is returned. - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model. - - name: version - in: query - required: false - schema: - $ref: "#/components/schemas/DetectorModelVersion" - description: The version of the detector model. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDetectorModelResponse" - post: - operationId: UpdateDetectorModel - description: Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model that is updated. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - detectorModelDefinition: - $ref: "#/components/schemas/DetectorModelDefinition" - detectorModelDescription: - $ref: "#/components/schemas/DetectorModelDescription" - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - evaluationMethod: - $ref: "#/components/schemas/EvaluationMethod" - required: - - detectorModelDefinition - - roleArn - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDetectorModelResponse" - /inputs/{input_name}: - delete: - operationId: DeleteInput - description: Deletes an input. - parameters: - - name: input_name - in: path - required: true - schema: - $ref: "#/components/schemas/InputName" - description: The name of the input to delete. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteInputResponse" - get: - operationId: DescribeInput - description: Describes an input. - parameters: - - name: input_name - in: path - required: true - schema: - $ref: "#/components/schemas/InputName" - description: The name of the input. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeInputResponse" - put: - operationId: UpdateInput - description: Updates an input. - parameters: - - name: input_name - in: path - required: true - schema: - $ref: "#/components/schemas/InputName" - description: The name of the input you want to update. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - inputDescription: - $ref: "#/components/schemas/InputDescription" - inputDefinition: - $ref: "#/components/schemas/InputDefinition" - required: - - inputDefinition - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateInputResponse" - /analysis/detector-models/{analysis_id}: - get: - operationId: DescribeDetectorModelAnalysis - description: Retrieves runtime information about a detector model analysis. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. - parameters: - - name: analysis_id - in: path - required: true - schema: - $ref: "#/components/schemas/AnalysisId" - description: The ID of the analysis result that you want to retrieve. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDetectorModelAnalysisResponse" - /logging: - get: - operationId: DescribeLoggingOptions - description: Retrieves the current settings of the AWS IoT Events logging options. - parameters: [] - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLoggingOptionsResponse" - put: - operationId: PutLoggingOptions - description: Sets or updates the AWS IoT Events logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - loggingOptions: - $ref: "#/components/schemas/LoggingOptions" - required: - - loggingOptions - responses: - "200": - description: Success - /analysis/detector-models/{analysis_id}/results: - get: - operationId: GetDetectorModelAnalysisResults - description: Retrieves one or more analysis results of the detector model. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. - parameters: - - name: analysis_id - in: path - required: true - schema: - $ref: "#/components/schemas/AnalysisId" - description: The ID of the analysis result that you want to retrieve. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxAnalysisResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/GetDetectorModelAnalysisResultsResponse" - /alarm-models/{alarm_model_name}/versions: - get: - operationId: ListAlarmModelVersions - description: Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListAlarmModelVersionsResponse" - /detector-models/{detector_model_name}/versions: - get: - operationId: ListDetectorModelVersions - description: Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model whose versions are returned. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListDetectorModelVersionsResponse" - /input-routings: - post: - operationId: ListInputRoutings - description: Lists one or more input routings. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - inputIdentifier: - $ref: "#/components/schemas/InputIdentifier" - maxResults: - $ref: "#/components/schemas/MaxResults" - nextToken: - $ref: "#/components/schemas/NextToken" - required: - - inputIdentifier - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListInputRoutingsResponse" - /tags: - get: - operationId: ListTagsForResource - description: Lists the tags (metadata) you have assigned to the resource. - parameters: - - name: resourceArn - in: query - required: true - schema: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the resource. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListTagsForResourceResponse" - post: - operationId: TagResource - description: Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. - parameters: - - name: resourceArn - in: query - required: true - schema: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the resource. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tags: - $ref: "#/components/schemas/Tags" - required: - - tags - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/TagResourceResponse" - delete: - operationId: UntagResource - description: Removes the given tags (metadata) from the resource. - parameters: - - name: resourceArn - in: query - required: true - schema: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the resource. - - name: tagKeys - in: query - required: true - schema: - $ref: "#/components/schemas/TagKeys" - description: A list of the keys of the tags to be removed from the resource. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UntagResourceResponse" - /analysis/detector-models/: - post: - operationId: StartDetectorModelAnalysis - description: Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - detectorModelDefinition: - $ref: "#/components/schemas/DetectorModelDefinition" - required: - - detectorModelDefinition - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StartDetectorModelAnalysisResponse" -components: - parameters: - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false - schema: - type: string - X-Amz-Security-Token: - in: header - name: X-Amz-Security-Token - required: false - schema: - type: string - X-Amz-Signature: - in: header - name: X-Amz-Signature - required: false - schema: - type: string - X-Amz-SignedHeaders: - in: header - name: X-Amz-SignedHeaders - required: false - schema: - type: string - schemas: - AlarmModelName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - AlarmModelDescription: - type: string - maxLength: 1024 - AmazonResourceName: - type: string - minLength: 1 - maxLength: 2048 - Tags: - type: array - items: - $ref: "#/components/schemas/Tag" - Tag: - description: Metadata that can be used to manage the resource. - type: object - properties: - key: - $ref: "#/components/schemas/TagKey" - description: The tag's key. - value: - $ref: "#/components/schemas/TagValue" - description: The tag's value. - required: - - key - - value - TagKey: - type: string - minLength: 1 - maxLength: 128 - TagValue: - type: string - minLength: 0 - maxLength: 256 - AttributeJsonPath: - type: string - minLength: 1 - maxLength: 128 - pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$ - Severity: - type: integer - minimum: 0 - maximum: 2147483647 - AlarmRule: - description: Defines when your alarm is invoked. - type: object - properties: - simpleRule: - $ref: "#/components/schemas/SimpleRule" - description: A rule that compares an input property value to a threshold value with a comparison operator. - SimpleRule: - description: A rule that compares an input property value to a threshold value with a comparison operator. - type: object - properties: - inputProperty: - $ref: "#/components/schemas/InputProperty" - description: The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. - comparisonOperator: - $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator. - threshold: - $ref: "#/components/schemas/Threshold" - description: The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. - required: - - inputProperty - - comparisonOperator - - threshold - InputProperty: - type: string - minLength: 1 - maxLength: 512 - ComparisonOperator: - type: string - enum: - - GREATER - - GREATER_OR_EQUAL - - LESS - - LESS_OR_EQUAL - - EQUAL - - NOT_EQUAL - Threshold: - type: string - minLength: 1 - maxLength: 512 - AlarmNotification: - description: Contains information about one or more notification actions. - type: object - properties: - notificationActions: - $ref: "#/components/schemas/NotificationActions" - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. - NotificationActions: - type: array - items: - $ref: "#/components/schemas/NotificationAction" - NotificationAction: - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. - type: object - properties: - action: - $ref: "#/components/schemas/NotificationTargetActions" - description: Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events. - smsConfigurations: - $ref: "#/components/schemas/SMSConfigurations" - description: Contains the configuration information of SMS notifications. - emailConfigurations: - $ref: "#/components/schemas/EmailConfigurations" - description: Contains the configuration information of email notifications. - required: - - action - NotificationTargetActions: - description: Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events. - type: object - properties: - lambdaAction: - $ref: "#/components/schemas/LambdaAction" - LambdaAction: - description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. - type: object - properties: - functionArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the Lambda function that is executed. - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you send a message to a Lambda function. - required: - - functionArn - Payload: - description: Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression. - type: object - properties: - contentExpression: - $ref: "#/components/schemas/ContentExpression" - description: The content of the payload. You can use a string expression that includes quoted strings ('``'), variables ($variable.``), input values ($input.``.``), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB. - type_: - $ref: "#/components/schemas/PayloadType" - description: The value of the payload type can be either STRING or JSON. - required: - - contentExpression - - type_ - ContentExpression: - type: string - minLength: 1 - PayloadType: - type: string - enum: - - STRING - - JSON - SMSConfigurations: - type: array - items: - $ref: "#/components/schemas/SMSConfiguration" - SMSConfiguration: - description: Contains the configuration information of SMS notifications. - type: object - properties: - senderId: - $ref: "#/components/schemas/SMSSenderId" - description: The sender ID. - additionalMessage: - $ref: "#/components/schemas/NotificationAdditionalMessage" - description: The message that you want to send. The message can be up to 200 characters. - recipients: - $ref: "#/components/schemas/RecipientDetails" - description: Specifies one or more recipients who receive the message. You must add the users that receive SMS messages to your AWS SSO store. - required: - - recipients - SMSSenderId: - type: string - NotificationAdditionalMessage: - type: string - RecipientDetails: - type: array - items: - $ref: "#/components/schemas/RecipientDetail" - RecipientDetail: - description: The information that identifies the recipient. - type: object - properties: - ssoIdentity: - $ref: "#/components/schemas/SSOIdentity" - description: The AWS Single Sign-On (AWS SSO) authentication information. - SSOIdentity: - description: Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide. - type: object - properties: - identityStoreId: - $ref: "#/components/schemas/IdentityStoreId" - description: The ID of the AWS SSO identity store. - userId: - $ref: "#/components/schemas/SSOReferenceId" - description: The user ID. - required: - - identityStoreId - IdentityStoreId: - type: string - SSOReferenceId: - type: string - EmailConfigurations: - type: array - items: - $ref: "#/components/schemas/EmailConfiguration" - EmailConfiguration: - description: Contains the configuration information of email notifications. - type: object - properties: - from: - $ref: "#/components/schemas/FromEmail" - description: The email address that sends emails. If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES. - content: - $ref: "#/components/schemas/EmailContent" - description: Contains the subject and message of an email. - recipients: - $ref: "#/components/schemas/EmailRecipients" - description: Contains the information of one or more recipients who receive the emails. You must add the users that receive emails to your AWS SSO store. - required: - - from - - recipients - FromEmail: - type: string - EmailContent: - description: Contains the subject and message of an email. - type: object - properties: - subject: - $ref: "#/components/schemas/EmailSubject" - description: The subject of the email. - additionalMessage: - $ref: "#/components/schemas/NotificationAdditionalMessage" - description: The message that you want to send. The message can be up to 200 characters. - EmailSubject: - type: string - EmailRecipients: - description: Contains the information of one or more recipients who receive the emails. You must add the users that receive emails to your AWS SSO store. - type: object - properties: - to: - $ref: "#/components/schemas/RecipientDetails" - description: Specifies one or more recipients who receive the email. - AlarmEventActions: - description: Contains information about one or more alarm actions. - type: object - properties: - alarmActions: - $ref: "#/components/schemas/AlarmActions" - description: Specifies one or more supported actions to receive notifications when the alarm state changes. - AlarmActions: - type: array - items: - $ref: "#/components/schemas/AlarmAction" - AlarmAction: - description: Specifies one of the following actions to receive notifications when the alarm state changes. - type: object - properties: - sns: - $ref: "#/components/schemas/SNSTopicPublishAction" - iotTopicPublish: - $ref: "#/components/schemas/IotTopicPublishAction" - lambda: - $ref: "#/components/schemas/LambdaAction" - iotEvents: - $ref: "#/components/schemas/IotEventsAction" - sqs: - $ref: "#/components/schemas/SqsAction" - firehose: - $ref: "#/components/schemas/FirehoseAction" - dynamoDB: - $ref: "#/components/schemas/DynamoDBAction" - dynamoDBv2: - $ref: "#/components/schemas/DynamoDBv2Action" - iotSiteWise: - $ref: "#/components/schemas/IotSiteWiseAction" - SNSTopicPublishAction: - description: Information required to publish the Amazon SNS message. - type: object - properties: - targetArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the Amazon SNS target where the message is sent. - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you send a message as an Amazon SNS push notification. - required: - - targetArn - IotTopicPublishAction: - description: Information required to publish the MQTT message through the AWS IoT message broker. - type: object - properties: - mqttTopic: - $ref: "#/components/schemas/MQTTTopic" - description: The MQTT topic of the message. You can use a string expression that includes variables ($variable.``) and input values ($input.``.``) as the topic string. - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you publish a message to an AWS IoT Core topic. - required: - - mqttTopic - MQTTTopic: - type: string - minLength: 1 - maxLength: 128 - IotEventsAction: - description: Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action. - type: object - properties: - inputName: - $ref: "#/components/schemas/InputName" - description: The name of the AWS IoT Events input where the data is sent. - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you send a message to an AWS IoT Events input. - required: - - inputName - InputName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ - SqsAction: - description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. - type: object - properties: - queueUrl: - $ref: "#/components/schemas/QueueUrl" - description: The URL of the SQS queue where the data is written. - useBase64: - $ref: "#/components/schemas/UseBase64" - description: Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE. - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you send a message to an Amazon SQS queue. - required: - - queueUrl - QueueUrl: - type: string - UseBase64: - type: boolean - FirehoseAction: - description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. - type: object - properties: - deliveryStreamName: - $ref: "#/components/schemas/DeliveryStreamName" - description: The name of the Kinesis Data Firehose delivery stream where the data is written. - separator: - $ref: "#/components/schemas/FirehoseSeparator" - description: "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)." - payload: - $ref: "#/components/schemas/Payload" - description: You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream. - required: - - deliveryStreamName - DeliveryStreamName: - type: string - FirehoseSeparator: - type: string - pattern: ([\n\t])|(\r\n)|(,) - DynamoDBAction: - description: Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'. For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name. For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the hashKeyValue parameter uses a substitution template. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date For more information, see Expressions in the AWS IoT Events Developer Guide. If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is ``_raw. - type: object - properties: - hashKeyType: - $ref: "#/components/schemas/DynamoKeyType" - description: "The data type for the hash key (also called the partition key). You can specify the following values: 'STRING' - The hash key is a string. 'NUMBER' - The hash key is a number. If you don't specify hashKeyType, the default value is 'STRING'." - hashKeyField: - $ref: "#/components/schemas/DynamoKeyField" - description: The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table. - hashKeyValue: - $ref: "#/components/schemas/DynamoKeyValue" - description: The value of the hash key (also called the partition key). - rangeKeyType: - $ref: "#/components/schemas/DynamoKeyType" - description: "The data type for the range key (also called the sort key), You can specify the following values: 'STRING' - The range key is a string. 'NUMBER' - The range key is number. If you don't specify rangeKeyField, the default value is 'STRING'." - rangeKeyField: - $ref: "#/components/schemas/DynamoKeyField" - description: The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table. - rangeKeyValue: - $ref: "#/components/schemas/DynamoKeyValue" - description: The value of the range key (also called the sort key). - operation: - $ref: "#/components/schemas/DynamoOperation" - description: "The type of operation to perform. You can specify the following values: 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. 'UPDATE' - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. 'DELETE' - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' operation." - payloadField: - $ref: "#/components/schemas/DynamoKeyField" - description: The name of the DynamoDB column that receives the action payload. If you don't specify this parameter, the name of the DynamoDB column is payload. - tableName: - $ref: "#/components/schemas/DynamoTableName" - description: The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table. - payload: - $ref: "#/components/schemas/Payload" - required: - - hashKeyField - - hashKeyValue - - tableName - DynamoKeyType: - type: string - DynamoKeyField: - type: string - DynamoKeyValue: - type: string - DynamoOperation: - type: string - DynamoTableName: - type: string - DynamoDBv2Action: - description: "Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'. For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName. For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the contentExpression parameter in Payload uses a substitution template. '{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}' For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date For more information, see Expressions in the AWS IoT Events Developer Guide. The value for the type parameter in Payload must be JSON." - type: object - properties: - tableName: - $ref: "#/components/schemas/DynamoTableName" - description: The name of the DynamoDB table. - payload: - $ref: "#/components/schemas/Payload" - required: - - tableName - IotSiteWiseAction: - description: Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise. You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'. For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1. For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the propertyAlias parameter uses a substitution template. 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature' You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise. For more information, see Expressions in the AWS IoT Events Developer Guide. - type: object - properties: - entryId: - $ref: "#/components/schemas/AssetPropertyEntryId" - description: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. - assetId: - $ref: "#/components/schemas/AssetId" - description: The ID of the asset that has the specified property. - propertyId: - $ref: "#/components/schemas/AssetPropertyId" - description: The ID of the asset property. - propertyAlias: - $ref: "#/components/schemas/AssetPropertyAlias" - description: The alias of the asset property. - propertyValue: - $ref: "#/components/schemas/AssetPropertyValue" - description: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. - AssetPropertyEntryId: - type: string - AssetId: - type: string - AssetPropertyId: - type: string - AssetPropertyAlias: - type: string - AssetPropertyValue: - description: A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference. You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'. For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality. For more information, see Expressions in the AWS IoT Events Developer Guide. - type: object - properties: - value: - $ref: "#/components/schemas/AssetPropertyVariant" - description: The value to send to an asset property. - timestamp: - $ref: "#/components/schemas/AssetPropertyTimestamp" - description: The timestamp associated with the asset property value. The default is the current event time. - quality: - $ref: "#/components/schemas/AssetPropertyQuality" - description: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'. - AssetPropertyVariant: - description: A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference. You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'. For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline. For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the doubleValue parameter uses a substitution template. '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}' For more information, see Expressions in the AWS IoT Events Developer Guide. You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference. - type: object - properties: - stringValue: - $ref: "#/components/schemas/AssetPropertyStringValue" - description: The asset property value is a string. You must use an expression, and the evaluated result should be a string. - integerValue: - $ref: "#/components/schemas/AssetPropertyIntegerValue" - description: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer. - doubleValue: - $ref: "#/components/schemas/AssetPropertyDoubleValue" - description: The asset property value is a double. You must use an expression, and the evaluated result should be a double. - booleanValue: - $ref: "#/components/schemas/AssetPropertyBooleanValue" - description: The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value. - AssetPropertyStringValue: - type: string - AssetPropertyIntegerValue: - type: string - AssetPropertyDoubleValue: - type: string - AssetPropertyBooleanValue: - type: string - AssetPropertyTimestamp: - description: A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference. You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates. Examples For literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675'. For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time. For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the timeInSeconds parameter uses a substitution template. '${$input.TemperatureInput.sensorData.timestamp / 1000}' For more information, see Expressions in the AWS IoT Events Developer Guide. - type: object - properties: - timeInSeconds: - $ref: "#/components/schemas/AssetPropertyTimeInSeconds" - description: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. - offsetInNanos: - $ref: "#/components/schemas/AssetPropertyOffsetInNanos" - description: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. - required: - - timeInSeconds - AssetPropertyTimeInSeconds: - type: string - AssetPropertyOffsetInNanos: - type: string - AssetPropertyQuality: - type: string - AlarmCapabilities: - description: Contains the configuration information of alarm state changes. - type: object - properties: - initializationConfiguration: - $ref: "#/components/schemas/InitializationConfiguration" - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. - acknowledgeFlow: - $ref: "#/components/schemas/AcknowledgeFlow" - description: Specifies whether to get notified for alarm state changes. - InitializationConfiguration: - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. - type: object - properties: - disabledOnInitialization: - $ref: "#/components/schemas/DisabledOnInitialization" - description: The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE. - required: - - disabledOnInitialization - DisabledOnInitialization: - type: boolean - AcknowledgeFlow: - description: Specifies whether to get notified for alarm state changes. - type: object - properties: - enabled: - $ref: "#/components/schemas/AcknowledgeFlowEnabled" - description: The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range. - required: - - enabled - AcknowledgeFlowEnabled: - type: boolean - CreateAlarmModelResponse: - type: object - properties: - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was created, in the Unix epoch format. - alarmModelArn: - $ref: "#/components/schemas/AlarmModelArn" - description: The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was last updated, in the Unix epoch format. - status: - $ref: "#/components/schemas/AlarmModelVersionStatus" - description: "The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again." - Timestamp: - type: string - format: date-time - AlarmModelArn: - type: string - AlarmModelVersion: - type: string - minLength: 1 - maxLength: 128 - AlarmModelVersionStatus: - type: string - enum: - - ACTIVE - - ACTIVATING - - INACTIVE - - FAILED - DetectorModelName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - DetectorModelDefinition: - description: Information that defines how a detector operates. - type: object - properties: - states: - $ref: "#/components/schemas/States" - description: Information about the states of the detector. - initialStateName: - $ref: "#/components/schemas/StateName" - description: The state that is entered at the creation of each detector (instance). - required: - - states - - initialStateName - States: - type: array - items: - $ref: "#/components/schemas/State" - State: - description: Information that defines a state of a detector. - type: object - properties: - stateName: - $ref: "#/components/schemas/StateName" - description: The name of the state. - onInput: - $ref: "#/components/schemas/OnInputLifecycle" - description: When an input is received and the condition is TRUE, perform the specified actions. - onEnter: - $ref: "#/components/schemas/OnEnterLifecycle" - description: When entering this state, perform these actions if the condition is TRUE. - onExit: - $ref: "#/components/schemas/OnExitLifecycle" - description: When exiting this state, perform these actions if the specified condition is TRUE. - required: - - stateName - StateName: - type: string - minLength: 1 - maxLength: 128 - OnInputLifecycle: - description: Specifies the actions performed when the condition evaluates to TRUE. - type: object - properties: - events: - $ref: "#/components/schemas/Events" - description: Specifies the actions performed when the condition evaluates to TRUE. - transitionEvents: - $ref: "#/components/schemas/TransitionEvents" - description: Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE. - Events: - type: array - items: - $ref: "#/components/schemas/Event" - Event: - description: Specifies the actions to be performed when the condition evaluates to TRUE. - type: object - properties: - eventName: - $ref: "#/components/schemas/EventName" - description: The name of the event. - condition: - $ref: "#/components/schemas/Condition" - description: Optional. The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE). - actions: - $ref: "#/components/schemas/Actions" - description: The actions to be performed. - required: - - eventName - EventName: - type: string - maxLength: 128 - Condition: - type: string - maxLength: 512 - Actions: - type: array - items: - $ref: "#/components/schemas/Action" - Action: - description: An action to be performed when the condition is TRUE. - type: object - properties: - setVariable: - $ref: "#/components/schemas/SetVariableAction" - description: Sets a variable to a specified value. - sns: - $ref: "#/components/schemas/SNSTopicPublishAction" - description: Sends an Amazon SNS message. - iotTopicPublish: - $ref: "#/components/schemas/IotTopicPublishAction" - description: Publishes an MQTT message with the given topic to the AWS IoT message broker. - setTimer: - $ref: "#/components/schemas/SetTimerAction" - description: Information needed to set the timer. - clearTimer: - $ref: "#/components/schemas/ClearTimerAction" - description: Information needed to clear the timer. - resetTimer: - $ref: "#/components/schemas/ResetTimerAction" - description: Information needed to reset the timer. - lambda: - $ref: "#/components/schemas/LambdaAction" - description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. - iotEvents: - $ref: "#/components/schemas/IotEventsAction" - description: Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action. - sqs: - $ref: "#/components/schemas/SqsAction" - description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. - firehose: - $ref: "#/components/schemas/FirehoseAction" - description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. - dynamoDB: - $ref: "#/components/schemas/DynamoDBAction" - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide. - dynamoDBv2: - $ref: "#/components/schemas/DynamoDBv2Action" - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide. - iotSiteWise: - $ref: "#/components/schemas/IotSiteWiseAction" - description: Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise . - SetVariableAction: - description: Information about the variable and its new value. - type: object - properties: - variableName: - $ref: "#/components/schemas/VariableName" - description: The name of the variable. - value: - $ref: "#/components/schemas/VariableValue" - description: The new value of the variable. - required: - - variableName - - value - VariableName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ - VariableValue: - type: string - minLength: 1 - maxLength: 1024 - SetTimerAction: - description: Information needed to set the timer. - type: object - properties: - timerName: - $ref: "#/components/schemas/TimerName" - description: The name of the timer. - seconds: - $ref: "#/components/schemas/Seconds" - description: The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. - durationExpression: - $ref: "#/components/schemas/VariableValue" - description: The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.``), and input values ($input.``.``) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. - required: - - timerName - TimerName: - type: string - minLength: 1 - maxLength: 128 - Seconds: - type: integer - minimum: 1 - maximum: 31622400 - ClearTimerAction: - description: Information needed to clear the timer. - type: object - properties: - timerName: - $ref: "#/components/schemas/TimerName" - description: The name of the timer to clear. - required: - - timerName - ResetTimerAction: - description: Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer. - type: object - properties: - timerName: - $ref: "#/components/schemas/TimerName" - description: The name of the timer to reset. - required: - - timerName - TransitionEvents: - type: array - items: - $ref: "#/components/schemas/TransitionEvent" - TransitionEvent: - description: Specifies the actions performed and the next state entered when a condition evaluates to TRUE. - type: object - properties: - eventName: - $ref: "#/components/schemas/EventName" - description: The name of the transition event. - condition: - $ref: "#/components/schemas/Condition" - description: Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered. - actions: - $ref: "#/components/schemas/Actions" - description: The actions to be performed. - nextState: - $ref: "#/components/schemas/StateName" - description: The next state to enter. - required: - - eventName - - condition - - nextState - OnEnterLifecycle: - description: When entering this state, perform these actions if the condition is TRUE. - type: object - properties: - events: - $ref: "#/components/schemas/Events" - description: Specifies the actions that are performed when the state is entered and the condition is TRUE. - OnExitLifecycle: - description: When exiting this state, perform these actions if the specified condition is TRUE. - type: object - properties: - events: - $ref: "#/components/schemas/Events" - description: Specifies the actions that are performed when the state is exited and the condition is TRUE. - DetectorModelDescription: - type: string - maxLength: 1024 - EvaluationMethod: - type: string - enum: - - BATCH - - SERIAL - CreateDetectorModelResponse: - type: object - properties: - detectorModelConfiguration: - $ref: "#/components/schemas/DetectorModelConfiguration" - description: Information about how the detector model is configured. - DetectorModelConfiguration: - description: Information about how the detector model is configured. - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model. - detectorModelVersion: - $ref: "#/components/schemas/DetectorModelVersion" - description: The version of the detector model. - detectorModelDescription: - $ref: "#/components/schemas/DetectorModelDescription" - description: A brief description of the detector model. - detectorModelArn: - $ref: "#/components/schemas/DetectorModelArn" - description: The ARN of the detector model. - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector model was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector model was last updated. - status: - $ref: "#/components/schemas/DetectorModelVersionStatus" - description: The status of the detector model. - key: - $ref: "#/components/schemas/AttributeJsonPath" - description: The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value. - evaluationMethod: - $ref: "#/components/schemas/EvaluationMethod" - description: Information about the order in which events are evaluated and how actions are executed. - DetectorModelVersion: - type: string - minLength: 1 - maxLength: 128 - DetectorModelArn: - type: string - DetectorModelVersionStatus: - type: string - enum: - - ACTIVE - - ACTIVATING - - INACTIVE - - DEPRECATED - - DRAFT - - PAUSED - - FAILED - InputDescription: - type: string - maxLength: 1024 - InputDefinition: - description: The definition of the input. - type: object - properties: - attributes: - $ref: "#/components/schemas/Attributes" - description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input. - required: - - attributes - Attributes: - type: array - items: - $ref: "#/components/schemas/Attribute" - Attribute: - description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors. - type: object - properties: - jsonPath: - $ref: "#/components/schemas/AttributeJsonPath" - description: "An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors. Syntax: ``.``..." - required: - - jsonPath - CreateInputResponse: - type: object - properties: - inputConfiguration: - $ref: "#/components/schemas/InputConfiguration" - description: Information about the configuration of the input. - InputConfiguration: - description: Information about the configuration of an input. - type: object - properties: - inputName: - $ref: "#/components/schemas/InputName" - description: The name of the input. - inputDescription: - $ref: "#/components/schemas/InputDescription" - description: A brief description of the input. - inputArn: - $ref: "#/components/schemas/InputArn" - description: The ARN of the input. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the input was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The last time the input was updated. - status: - $ref: "#/components/schemas/InputStatus" - description: The status of the input. - required: - - inputName - - inputArn - - creationTime - - lastUpdateTime - - status - InputArn: - type: string - InputStatus: - type: string - enum: - - CREATING - - UPDATING - - ACTIVE - - DELETING - DeleteAlarmModelResponse: - type: object - DeleteDetectorModelResponse: - type: object - DeleteInputResponse: - type: object - DescribeAlarmModelResponse: - type: object - properties: - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was created, in the Unix epoch format. - alarmModelArn: - $ref: "#/components/schemas/AlarmModelArn" - description: The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was last updated, in the Unix epoch format. - status: - $ref: "#/components/schemas/AlarmModelVersionStatus" - description: "The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again." - statusMessage: - $ref: "#/components/schemas/StatusMessage" - description: Contains information about the status of the alarm model. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - alarmModelDescription: - $ref: "#/components/schemas/AlarmModelDescription" - description: The description of the alarm model. - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - key: - $ref: "#/components/schemas/AttributeJsonPath" - description: An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm. - severity: - $ref: "#/components/schemas/Severity" - description: A non-negative integer that reflects the severity level of the alarm. - alarmRule: - $ref: "#/components/schemas/AlarmRule" - description: Defines when your alarm is invoked. - alarmNotification: - $ref: "#/components/schemas/AlarmNotification" - description: Contains information about one or more notification actions. - alarmEventActions: - $ref: "#/components/schemas/AlarmEventActions" - description: Contains information about one or more alarm actions. - alarmCapabilities: - $ref: "#/components/schemas/AlarmCapabilities" - description: Contains the configuration information of alarm state changes. - StatusMessage: - type: string - DescribeDetectorModelResponse: - type: object - properties: - detectorModel: - $ref: "#/components/schemas/DetectorModel" - description: Information about the detector model. - DetectorModel: - description: Information about the detector model. - type: object - properties: - detectorModelDefinition: - $ref: "#/components/schemas/DetectorModelDefinition" - description: Information that defines how a detector operates. - detectorModelConfiguration: - $ref: "#/components/schemas/DetectorModelConfiguration" - description: Information about how the detector is configured. - AnalysisId: - type: string - DescribeDetectorModelAnalysisResponse: - type: object - properties: - status: - $ref: "#/components/schemas/AnalysisStatus" - description: "The status of the analysis activity. The status can be one of the following values: RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. COMPLETE - AWS IoT Events finished analyzing your detector model. FAILED - AWS IoT Events couldn't analyze your detector model. Try again later." - AnalysisStatus: - type: string - enum: - - RUNNING - - COMPLETE - - FAILED - DescribeInputResponse: - type: object - properties: - input: - $ref: "#/components/schemas/Input" - description: Information about the input. - Input: - description: Information about the input. - type: object - properties: - inputConfiguration: - $ref: "#/components/schemas/InputConfiguration" - description: Information about the configuration of an input. - inputDefinition: - $ref: "#/components/schemas/InputDefinition" - description: The definition of the input. - DescribeLoggingOptionsResponse: - type: object - properties: - loggingOptions: - $ref: "#/components/schemas/LoggingOptions" - description: The current settings of the AWS IoT Events logging options. - LoggingOptions: - description: The values of the AWS IoT Events logging options. - type: object - properties: - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the role that grants permission to AWS IoT Events to perform logging. - level: - $ref: "#/components/schemas/LoggingLevel" - description: The logging level. - enabled: - $ref: "#/components/schemas/LoggingEnabled" - description: If TRUE, logging is enabled for AWS IoT Events. - detectorDebugOptions: - $ref: "#/components/schemas/DetectorDebugOptions" - description: Information that identifies those detector models and their detectors (instances) for which the logging level is given. - required: - - roleArn - - level - - enabled - LoggingLevel: - type: string - enum: - - ERROR - - INFO - - DEBUG - LoggingEnabled: - type: boolean - DetectorDebugOptions: - type: array - items: - $ref: "#/components/schemas/DetectorDebugOption" - DetectorDebugOption: - description: The detector model and the specific detectors (instances) for which the logging level is given. - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the input attribute key used to create the detector (the instance of the detector model). - required: - - detectorModelName - KeyValue: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9\-_:]+$ - NextToken: - type: string - MaxAnalysisResults: - type: integer - GetDetectorModelAnalysisResultsResponse: - type: object - properties: - analysisResults: - $ref: "#/components/schemas/AnalysisResults" - description: Contains information about one or more analysis results. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - AnalysisResults: - type: array - items: - $ref: "#/components/schemas/AnalysisResult" - AnalysisResult: - description: Contains the result of the analysis. - type: object - properties: - type_: - $ref: "#/components/schemas/AnalysisType" - description: "The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result: supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase. structure - The detector model must follow a structure that AWS IoT Events supports. expression-syntax - Your expression must follow the required syntax. data-type - Data types referenced in the detector model must be compatible. referenced-data - You must define the data referenced in your detector model before you can use the data. referenced-resource - Resources that the detector model uses must be available. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide." - level: - $ref: "#/components/schemas/AnalysisResultLevel" - description: "The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories: INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action. WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected. ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model." - message: - $ref: "#/components/schemas/AnalysisMessage" - description: Contains additional information about the analysis result. - locations: - $ref: "#/components/schemas/AnalysisResultLocations" - description: Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references. - AnalysisType: - type: string - AnalysisResultLevel: - type: string - enum: - - INFO - - WARNING - - ERROR - AnalysisMessage: - type: string - AnalysisResultLocations: - type: array - items: - $ref: "#/components/schemas/AnalysisResultLocation" - AnalysisResultLocation: - description: Contains information that you can use to locate the field in your detector model that the analysis result references. - type: object - properties: - path: - $ref: "#/components/schemas/AnalysisResultLocationPath" - description: A JsonPath expression that identifies the error field in your detector model. - AnalysisResultLocationPath: - type: string - MaxResults: - type: integer - minimum: 1 - maximum: 250 - ListAlarmModelVersionsResponse: - type: object - properties: - alarmModelVersionSummaries: - $ref: "#/components/schemas/AlarmModelVersionSummaries" - description: A list that summarizes each alarm model version. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - AlarmModelVersionSummaries: - type: array - items: - $ref: "#/components/schemas/AlarmModelVersionSummary" - AlarmModelVersionSummary: - description: Contains a summary of an alarm model version. - type: object - properties: - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - alarmModelArn: - $ref: "#/components/schemas/AlarmModelArn" - description: The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was created, in the Unix epoch format. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was last updated, in the Unix epoch format. - status: - $ref: "#/components/schemas/AlarmModelVersionStatus" - description: "The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again." - statusMessage: - $ref: "#/components/schemas/StatusMessage" - description: Contains information about the status of the alarm model version. - ListAlarmModelsResponse: - type: object - properties: - alarmModelSummaries: - $ref: "#/components/schemas/AlarmModelSummaries" - description: A list that summarizes each alarm model. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - AlarmModelSummaries: - type: array - items: - $ref: "#/components/schemas/AlarmModelSummary" - AlarmModelSummary: - description: Contains a summary of an alarm model. - type: object - properties: - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was created, in the Unix epoch format. - alarmModelDescription: - $ref: "#/components/schemas/AlarmModelDescription" - description: The description of the alarm model. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - ListDetectorModelVersionsResponse: - type: object - properties: - detectorModelVersionSummaries: - $ref: "#/components/schemas/DetectorModelVersionSummaries" - description: Summary information about the detector model versions. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - DetectorModelVersionSummaries: - type: array - items: - $ref: "#/components/schemas/DetectorModelVersionSummary" - DetectorModelVersionSummary: - description: Information about the detector model version. - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model. - detectorModelVersion: - $ref: "#/components/schemas/DetectorModelVersion" - description: The ID of the detector model version. - detectorModelArn: - $ref: "#/components/schemas/DetectorModelArn" - description: The ARN of the detector model version. - roleArn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the role that grants the detector model permission to perform its tasks. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector model version was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The last time the detector model version was updated. - status: - $ref: "#/components/schemas/DetectorModelVersionStatus" - description: The status of the detector model version. - evaluationMethod: - $ref: "#/components/schemas/EvaluationMethod" - description: Information about the order in which events are evaluated and how actions are executed. - ListDetectorModelsResponse: - type: object - properties: - detectorModelSummaries: - $ref: "#/components/schemas/DetectorModelSummaries" - description: Summary information about the detector models. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - DetectorModelSummaries: - type: array - items: - $ref: "#/components/schemas/DetectorModelSummary" - DetectorModelSummary: - description: Information about the detector model. - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model. - detectorModelDescription: - $ref: "#/components/schemas/DetectorModelDescription" - description: A brief description of the detector model. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector model was created. - InputIdentifier: - description: The identifer of the input. - type: object - properties: - iotEventsInputIdentifier: - $ref: "#/components/schemas/IotEventsInputIdentifier" - description: The identifier of the input routed to AWS IoT Events. - iotSiteWiseInputIdentifier: - $ref: "#/components/schemas/IotSiteWiseInputIdentifier" - description: The identifer of the input routed from AWS IoT SiteWise. - IotEventsInputIdentifier: - description: The identifier of the input routed to AWS IoT Events. - type: object - properties: - inputName: - $ref: "#/components/schemas/InputName" - description: The name of the input routed to AWS IoT Events. - required: - - inputName - IotSiteWiseInputIdentifier: - description: The identifer of the input routed from AWS IoT SiteWise. - type: object - properties: - iotSiteWiseAssetModelPropertyIdentifier: - $ref: "#/components/schemas/IotSiteWiseAssetModelPropertyIdentifier" - description: The identifier of the AWS IoT SiteWise asset model property. - IotSiteWiseAssetModelPropertyIdentifier: - description: The asset model property identifer of the input routed from AWS IoT SiteWise. - type: object - properties: - assetModelId: - $ref: "#/components/schemas/AssetModelId" - description: The ID of the AWS IoT SiteWise asset model. - propertyId: - $ref: "#/components/schemas/AssetPropertyId" - description: The ID of the AWS IoT SiteWise asset property. - required: - - assetModelId - - propertyId - AssetModelId: - type: string - ListInputRoutingsResponse: - type: object - properties: - routedResources: - $ref: "#/components/schemas/RoutedResources" - description: Summary information about the routed resources. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - RoutedResources: - type: array - items: - $ref: "#/components/schemas/RoutedResource" - RoutedResource: - description: Contains information about the routed resource. - type: object - properties: - name: - $ref: "#/components/schemas/ResourceName" - description: The name of the routed resource. - arn: - $ref: "#/components/schemas/AmazonResourceName" - description: The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - ResourceName: - type: string - ListInputsResponse: - type: object - properties: - inputSummaries: - $ref: "#/components/schemas/InputSummaries" - description: Summary information about the inputs. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - InputSummaries: - type: array - items: - $ref: "#/components/schemas/InputSummary" - InputSummary: - description: Information about the input. - type: object - properties: - inputName: - $ref: "#/components/schemas/InputName" - description: The name of the input. - inputDescription: - $ref: "#/components/schemas/InputDescription" - description: A brief description of the input. - inputArn: - $ref: "#/components/schemas/InputArn" - description: The ARN of the input. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the input was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The last time the input was updated. - status: - $ref: "#/components/schemas/InputStatus" - description: The status of the input. - ListTagsForResourceResponse: - type: object - properties: - tags: - $ref: "#/components/schemas/Tags" - description: The list of tags assigned to the resource. - StartDetectorModelAnalysisResponse: - type: object - properties: - analysisId: - $ref: "#/components/schemas/AnalysisId" - description: The ID that you can use to retrieve the analysis result. - TagResourceResponse: - type: object - TagKeys: - type: array - items: - $ref: "#/components/schemas/TagKey" - UntagResourceResponse: - type: object - UpdateAlarmModelResponse: - type: object - properties: - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was created, in the Unix epoch format. - alarmModelArn: - $ref: "#/components/schemas/AlarmModelArn" - description: The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm model was last updated, in the Unix epoch format. - status: - $ref: "#/components/schemas/AlarmModelVersionStatus" - description: "The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again." - UpdateDetectorModelResponse: - type: object - properties: - detectorModelConfiguration: - $ref: "#/components/schemas/DetectorModelConfiguration" - description: Information about how the detector model is configured. - UpdateInputResponse: - type: object - properties: - inputConfiguration: - $ref: "#/components/schemas/InputConfiguration" - description: Information about the configuration of the input. - x-stackQL-resources: - alarm_models: - id: aws.iotevents.alarm_models - name: alarm_models - title: alarm_models - methods: - create_alarm_model: - operation: - $ref: "#/paths/~1alarm-models/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_alarm_models: - operation: - $ref: "#/paths/~1alarm-models/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - delete_alarm_model: - operation: - $ref: "#/paths/~1alarm-models~1{alarm_model_name}/delete" - response: - openAPIDocKey: "204" - mediaType: application/json - describe_alarm_model: - operation: - $ref: "#/paths/~1alarm-models~1{alarm_model_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - update_alarm_model: - operation: - $ref: "#/paths/~1alarm-models~1{alarm_model_name}/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/alarm_models/methods/describe_alarm_model" - - $ref: "#/components/x-stackQL-resources/alarm_models/methods/list_alarm_models" - insert: - - $ref: "#/components/x-stackQL-resources/alarm_models/methods/create_alarm_model" - update: - - $ref: "#/components/x-stackQL-resources/alarm_models/methods/update_alarm_model" - delete: - - $ref: "#/components/x-stackQL-resources/alarm_models/methods/delete_alarm_model" - detector_models: - id: aws.iotevents.detector_models - name: detector_models - title: detector_models - methods: - create_detector_model: - operation: - $ref: "#/paths/~1detector-models/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_detector_models: - operation: - $ref: "#/paths/~1detector-models/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - delete_detector_model: - operation: - $ref: "#/paths/~1detector-models~1{detector_model_name}/delete" - response: - openAPIDocKey: "204" - mediaType: application/json - describe_detector_model: - operation: - $ref: "#/paths/~1detector-models~1{detector_model_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.detectorModel - request: - nativeCasing: pascal - update_detector_model: - operation: - $ref: "#/paths/~1detector-models~1{detector_model_name}/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/detector_models/methods/describe_detector_model" - - $ref: "#/components/x-stackQL-resources/detector_models/methods/list_detector_models" - insert: - - $ref: "#/components/x-stackQL-resources/detector_models/methods/create_detector_model" - update: - - $ref: "#/components/x-stackQL-resources/detector_models/methods/update_detector_model" - delete: - - $ref: "#/components/x-stackQL-resources/detector_models/methods/delete_detector_model" - inputs: - id: aws.iotevents.inputs - name: inputs - title: inputs - methods: - create_input: - operation: - $ref: "#/paths/~1inputs/post" - response: - openAPIDocKey: "201" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_inputs: - operation: - $ref: "#/paths/~1inputs/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - delete_input: - operation: - $ref: "#/paths/~1inputs~1{input_name}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - describe_input: - operation: - $ref: "#/paths/~1inputs~1{input_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.input - update_input: - operation: - $ref: "#/paths/~1inputs~1{input_name}/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/inputs/methods/describe_input" - - $ref: "#/components/x-stackQL-resources/inputs/methods/list_inputs" - insert: - - $ref: "#/components/x-stackQL-resources/inputs/methods/create_input" - update: - - $ref: "#/components/x-stackQL-resources/inputs/methods/update_input" - delete: - - $ref: "#/components/x-stackQL-resources/inputs/methods/delete_input" - detector_model_analysis: - id: aws.iotevents.detector_model_analysis - name: detector_model_analysis - title: detector_model_analysis - methods: - describe_detector_model_analysis: - operation: - $ref: "#/paths/~1analysis~1detector-models~1{analysis_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - start_detector_model_analysis: - operation: - $ref: "#/paths/~1analysis~1detector-models~1/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/detector_model_analysis/methods/describe_detector_model_analysis" - insert: [] - update: [] - delete: [] - logging_options: - id: aws.iotevents.logging_options - name: logging_options - title: logging_options - methods: - describe_logging_options: - operation: - $ref: "#/paths/~1logging/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.loggingOptions - put_logging_options: - operation: - $ref: "#/paths/~1logging/put" - response: - openAPIDocKey: "200" - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/logging_options/methods/describe_logging_options" - insert: [] - update: [] - replace: - - $ref: "#/components/x-stackQL-resources/logging_options/methods/put_logging_options" - delete: [] - detector_model_analysis_results: - id: aws.iotevents.detector_model_analysis_results - name: detector_model_analysis_results - title: detector_model_analysis_results - methods: - get_detector_model_analysis_results: - operation: - $ref: "#/paths/~1analysis~1detector-models~1{analysis_id}~1results/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/detector_model_analysis_results/methods/get_detector_model_analysis_results" - insert: [] - update: [] - delete: [] - alarm_model_versions: - id: aws.iotevents.alarm_model_versions - name: alarm_model_versions - title: alarm_model_versions - methods: - list_alarm_model_versions: - operation: - $ref: "#/paths/~1alarm-models~1{alarm_model_name}~1versions/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/alarm_model_versions/methods/list_alarm_model_versions" - insert: [] - update: [] - delete: [] - detector_model_versions: - id: aws.iotevents.detector_model_versions - name: detector_model_versions - title: detector_model_versions - methods: - list_detector_model_versions: - operation: - $ref: "#/paths/~1detector-models~1{detector_model_name}~1versions/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/detector_model_versions/methods/list_detector_model_versions" - insert: [] - update: [] - delete: [] - input_routings: - id: aws.iotevents.input_routings - name: input_routings - title: input_routings - methods: - list_input_routings: - operation: - $ref: "#/paths/~1input-routings/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/input_routings/methods/list_input_routings" - insert: [] - update: [] - delete: [] - tags: - id: aws.iotevents.tags - name: tags - title: tags - methods: - list_tags_for_resource: - operation: - $ref: "#/paths/~1tags/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - tag_resource: - operation: - $ref: "#/paths/~1tags/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - untag_resource: - operation: - $ref: "#/paths/~1tags/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" - insert: [] - update: - - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" - delete: [] diff --git a/providers/src/aws/v00.00.00000/services/iotevents_data.yaml b/providers/src/aws/v00.00.00000/services/iotevents_data.yaml deleted file mode 100644 index fd60c8f4..00000000 --- a/providers/src/aws/v00.00.00000/services/iotevents_data.yaml +++ /dev/null @@ -1,1206 +0,0 @@ -openapi: 3.0.0 -info: - version: "2018-10-23" - title: AWS IoT Events Data - description: AWS IoT Events Data - x-serviceName: ioteventsdata - x-serviceAlias: iotevents_data - x-protocol: rest-json - x-apiVersion: "2018-10-23" - x-endpointPrefix: data.iotevents -servers: - - url: https://data.iotevents.{region}.amazonaws.com - variables: - region: - default: us-east-1 - description: AWS region - description: Regional endpoint for iotevents-data -paths: - /alarms/acknowledge: - post: - operationId: BatchAcknowledgeAlarm - description: Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - acknowledgeActionRequests: - $ref: "#/components/schemas/AcknowledgeAlarmActionRequests" - required: - - acknowledgeActionRequests - responses: - "202": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchAcknowledgeAlarmResponse" - /detectors/delete: - post: - operationId: BatchDeleteDetector - description: Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - detectors: - $ref: "#/components/schemas/DeleteDetectorRequests" - required: - - detectors - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchDeleteDetectorResponse" - /alarms/disable: - post: - operationId: BatchDisableAlarm - description: Disables one or more alarms. The alarms change to the DISABLED state after you disable them. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - disableActionRequests: - $ref: "#/components/schemas/DisableAlarmActionRequests" - required: - - disableActionRequests - responses: - "202": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchDisableAlarmResponse" - /alarms/enable: - post: - operationId: BatchEnableAlarm - description: Enables one or more alarms. The alarms change to the NORMAL state after you enable them. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - enableActionRequests: - $ref: "#/components/schemas/EnableAlarmActionRequests" - required: - - enableActionRequests - responses: - "202": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchEnableAlarmResponse" - /inputs/messages: - post: - operationId: BatchPutMessage - description: Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - messages: - $ref: "#/components/schemas/Messages" - required: - - messages - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchPutMessageResponse" - /alarms/reset: - post: - operationId: BatchResetAlarm - description: Resets one or more alarms. The alarms return to the NORMAL state after you reset them. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - resetActionRequests: - $ref: "#/components/schemas/ResetAlarmActionRequests" - required: - - resetActionRequests - responses: - "202": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchResetAlarmResponse" - /alarms/snooze: - post: - operationId: BatchSnoozeAlarm - description: Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - snoozeActionRequests: - $ref: "#/components/schemas/SnoozeAlarmActionRequests" - required: - - snoozeActionRequests - responses: - "202": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchSnoozeAlarmResponse" - /detectors: - post: - operationId: BatchUpdateDetector - description: Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - detectors: - $ref: "#/components/schemas/UpdateDetectorRequests" - required: - - detectors - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/BatchUpdateDetectorResponse" - /alarms/{alarm_model_name}/keyValues/: - get: - operationId: DescribeAlarm - description: Retrieves information about an alarm. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - - name: keyValue - in: query - required: false - schema: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeAlarmResponse" - /detectors/{detector_model_name}/keyValues/: - get: - operationId: DescribeDetector - description: Returns information about the specified detector (instance). - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model whose detectors (instances) you want information about. - - name: keyValue - in: query - required: false - schema: - $ref: "#/components/schemas/KeyValue" - description: A filter used to limit results to detectors (instances) created because of the given key ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDetectorResponse" - /alarms/{alarm_model_name}: - get: - operationId: ListAlarms - description: Lists one or more alarms. The operation returns only the metadata associated with each alarm. - parameters: - - name: alarm_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListAlarmsResponse" - /detectors/{detector_model_name}: - get: - operationId: ListDetectors - description: Lists detectors (the instances of a detector model). - parameters: - - name: detector_model_name - in: path - required: true - schema: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model whose detectors (instances) are listed. - - name: stateName - in: query - required: false - schema: - $ref: "#/components/schemas/StateName" - description: A filter that limits results to those detectors (instances) in the given state. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to be returned per request. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListDetectorsResponse" -components: - parameters: - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false - schema: - type: string - X-Amz-Security-Token: - in: header - name: X-Amz-Security-Token - required: false - schema: - type: string - X-Amz-Signature: - in: header - name: X-Amz-Signature - required: false - schema: - type: string - X-Amz-SignedHeaders: - in: header - name: X-Amz-SignedHeaders - required: false - schema: - type: string - schemas: - AcknowledgeAlarmActionRequests: - type: array - items: - $ref: "#/components/schemas/AcknowledgeAlarmActionRequest" - AcknowledgeAlarmActionRequest: - description: Information needed to acknowledge the alarm. - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you acknowledge the alarm. - required: - - requestId - - alarmModelName - RequestId: - type: string - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9_-]+$ - AlarmModelName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - KeyValue: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9\-_:]+$ - Note: - type: string - maxLength: 256 - BatchAcknowledgeAlarmResponse: - type: object - properties: - errorEntries: - $ref: "#/components/schemas/BatchAlarmActionErrorEntries" - description: A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed. - BatchAlarmActionErrorEntries: - type: array - items: - $ref: "#/components/schemas/BatchAlarmActionErrorEntry" - BatchAlarmActionErrorEntry: - description: "Contains error messages associated with one of the following requests: BatchAcknowledgeAlarm BatchDisableAlarm BatchEnableAlarm BatchResetAlarm BatchSnoozeAlarm" - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - errorCode: - $ref: "#/components/schemas/ErrorCode" - description: The error code. - errorMessage: - $ref: "#/components/schemas/ErrorMessage" - description: A message that describes the error. - ErrorCode: - type: string - enum: - - ResourceNotFoundException - - InvalidRequestException - - InternalFailureException - - ServiceUnavailableException - - ThrottlingException - ErrorMessage: - type: string - DeleteDetectorRequests: - type: array - items: - $ref: "#/components/schemas/DeleteDetectorRequest" - DeleteDetectorRequest: - description: Information used to delete the detector model. - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The ID to assign to the DeleteDetectorRequest. Each "messageId" must be unique within each batch sent. - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model that was used to create the detector instance. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used to identify the detector. - required: - - messageId - - detectorModelName - MessageId: - type: string - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9_-]+$ - DetectorModelName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - BatchDeleteDetectorResponse: - type: object - properties: - batchDeleteDetectorErrorEntries: - $ref: "#/components/schemas/BatchDeleteDetectorErrorEntries" - description: A list of errors associated with the request, or an empty array ([]) if there are no errors. Each error entry contains a messageId that helps you identify the entry that failed. - BatchDeleteDetectorErrorEntries: - type: array - items: - $ref: "#/components/schemas/BatchDeleteDetectorErrorEntry" - BatchDeleteDetectorErrorEntry: - description: Contains error messages associated with the deletion request. - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The ID of the message that caused the error. (See the value of the "messageId" in the detectors object of the DeleteDetectorRequest.) - errorCode: - $ref: "#/components/schemas/ErrorCode" - description: The error code. - errorMessage: - $ref: "#/components/schemas/ErrorMessage" - description: A message that describes the error. - DisableAlarmActionRequests: - type: array - items: - $ref: "#/components/schemas/DisableAlarmActionRequest" - DisableAlarmActionRequest: - description: Information used to disable the alarm. - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you disable the alarm. - required: - - requestId - - alarmModelName - BatchDisableAlarmResponse: - type: object - properties: - errorEntries: - $ref: "#/components/schemas/BatchAlarmActionErrorEntries" - description: A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed. - EnableAlarmActionRequests: - type: array - items: - $ref: "#/components/schemas/EnableAlarmActionRequest" - EnableAlarmActionRequest: - description: Information needed to enable the alarm. - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you enable the alarm. - required: - - requestId - - alarmModelName - BatchEnableAlarmResponse: - type: object - properties: - errorEntries: - $ref: "#/components/schemas/BatchAlarmActionErrorEntries" - description: A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed. - Messages: - type: array - items: - $ref: "#/components/schemas/Message" - Message: - description: Information about a message. - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The ID to assign to the message. Within each batch sent, each "messageId" must be unique. - inputName: - $ref: "#/components/schemas/EphemeralInputName" - description: The name of the input into which the message payload is transformed. - payload: - $ref: "#/components/schemas/Payload" - description: The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it). - timestamp: - $ref: "#/components/schemas/TimestampValue" - description: The timestamp associated with the message. - required: - - messageId - - inputName - - payload - EphemeralInputName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ - Payload: - type: string - format: byte - TimestampValue: - description: Contains information about a timestamp. - type: object - properties: - timeInMillis: - $ref: "#/components/schemas/EpochMilliTimestamp" - description: The value of the timestamp, in the Unix epoch format. - EpochMilliTimestamp: - type: integer - format: int64 - minimum: 1 - maximum: 9223372036854776000 - BatchPutMessageResponse: - type: object - properties: - BatchPutMessageErrorEntries: - $ref: "#/components/schemas/BatchPutMessageErrorEntries" - description: A list of any errors encountered when sending the messages. - BatchPutMessageErrorEntries: - type: array - items: - $ref: "#/components/schemas/BatchPutMessageErrorEntry" - BatchPutMessageErrorEntry: - description: Contains information about the errors encountered. - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the "message" object.) - errorCode: - $ref: "#/components/schemas/ErrorCode" - description: The error code. - errorMessage: - $ref: "#/components/schemas/ErrorMessage" - description: A message that describes the error. - ResetAlarmActionRequests: - type: array - items: - $ref: "#/components/schemas/ResetAlarmActionRequest" - ResetAlarmActionRequest: - description: Information needed to reset the alarm. - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you reset the alarm. - required: - - requestId - - alarmModelName - BatchResetAlarmResponse: - type: object - properties: - errorEntries: - $ref: "#/components/schemas/BatchAlarmActionErrorEntries" - description: A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed. - SnoozeAlarmActionRequests: - type: array - items: - $ref: "#/components/schemas/SnoozeAlarmActionRequest" - SnoozeAlarmActionRequest: - description: Information needed to snooze the alarm. - type: object - properties: - requestId: - $ref: "#/components/schemas/RequestId" - description: The request ID. Each ID must be unique within each batch. - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you snooze the alarm. - snoozeDuration: - $ref: "#/components/schemas/SnoozeDuration" - description: The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration. - required: - - requestId - - alarmModelName - - snoozeDuration - SnoozeDuration: - type: integer - BatchSnoozeAlarmResponse: - type: object - properties: - errorEntries: - $ref: "#/components/schemas/BatchAlarmActionErrorEntries" - description: A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed. - UpdateDetectorRequests: - type: array - items: - $ref: "#/components/schemas/UpdateDetectorRequest" - UpdateDetectorRequest: - description: Information used to update the detector (instance). - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The ID to assign to the detector update "message". Each "messageId" must be unique within each batch sent. - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model that created the detectors (instances). - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance). - state: - $ref: "#/components/schemas/DetectorStateDefinition" - description: The new state, variable values, and timer settings of the detector (instance). - required: - - messageId - - detectorModelName - - state - DetectorStateDefinition: - description: The new state, variable values, and timer settings of the detector (instance). - type: object - properties: - stateName: - $ref: "#/components/schemas/StateName" - description: The name of the new state of the detector (instance). - variables: - $ref: "#/components/schemas/VariableDefinitions" - description: The new values of the detector's variables. Any variable whose value isn't specified is cleared. - timers: - $ref: "#/components/schemas/TimerDefinitions" - description: The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur. - required: - - stateName - - variables - - timers - StateName: - type: string - minLength: 1 - maxLength: 128 - VariableDefinitions: - type: array - items: - $ref: "#/components/schemas/VariableDefinition" - VariableDefinition: - description: The new value of the variable. - type: object - properties: - name: - $ref: "#/components/schemas/VariableName" - description: The name of the variable. - value: - $ref: "#/components/schemas/VariableValue" - description: The new value of the variable. - required: - - name - - value - VariableName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ - VariableValue: - type: string - minLength: 1 - maxLength: 1024 - TimerDefinitions: - type: array - items: - $ref: "#/components/schemas/TimerDefinition" - TimerDefinition: - description: The new setting of a timer. - type: object - properties: - name: - $ref: "#/components/schemas/TimerName" - description: The name of the timer. - seconds: - $ref: "#/components/schemas/Seconds" - description: The new setting of the timer (the number of seconds before the timer elapses). - required: - - name - - seconds - TimerName: - type: string - minLength: 1 - maxLength: 128 - Seconds: - type: integer - BatchUpdateDetectorResponse: - type: object - properties: - batchUpdateDetectorErrorEntries: - $ref: "#/components/schemas/BatchUpdateDetectorErrorEntries" - description: A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.) - BatchUpdateDetectorErrorEntries: - type: array - items: - $ref: "#/components/schemas/BatchUpdateDetectorErrorEntry" - BatchUpdateDetectorErrorEntry: - description: Information about the error that occurred when attempting to update a detector. - type: object - properties: - messageId: - $ref: "#/components/schemas/MessageId" - description: The "messageId" of the update request that caused the error. (The value of the "messageId" in the update request "Detector" object.) - errorCode: - $ref: "#/components/schemas/ErrorCode" - description: The error code. - errorMessage: - $ref: "#/components/schemas/ErrorMessage" - description: A message that describes the error. - DescribeAlarmResponse: - type: object - properties: - alarm: - $ref: "#/components/schemas/Alarm" - description: Contains information about an alarm. - Alarm: - description: Contains information about an alarm. - type: object - properties: - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - alarmState: - $ref: "#/components/schemas/AlarmState" - description: Contains information about the current state of the alarm. - severity: - $ref: "#/components/schemas/Severity" - description: A non-negative integer that reflects the severity level of the alarm. - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm was created, in the Unix epoch format. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm was last updated, in the Unix epoch format. - AlarmModelVersion: - type: string - minLength: 1 - maxLength: 128 - AlarmState: - description: Contains information about the current state of the alarm. - type: object - properties: - stateName: - $ref: "#/components/schemas/AlarmStateName" - description: "The name of the alarm state. The state name can be one of the following values: DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state. NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm. SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state. LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm." - ruleEvaluation: - $ref: "#/components/schemas/RuleEvaluation" - description: Information needed to evaluate data. - customerAction: - $ref: "#/components/schemas/CustomerAction" - description: Contains information about the action that you can take to respond to the alarm. - systemEvent: - $ref: "#/components/schemas/SystemEvent" - description: Contains information about alarm state changes. - AlarmStateName: - type: string - enum: - - DISABLED - - NORMAL - - ACTIVE - - ACKNOWLEDGED - - SNOOZE_DISABLED - - LATCHED - RuleEvaluation: - description: Information needed to evaluate data. - type: object - properties: - simpleRuleEvaluation: - $ref: "#/components/schemas/SimpleRuleEvaluation" - description: Information needed to compare two values with a comparison operator. - SimpleRuleEvaluation: - description: Information needed to compare two values with a comparison operator. - type: object - properties: - inputPropertyValue: - $ref: "#/components/schemas/InputPropertyValue" - description: The value of the input property, on the left side of the comparison operator. - operator: - $ref: "#/components/schemas/ComparisonOperator" - description: The comparison operator. - thresholdValue: - $ref: "#/components/schemas/ThresholdValue" - description: The threshold value, on the right side of the comparison operator. - InputPropertyValue: - type: string - ComparisonOperator: - type: string - enum: - - GREATER - - GREATER_OR_EQUAL - - LESS - - LESS_OR_EQUAL - - EQUAL - - NOT_EQUAL - ThresholdValue: - type: string - CustomerAction: - description: Contains information about the action that you can take to respond to the alarm. - type: object - properties: - actionName: - $ref: "#/components/schemas/CustomerActionName" - description: "The name of the action. The action name can be one of the following values: SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED. ENABLE - When you enable the alarm, the alarm state changes to NORMAL. DISABLE - When you disable the alarm, the alarm state changes to DISABLED. ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED. RESET - When you reset the alarm, the alarm state changes to NORMAL. For more information, see the AlarmState API." - snoozeActionConfiguration: - $ref: "#/components/schemas/SnoozeActionConfiguration" - description: Contains the configuration information of a snooze action. - enableActionConfiguration: - $ref: "#/components/schemas/EnableActionConfiguration" - description: Contains the configuration information of an enable action. - disableActionConfiguration: - $ref: "#/components/schemas/DisableActionConfiguration" - description: Contains the configuration information of a disable action. - acknowledgeActionConfiguration: - $ref: "#/components/schemas/AcknowledgeActionConfiguration" - description: Contains the configuration information of an acknowledge action. - resetActionConfiguration: - $ref: "#/components/schemas/ResetActionConfiguration" - description: Contains the configuration information of a reset action. - CustomerActionName: - type: string - enum: - - SNOOZE - - ENABLE - - DISABLE - - ACKNOWLEDGE - - RESET - SnoozeActionConfiguration: - description: Contains the configuration information of a snooze action. - type: object - properties: - snoozeDuration: - $ref: "#/components/schemas/SnoozeDuration" - description: The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration. - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you snooze the alarm. - EnableActionConfiguration: - description: Contains the configuration information of an enable action. - type: object - properties: - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you enable the alarm. - DisableActionConfiguration: - description: Contains the configuration information of a disable action. - type: object - properties: - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you disable the alarm. - AcknowledgeActionConfiguration: - description: Contains the configuration information of an acknowledge action. - type: object - properties: - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you acknowledge the alarm. - ResetActionConfiguration: - description: Contains the configuration information of a reset action. - type: object - properties: - note: - $ref: "#/components/schemas/Note" - description: The note that you can leave when you reset the alarm. - SystemEvent: - description: Contains information about alarm state changes. - type: object - properties: - eventType: - $ref: "#/components/schemas/EventType" - description: The event type. If the value is STATE_CHANGE, the event contains information about alarm state changes. - stateChangeConfiguration: - $ref: "#/components/schemas/StateChangeConfiguration" - description: Contains the configuration information of alarm state changes. - EventType: - type: string - enum: - - STATE_CHANGE - StateChangeConfiguration: - description: Contains the configuration information of alarm state changes. - type: object - properties: - triggerType: - $ref: "#/components/schemas/TriggerType" - description: The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm automatically changes to the NORMAL state. - TriggerType: - type: string - enum: - - SNOOZE_TIMEOUT - Severity: - type: integer - minimum: 0 - maximum: 2147483647 - Timestamp: - type: string - format: date-time - DescribeDetectorResponse: - type: object - properties: - detector: - $ref: "#/components/schemas/Detector" - description: Information about the detector (instance). - Detector: - description: Information about the detector (instance). - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model that created this detector (instance). - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key (identifying the device or system) that caused the creation of this detector (instance). - detectorModelVersion: - $ref: "#/components/schemas/DetectorModelVersion" - description: The version of the detector model that created this detector (instance). - state: - $ref: "#/components/schemas/DetectorState" - description: The current state of the detector (instance). - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector (instance) was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector (instance) was last updated. - DetectorModelVersion: - type: string - minLength: 1 - maxLength: 128 - DetectorState: - description: Information about the current state of the detector instance. - type: object - properties: - stateName: - $ref: "#/components/schemas/StateName" - description: The name of the state. - variables: - $ref: "#/components/schemas/Variables" - description: The current values of the detector's variables. - timers: - $ref: "#/components/schemas/Timers" - description: The current state of the detector's timers. - required: - - stateName - - variables - - timers - Variables: - type: array - items: - $ref: "#/components/schemas/Variable" - Variable: - description: The current state of the variable. - type: object - properties: - name: - $ref: "#/components/schemas/VariableName" - description: The name of the variable. - value: - $ref: "#/components/schemas/VariableValue" - description: The current value of the variable. - required: - - name - - value - Timers: - type: array - items: - $ref: "#/components/schemas/Timer" - Timer: - description: The current state of a timer. - type: object - properties: - name: - $ref: "#/components/schemas/TimerName" - description: The name of the timer. - timestamp: - $ref: "#/components/schemas/Timestamp" - description: The expiration time for the timer. - required: - - name - - timestamp - NextToken: - type: string - MaxResults: - type: integer - minimum: 1 - maximum: 250 - ListAlarmsResponse: - type: object - properties: - alarmSummaries: - $ref: "#/components/schemas/AlarmSummaries" - description: A list that summarizes each alarm. - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - AlarmSummaries: - type: array - items: - $ref: "#/components/schemas/AlarmSummary" - AlarmSummary: - description: Contains a summary of an alarm. - type: object - properties: - alarmModelName: - $ref: "#/components/schemas/AlarmModelName" - description: The name of the alarm model. - alarmModelVersion: - $ref: "#/components/schemas/AlarmModelVersion" - description: The version of the alarm model. - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key used as a filter to select only the alarms associated with the key. - stateName: - $ref: "#/components/schemas/AlarmStateName" - description: "The name of the alarm state. The state name can be one of the following values: DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state. NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm. SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state. LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm." - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm was created, in the Unix epoch format. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the alarm was last updated, in the Unix epoch format. - ListDetectorsResponse: - type: object - properties: - detectorSummaries: - $ref: "#/components/schemas/DetectorSummaries" - description: A list of summary information about the detectors (instances). - nextToken: - $ref: "#/components/schemas/NextToken" - description: The token that you can use to return the next set of results, or null if there are no more results. - DetectorSummaries: - type: array - items: - $ref: "#/components/schemas/DetectorSummary" - DetectorSummary: - description: Information about the detector (instance). - type: object - properties: - detectorModelName: - $ref: "#/components/schemas/DetectorModelName" - description: The name of the detector model that created this detector (instance). - keyValue: - $ref: "#/components/schemas/KeyValue" - description: The value of the key (identifying the device or system) that caused the creation of this detector (instance). - detectorModelVersion: - $ref: "#/components/schemas/DetectorModelVersion" - description: The version of the detector model that created this detector (instance). - state: - $ref: "#/components/schemas/DetectorStateSummary" - description: The current state of the detector (instance). - creationTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector (instance) was created. - lastUpdateTime: - $ref: "#/components/schemas/Timestamp" - description: The time the detector (instance) was last updated. - DetectorStateSummary: - description: Information about the detector state. - type: object - properties: - stateName: - $ref: "#/components/schemas/StateName" - description: The name of the state. - x-stackQL-resources: - alarms: - id: aws.iotevents_data.alarms - name: alarms - title: alarms - methods: - describe_alarm: - operation: - $ref: "#/paths/~1alarms~1{alarm_model_name}~1keyValues~1/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.alarm - request: - nativeCasing: pascal - list_alarms: - operation: - $ref: "#/paths/~1alarms~1{alarm_model_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/alarms/methods/describe_alarm" - insert: [] - update: [] - delete: [] - detectors: - id: aws.iotevents_data.detectors - name: detectors - title: detectors - methods: - describe_detector: - operation: - $ref: "#/paths/~1detectors~1{detector_model_name}~1keyValues~1/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.detector - request: - nativeCasing: pascal - list_detectors: - operation: - $ref: "#/paths/~1detectors~1{detector_model_name}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/detectors/methods/describe_detector" - insert: [] - update: [] - delete: [] diff --git a/providers/src/aws/v00.00.00000/services/iotsitewise.yaml b/providers/src/aws/v00.00.00000/services/iotsitewise.yaml index db765940..366fec61 100644 --- a/providers/src/aws/v00.00.00000/services/iotsitewise.yaml +++ b/providers/src/aws/v00.00.00000/services/iotsitewise.yaml @@ -82,10 +82,44 @@ paths: responses: "200": description: Success + /datasets/{dataset_id}/data-segments/associate: + post: + operationId: BatchAssociateDataSegmentsToDataset + description: Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the curated dataset to associate data segments with. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + associateDataSegmentEntries: + $ref: "#/components/schemas/AssociateDataSegmentEntries" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - workspaceName + - associateDataSegmentEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchAssociateDataSegmentsToDatasetResponse" /projects/{project_id}/assets/associate: post: operationId: BatchAssociateProjectAssets - description: Associates a group (batch) of assets with an IoT SiteWise Monitor project. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Associates a group (batch) of assets with an IoT SiteWise Monitor project. parameters: - name: project_id in: path @@ -113,6 +147,74 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchAssociateProjectAssetsResponse" + /datasets/{dataset_id}/data-segments/batch-delete: + post: + operationId: BatchDeleteDatasetDataSegments + description: Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the session dataset from which to delete data segments. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + deleteDataSegmentEntries: + $ref: "#/components/schemas/DeleteDataSegmentEntries" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - workspaceName + - deleteDataSegmentEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteDatasetDataSegmentsResponse" + /datasets/{dataset_id}/data-segments/disassociate: + post: + operationId: BatchDisassociateDataSegmentsFromDataset + description: Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the curated dataset to disassociate data segments from. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + disassociateDataSegmentEntries: + $ref: "#/components/schemas/DisassociateDataSegmentEntries" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - workspaceName + - disassociateDataSegmentEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDisassociateDataSegmentsFromDatasetResponse" /projects/{project_id}/assets/disassociate: post: operationId: BatchDisassociateProjectAssets @@ -248,10 +350,97 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchPutAssetPropertyValueResponse" + /workspaces/{workspace_name}/enrichment-jobs/{job_id}/cancel: + post: + operationId: CancelEnrichmentJob + description: "Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status. Behavior Jobs in PENDING or RUNNING status transition to CANCELLED Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior) The API responds immediately after recording the cancellation Cleanup of job resources happens asynchronously in the background When to Cancel Cancel a job when: The job is taking longer than expected The job was created with incorrect parameters You no longer need the results Idempotency You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace containing the enrichment job to cancel. + - name: job_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The unique identifier of the enrichment job to cancel. This is the jobId returned by CreateEnrichmentJob. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelEnrichmentJobResponse" + /workspaces/{workspace_name}/pipelines/{pipeline_name}/executions/{pipeline_execution_id}/cancel: + post: + operationId: CancelPipelineExecution + description: "Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + - name: pipeline_execution_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The unique identifier of the pipeline execution. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + reason: + $ref: "#/components/schemas/CancelPipelineExecutionRequestReasonString" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelPipelineExecutionResponse" + /workspaces/{workspace_name}/queries/{query_id}/cancel: + post: + operationId: CancelQuery + description: Cancels a running query. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace associated with the query. + - name: query_id + in: path + required: true + schema: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution to cancel. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelQueryResponse" /access-policies: post: operationId: CreateAccessPolicy - description: Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. Support for access policies that use an SSO Group as the identity is not supported at this time. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. Support for access policies that use an SSO Group as the identity is not supported at this time. parameters: [] requestBody: required: true @@ -334,6 +523,64 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAccessPoliciesResponse" + /applications: + post: + operationId: CreateApplication + description: Creates a new application for the workspace and IdC application provided + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + idcInstanceArn: + $ref: "#/components/schemas/ARN" + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + name: + $ref: "#/components/schemas/ApplicationName" + description: + $ref: "#/components/schemas/Description" + tags: + $ref: "#/components/schemas/TagMap" + required: + - idcInstanceArn + - workspaceName + - name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateApplicationResponse" + get: + operationId: ListApplications + description: Retrieves a paginated list of existing applications + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: Maximum number of results to return + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Next Page Token + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListApplicationsResponse" /assets: post: operationId: CreateAsset @@ -583,7 +830,7 @@ paths: /jobs: post: operationId: CreateBulkImportJob - description: Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. Newly ingested data in the hot tier triggers notifications and computations. After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications. Data older than 7 days does not trigger computations or notifications. + description: Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. Before you create a bulk import job that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage. Bulk import is designed to store historical data to IoT SiteWise. Newly ingested data in the hot tier triggers notifications and computations. After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications. Data older than 7 days does not trigger computations or notifications. parameters: [] requestBody: required: true @@ -593,7 +840,7 @@ paths: type: object properties: jobName: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/BulkImportJobName" jobRoleArn: $ref: "#/components/schemas/ARN" files: @@ -606,12 +853,15 @@ paths: $ref: "#/components/schemas/AdaptiveIngestion" deleteFilesAfterImport: $ref: "#/components/schemas/DeleteFilesAfterImport" + datasetId: + $ref: "#/components/schemas/ID" + workspaceName: + $ref: "#/components/schemas/WorkspaceName" required: - jobName - jobRoleArn - files - errorReportLocation - - jobConfiguration responses: "202": description: Success @@ -641,6 +891,12 @@ paths: schema: $ref: "#/components/schemas/ListBulkImportJobsFilter" description: You can use a filter to select the bulk import jobs that you want to retrieve. + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. responses: "200": description: Success @@ -715,7 +971,7 @@ paths: /dashboards: post: operationId: CreateDashboard - description: Creates a dashboard in an IoT SiteWise Monitor project. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a dashboard in an IoT SiteWise Monitor project. parameters: [] requestBody: required: true @@ -779,7 +1035,7 @@ paths: /datasets: post: operationId: CreateDataset - description: Creates a dataset to connect an external datasource. + description: Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace. parameters: [] requestBody: required: true @@ -793,7 +1049,15 @@ paths: datasetName: $ref: "#/components/schemas/RestrictedName" datasetDescription: - $ref: "#/components/schemas/RestrictedDescription" + $ref: "#/components/schemas/Description" + datasetType: + $ref: "#/components/schemas/DatasetTypeEnum" + datasetConfig: + $ref: "#/components/schemas/DatasetConfig" + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + metadata: + $ref: "#/components/schemas/Metadata" datasetSource: $ref: "#/components/schemas/DatasetSource" clientToken: @@ -820,6 +1084,18 @@ paths: schema: $ref: "#/components/schemas/DatasetSourceType" description: The type of data source for the dataset. + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace to filter datasets by. + - name: datasetType + in: query + required: false + schema: + $ref: "#/components/schemas/DatasetTypeEnum" + description: "The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource." - name: nextToken in: query required: false @@ -839,11 +1115,17 @@ paths: application/json: schema: $ref: "#/components/schemas/ListDatasetsResponse" - /20200301/gateways: + /workspaces/{workspace_name}/dataset-export-jobs: post: - operationId: CreateGateway - description: Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide. - parameters: [] + operationId: CreateDatasetExportJob + description: Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace in which to create the dataset export job. requestBody: required: true content: @@ -851,52 +1133,71 @@ paths: schema: type: object properties: - gatewayName: - $ref: "#/components/schemas/GatewayName" - gatewayPlatform: - $ref: "#/components/schemas/GatewayPlatform" - gatewayVersion: - $ref: "#/components/schemas/GatewayVersion" - tags: - $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + destinationS3Uri: + $ref: "#/components/schemas/S3Uri" + input: + $ref: "#/components/schemas/ProcessingInput" + errorReportLocation: + $ref: "#/components/schemas/ExportErrorReportLocation" required: - - gatewayName - - gatewayPlatform + - destinationS3Uri + - input + - errorReportLocation responses: - "201": + "202": description: Success content: application/json: schema: - $ref: "#/components/schemas/CreateGatewayResponse" + $ref: "#/components/schemas/CreateDatasetExportJobResponse" get: - operationId: ListGateways - description: Retrieves a paginated list of gateways. + operationId: ListDatasetExportJobs + description: Retrieves a paginated list of dataset export jobs for a workspace. parameters: - - name: nextToken + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace whose dataset export jobs should be listed. + - name: filter in: query required: false schema: - $ref: "#/components/schemas/NextToken" - description: The token to be used for the next set of paginated results. + $ref: "#/components/schemas/DatasetExportJobFilter" + description: The optional filter that returns only jobs matching the given filter value. Defaults to ALL. - name: maxResults in: query required: false schema: - $ref: "#/components/schemas/MaxResults" - description: "The maximum number of results to return for each paginated request. Default: 50" + $ref: "#/components/schemas/ListExportJobsMaxResults" + description: The maximum number of results to return for each paginated request. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListExportJobsNextToken" + description: The token to be used for the next set of paginated results. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListGatewaysResponse" - /portals: + $ref: "#/components/schemas/ListDatasetExportJobsResponse" + /workspaces/{workspace_name}/enrichment-jobs: post: - operationId: CreatePortal - description: Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide. - parameters: [] + operationId: CreateEnrichmentJob + description: "Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background. Idempotency Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate. Prerequisites Before creating a job, ensure: The workspace is in ACTIVE state (not being deleted) You have IAM permissions for the workspace, dataset, and time-series resources You have KMS Decrypt permission on the workspace's customer-managed encryption key No duplicate job (same workspace, dataset, property, and job type) is currently running Workflow Submit the job with configuration specifying which video data to analyze and the time range Capture the jobId from the response Use DescribeEnrichmentJob to monitor progress and check job status When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results For COMPLETED jobs, query IoT SiteWise for semantic search on video events Error Handling ConflictingOperationException: A duplicate job is already running for the same configuration InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified) AccessDeniedException: Insufficient IAM or KMS permissions LimitExceededException: Too many concurrent jobs or requests" + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace containing the video data to analyze. requestBody: required: true content: @@ -904,34 +1205,252 @@ paths: schema: type: object properties: - portalName: - $ref: "#/components/schemas/Name" - portalDescription: - $ref: "#/components/schemas/Description" - portalContactEmail: - $ref: "#/components/schemas/Email" + jobConfiguration: + $ref: "#/components/schemas/EnrichmentJobConfiguration" clientToken: $ref: "#/components/schemas/ClientToken" - portalLogoImageFile: - $ref: "#/components/schemas/ImageFile" - roleArn: - $ref: "#/components/schemas/IamArn" - tags: - $ref: "#/components/schemas/TagMap" - portalAuthMode: - $ref: "#/components/schemas/AuthMode" - notificationSenderEmail: - $ref: "#/components/schemas/Email" - alarms: - $ref: "#/components/schemas/Alarms" - portalType: - $ref: "#/components/schemas/PortalType" - portalTypeConfiguration: - $ref: "#/components/schemas/PortalTypeConfiguration" required: - - portalName - - portalContactEmail - - roleArn + - jobConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateEnrichmentJobResponse" + get: + operationId: ListEnrichmentJobs + description: "Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first). Filtering Combine filters to narrow results: datasetId: Filter by dataset propertyAlias OR timeSeriesId: Filter by time series (specify one, not both) status: Filter by job status (e.g., RUNNING to find active jobs) jobType: Filter by enrichment type (currently only EVENT_DETECTION) startDate and endDate: Filter by job creation time range Important Constraints You must specify either propertyAlias OR timeSeriesId, but not both Attempting to specify both results in an InvalidRequestException Date filters use ISO 8601 format startDate is exclusive, endDate is inclusive Pagination The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page. Common Use Cases Find all running jobs: Filter by status=RUNNING List recent jobs for a dataset: Filter by datasetId with optional date range Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId Track all event detection jobs: Filter by jobType=EVENT_DETECTION Performance Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType)." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace to list enrichment jobs from. + - name: datasetId + in: query + required: false + schema: + $ref: "#/components/schemas/ID" + description: Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset. + - name: propertyAlias + in: query + required: false + schema: + $ref: "#/components/schemas/AssetPropertyAlias" + description: Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId, but not both. Returns only jobs analyzing the specified property alias. + - name: timeSeriesId + in: query + required: false + schema: + $ref: "#/components/schemas/TimeSeriesId" + description: Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not both. Returns only jobs analyzing the specified time series. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/EnrichmentJobStatus" + description: Filter by job status. Returns only jobs in the specified status. Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention. + - name: jobType + in: query + required: false + schema: + $ref: "#/components/schemas/JobType" + description: Filter by enrichment job type. Currently only EVENT_DETECTION is supported. Use this filter to future-proof queries when additional job types are added. + - name: startDate + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The exclusive start of the date range for filtering jobs by creation time. Jobs created after this timestamp are included. Use ISO 8601 format (e.g., 2024-01-01T00:00:00Z). + - name: endDate + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The inclusive end of the date range for filtering jobs by creation time. Jobs created on or before this timestamp are included. Use ISO 8601 format (e.g., 2024-01-31T23:59:59Z). + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: Maximum number of jobs to return per page. Defaults to 50 if not specified. Use smaller values for faster responses, larger values to reduce API calls. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the next page of results. Omit for the first request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListEnrichmentJobsResponse" + /20200301/gateways: + post: + operationId: CreateGateway + description: Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + gatewayName: + $ref: "#/components/schemas/GatewayName" + gatewayPlatform: + $ref: "#/components/schemas/GatewayPlatform" + gatewayVersion: + $ref: "#/components/schemas/GatewayVersion" + tags: + $ref: "#/components/schemas/TagMap" + required: + - gatewayName + - gatewayPlatform + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateGatewayResponse" + get: + operationId: ListGateways + description: Retrieves a paginated list of gateways. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: "The maximum number of results to return for each paginated request. Default: 50" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListGatewaysResponse" + /workspaces/{workspace_name}/pipelines: + post: + operationId: CreatePipeline + description: Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting. You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pipelineName: + $ref: "#/components/schemas/ResourceName" + description: + $ref: "#/components/schemas/Description" + environmentVariables: + $ref: "#/components/schemas/EnvironmentVariablesMap" + computations: + $ref: "#/components/schemas/ComputeNodeList" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - pipelineName + - computations + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreatePipelineResponse" + get: + operationId: ListPipelines + description: Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListPipelinesRequestMaxResultsInteger" + description: "The maximum number of results to return for each paginated request. Default: 50." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListPipelinesResponse" + /portals: + post: + operationId: CreatePortal + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + portalName: + $ref: "#/components/schemas/Name" + portalDescription: + $ref: "#/components/schemas/Description" + portalContactEmail: + $ref: "#/components/schemas/Email" + clientToken: + $ref: "#/components/schemas/ClientToken" + portalLogoImageFile: + $ref: "#/components/schemas/ImageFile" + roleArn: + $ref: "#/components/schemas/IamArn" + tags: + $ref: "#/components/schemas/TagMap" + portalAuthMode: + $ref: "#/components/schemas/AuthMode" + notificationSenderEmail: + $ref: "#/components/schemas/Email" + alarms: + $ref: "#/components/schemas/Alarms" + portalType: + $ref: "#/components/schemas/PortalType" + portalTypeConfiguration: + $ref: "#/components/schemas/PortalTypeConfiguration" + required: + - portalName + - portalContactEmail + - roleArn responses: "202": description: Success @@ -965,7 +1484,7 @@ paths: /projects: post: operationId: CreateProject - description: Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information. parameters: [] requestBody: required: true @@ -1023,6 +1542,128 @@ paths: application/json: schema: $ref: "#/components/schemas/ListProjectsResponse" + /workspaces/{workspace_name}/tasks: + post: + operationId: CreateTask + description: Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes. Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + taskName: + $ref: "#/components/schemas/ResourceName" + description: + $ref: "#/components/schemas/Description" + taskConfiguration: + $ref: "#/components/schemas/TaskConfiguration" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - taskName + - taskConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTaskResponse" + get: + operationId: ListTasks + description: Lists tasks in a workspace. To get complete details about a task, use DescribeTask. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListTasksRequestMaxResultsInteger" + description: "The maximum number of results to return for each paginated request. Default: 50." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTasksResponse" + /workspaces: + post: + operationId: CreateWorkspace + description: Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + workspaceDescription: + $ref: "#/components/schemas/Description" + encryptionConfiguration: + $ref: "#/components/schemas/WorkspaceEncryptionConfiguration" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - workspaceName + - encryptionConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateWorkspaceResponse" + get: + operationId: ListWorkspaces + description: Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: "The maximum number of results to return for each paginated request. Default: 50." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListWorkspacesResponse" /access-policies/{access_policy_id}: delete: operationId: DeleteAccessPolicy @@ -1066,7 +1707,7 @@ paths: $ref: "#/components/schemas/DescribeAccessPolicyResponse" put: operationId: UpdateAccessPolicy - description: Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. parameters: - name: access_policy_id in: path @@ -1100,6 +1741,53 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateAccessPolicyResponse" + /workspaces/{workspace_name}/applications/{id}: + delete: + operationId: DeleteApplication + description: Deletes an application by ID + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: Name of the workspace to associate with the underlying Application + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationId" + description: ID of the Application to delete + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteApplicationResponse" + get: + operationId: DescribeApplication + description: Retrieves Application details based on the ID + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: Name of the workspace to associate with the underlying Application + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/ApplicationId" + description: ID of the Application + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeApplicationResponse" /assets/{asset_id}: delete: operationId: DeleteAsset @@ -1664,7 +2352,7 @@ paths: $ref: "#/components/schemas/DescribeDashboardResponse" put: operationId: UpdateDashboard - description: Updates an IoT SiteWise Monitor dashboard. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor dashboard. parameters: - name: dashboard_id in: path @@ -1700,7 +2388,7 @@ paths: /datasets/{dataset_id}: delete: operationId: DeleteDataset - description: Deletes a dataset. This cannot be undone. + description: Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets. parameters: - name: dataset_id in: path @@ -1708,6 +2396,12 @@ paths: schema: $ref: "#/components/schemas/ID" description: The ID of the dataset. + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset. - name: clientToken in: query required: false @@ -1731,6 +2425,18 @@ paths: schema: $ref: "#/components/schemas/ID" description: The ID of the dataset. + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset. + - name: datasetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/Version" + description: The version of the dataset. responses: "200": description: Success @@ -1755,10 +2461,16 @@ paths: schema: type: object properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" datasetName: $ref: "#/components/schemas/RestrictedName" datasetDescription: - $ref: "#/components/schemas/RestrictedDescription" + $ref: "#/components/schemas/Description" + datasetConfig: + $ref: "#/components/schemas/DatasetConfig" + metadata: + $ref: "#/components/schemas/Metadata" datasetSource: $ref: "#/components/schemas/DatasetSource" clientToken: @@ -1788,46 +2500,135 @@ paths: "200": description: Success get: - operationId: DescribeGateway - description: Retrieves information about a gateway. + operationId: DescribeGateway + description: Retrieves information about a gateway. + parameters: + - name: gateway_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the gateway device. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeGatewayResponse" + put: + operationId: UpdateGateway + description: Updates a gateway's name. + parameters: + - name: gateway_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the gateway to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + gatewayName: + $ref: "#/components/schemas/GatewayName" + required: + - gatewayName + responses: + "200": + description: Success + /workspaces/{workspace_name}/pipelines/{pipeline_name}: + delete: + operationId: DeletePipeline + description: Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeletePipelineResponse" + get: + operationId: DescribePipeline + description: Retrieves detailed information about a specific pipeline in a workspace. parameters: - - name: gateway_id + - name: workspace_name in: path required: true schema: - $ref: "#/components/schemas/ID" - description: The ID of the gateway device. + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + - name: version + in: query + required: false + schema: + $ref: "#/components/schemas/Version" + description: The version number of the pipeline to retrieve. If not specified, returns the latest version. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DescribeGatewayResponse" + $ref: "#/components/schemas/DescribePipelineResponse" put: - operationId: UpdateGateway - description: Updates a gateway's name. + operationId: UpdatePipeline + description: Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently. parameters: - - name: gateway_id + - name: workspace_name in: path required: true schema: - $ref: "#/components/schemas/ID" - description: The ID of the gateway to update. + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline to update. requestBody: - required: true + required: false content: application/json: schema: type: object properties: - gatewayName: - $ref: "#/components/schemas/GatewayName" - required: - - gatewayName + description: + $ref: "#/components/schemas/Description" + environmentVariables: + $ref: "#/components/schemas/EnvironmentVariablesMap" + computations: + $ref: "#/components/schemas/ComputeNodeList" responses: "200": description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdatePipelineResponse" /portals/{portal_id}: delete: operationId: DeletePortal @@ -1871,7 +2672,7 @@ paths: $ref: "#/components/schemas/DescribePortalResponse" put: operationId: UpdatePortal - description: Updates an IoT SiteWise Monitor portal. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor portal. parameters: - name: portal_id in: path @@ -1960,7 +2761,7 @@ paths: $ref: "#/components/schemas/DescribeProjectResponse" put: operationId: UpdateProject - description: Updates an IoT SiteWise Monitor project. + description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor project. parameters: - name: project_id in: path @@ -1990,10 +2791,97 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateProjectResponse" + /workspaces/{workspace_name}/tasks/{task_name}: + delete: + operationId: DeleteTask + description: Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: task_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the task to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteTaskResponse" + get: + operationId: DescribeTask + description: Retrieves detailed information about a specific task in a workspace. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: task_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the task. + - name: version + in: query + required: false + schema: + $ref: "#/components/schemas/Version" + description: The version number of the task to retrieve. If not specified, returns the latest version. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeTaskResponse" + put: + operationId: UpdateTask + description: Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: task_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the task to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + description: + $ref: "#/components/schemas/Description" + taskConfiguration: + $ref: "#/components/schemas/TaskConfiguration" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTaskResponse" /timeseries/delete/: post: operationId: DeleteTimeSeries - description: "Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. To identify a time series, do one of the following: If the time series isn't associated with an asset property, specify the alias of the time series. If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property." + description: "Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. You can't delete a time series until all of its data segments have been deleted from session datasets. To identify a time series, do one of the following: If the time series isn't associated with an asset property, specify the alias of the time series. If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property." parameters: - name: alias in: query @@ -2013,6 +2901,75 @@ paths: schema: $ref: "#/components/schemas/CustomID" description: "The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide." + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "200": + description: Success + /workspaces/{workspace_name}: + delete: + operationId: DeleteWorkspace + description: Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace to delete. + - name: clientToken + in: query + required: false + schema: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteWorkspaceResponse" + get: + operationId: DescribeWorkspace + description: Retrieves information about a workspace. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeWorkspaceResponse" + put: + operationId: UpdateWorkspace + description: Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace to update. requestBody: required: false content: @@ -2020,11 +2977,19 @@ paths: schema: type: object properties: + workspaceDescription: + $ref: "#/components/schemas/Description" + encryptionConfiguration: + $ref: "#/components/schemas/WorkspaceEncryptionConfiguration" clientToken: $ref: "#/components/schemas/ClientToken" responses: "200": description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateWorkspaceResponse" /actions/{action_id}: get: operationId: DescribeAction @@ -2136,6 +3101,12 @@ paths: schema: $ref: "#/components/schemas/ID" description: The ID of the job. + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. responses: "200": description: Success @@ -2173,6 +3144,30 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeComputationModelExecutionSummaryResponse" + /workspaces/{workspace_name}/dataset-export-jobs/{job_id}: + get: + operationId: DescribeDatasetExportJob + description: Retrieves information about a dataset export job. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset export job. + - name: job_id + in: path + required: true + schema: + $ref: "#/components/schemas/DatasetExportJobId" + description: The unique identifier for the dataset export job. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeDatasetExportJobResponse" /configuration/account/encryption: get: operationId: DescribeDefaultEncryptionConfiguration @@ -2209,6 +3204,30 @@ paths: application/json: schema: $ref: "#/components/schemas/PutDefaultEncryptionConfigurationResponse" + /workspaces/{workspace_name}/enrichment-jobs/{job_id}: + get: + operationId: DescribeEnrichmentJob + description: "Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps. Use Cases Monitor job progress by checking status updates with DescribeEnrichmentJob Retrieve the complete job configuration submitted during creation Debug failed jobs by examining the failureMessage field Track job lifecycle with creation, update, completion, and cancellation timestamps Status Monitoring Jobs progress through statuses: PENDING → RUNNING → terminal state Terminal states: COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results FAILED: Job encountered an error; check failureMessage for details TIMED_OUT: Job exceeded maximum processing time CANCELLED: Job was cancelled via CancelEnrichmentJob Response Fields The response includes: Current job status and type Full job configuration as originally submitted Lifecycle timestamps (created, updated, completed, cancelled) Failure details if status is FAILED" + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace containing the enrichment job. + - name: job_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeEnrichmentJobResponse" /executions/{execution_id}: get: operationId: DescribeExecution @@ -2255,7 +3274,13 @@ paths: get: operationId: DescribeLoggingOptions description: Retrieves the current IoT SiteWise logging options. - parameters: [] + parameters: + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. responses: "200": description: Success @@ -2276,6 +3301,8 @@ paths: properties: loggingOptions: $ref: "#/components/schemas/LoggingOptions" + workspaceName: + $ref: "#/components/schemas/WorkspaceName" required: - loggingOptions responses: @@ -2285,6 +3312,96 @@ paths: application/json: schema: $ref: "#/components/schemas/PutLoggingOptionsResponse" + /workspaces/{workspace_name}/pipelines/{pipeline_name}/executions/{pipeline_execution_id}: + get: + operationId: DescribePipelineExecution + description: Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + - name: pipeline_execution_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The unique identifier of the pipeline execution. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/DescribePipelineExecutionRequestMaxResultsInteger" + description: "The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribePipelineExecutionResponse" + /workspaces/{workspace_name}/queries/{query_id}: + get: + operationId: DescribeQuery + description: Retrieves information about a query, including its status. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace associated with the query. + - name: query_id + in: path + required: true + schema: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeQueryResponse" + /workspaces/{workspace_name}/searches/{search_id}: + get: + operationId: DescribeSearch + description: Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED). + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search belongs to. + - name: search_id + in: path + required: true + schema: + $ref: "#/components/schemas/SearchId" + description: The identifier of the search to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeSearchResponse" /configuration/account/storage: get: operationId: DescribeStorageConfiguration @@ -2354,6 +3471,12 @@ paths: schema: $ref: "#/components/schemas/CustomID" description: "The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide." + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. responses: "200": description: Success @@ -2708,7 +3831,47 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GetAssetPropertyValueHistoryResponse" + $ref: "#/components/schemas/GetAssetPropertyValueHistoryResponse" + /workspaces/{workspace_name}/get-capture-data: + post: + operationId: GetCaptureData + description: Retrieves video data for a specific time range. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the capture source. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + startTime: + $ref: "#/components/schemas/TimeInNanos" + endTime: + $ref: "#/components/schemas/TimeInNanos" + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + propertyAlias: + $ref: "#/components/schemas/AssetPropertyAlias" + formatSettings: + $ref: "#/components/schemas/FormatSettings" + nextToken: + $ref: "#/components/schemas/GetCaptureDataNextToken" + required: + - startTime + - endTime + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCaptureDataResponse" /properties/interpolated: get: operationId: GetInterpolatedAssetPropertyValues @@ -2799,6 +3962,78 @@ paths: application/json: schema: $ref: "#/components/schemas/GetInterpolatedAssetPropertyValuesResponse" + /workspaces/{workspace_name}/queries/{query_id}/results: + get: + operationId: GetQueryResults + description: Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace associated with the query. + - name: query_id + in: path + required: true + schema: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/QueryMaxResults" + description: The maximum number of results to return for each paginated request. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/QueryNextToken" + description: The token to be used for the next set of paginated results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetQueryResultsOutputDisplay" + /workspaces/{workspace_name}/searches/{search_id}/results: + get: + operationId: GetSearchResults + description: "Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page." + parameters: + - name: search_id + in: path + required: true + schema: + $ref: "#/components/schemas/SearchId" + description: The identifier of the search whose results are retrieved. + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search belongs to. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/GetSearchResultsRequestMaxResultsInteger" + description: The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSearchResultsResponse" /assistant/invocation: post: operationId: InvokeAssistant @@ -3069,6 +4304,84 @@ paths: application/json: schema: $ref: "#/components/schemas/ListComputationModelResolveToResourcesResponse" + /datasets/{dataset_id}/data-segment-relationships: + get: + operationId: ListDatasetDataSegmentRelationships + description: Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the session dataset to list data segment relationships for. + - name: workspaceName + in: query + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: "The maximum number of results to return for each paginated request. Default: 50." + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token to be used for the next set of paginated results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDatasetDataSegmentRelationshipsResponse" + /datasets/{dataset_id}/data-segments: + get: + operationId: ListDatasetDataSegments + description: Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results. + parameters: + - name: dataset_id + in: path + required: true + schema: + $ref: "#/components/schemas/ID" + description: The ID of the dataset. + - name: workspaceName + in: query + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset. + - name: datasetVersion + in: query + required: false + schema: + $ref: "#/components/schemas/Version" + description: The version of the dataset to list data segments for. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: "The maximum number of results to return for each paginated request. Default: 50." + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token to be used for the next set of paginated results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDatasetDataSegmentsResponse" /executions: get: operationId: ListExecutions @@ -3153,6 +4466,108 @@ paths: application/json: schema: $ref: "#/components/schemas/ListInterfaceRelationshipsResponse" + /workspaces/{workspace_name}/pipelines/{pipeline_name}/executions: + get: + operationId: ListPipelineExecutions + description: "Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListPipelineExecutionsRequestMaxResultsInteger" + description: "The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50." + - name: state + in: query + required: false + schema: + $ref: "#/components/schemas/PipelineExecutionState" + description: Filter by execution state. If not specified, executions in all states are returned. + - name: startTimeAfter + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore. + - name: startTimeBefore + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore. + - name: endTimeAfter + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states. + - name: endTimeBefore + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListPipelineExecutionsResponse" + post: + operationId: StartPipelineExecution + description: Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully. You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace containing the pipeline. + - name: pipeline_name + in: path + required: true + schema: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline to execute. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + executionEnvironmentVariableOverrides: + $ref: "#/components/schemas/ExecutionEnvironmentVariables" + executionPriority: + $ref: "#/components/schemas/ExecutionPriority" + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartPipelineExecutionResponse" /projects/{project_id}/assets: get: operationId: ListProjectAssets @@ -3183,6 +4598,103 @@ paths: application/json: schema: $ref: "#/components/schemas/ListProjectAssetsOutputDisplay" + /workspaces/{workspace_name}/queries: + get: + operationId: ListQueries + description: Retrieves a paginated list of queries for a workspace. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace to list queries for. + - name: filter + in: query + required: false + schema: + $ref: "#/components/schemas/QueryFilter" + description: "An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING." + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/QueryMaxResults" + description: The maximum number of results to return for each paginated request. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/QueryListNextToken" + description: The token to be used for the next set of paginated results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListQueriesResponse" + post: + operationId: StartQuery + description: Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data. + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace to query. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/ClientToken" + queryStatement: + $ref: "#/components/schemas/QueryString" + required: + - queryStatement + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartQueryResponse" + /workspaces/{workspace_name}/searches/list: + post: + operationId: ListSearches + description: "Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace whose searches are listed. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/ListSearchesRequestMaxResultsInteger" + nextToken: + $ref: "#/components/schemas/NextToken" + listSearchesFilters: + $ref: "#/components/schemas/ListSearchesFilters" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSearchesResponse" /tags: get: operationId: ListTagsForResource @@ -3285,15 +4797,58 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListTimeSeriesType" - description: "The type of the time series. The time series type can be one of the following values: ASSOCIATED – The time series is associated with an asset property. DISASSOCIATED – The time series isn't associated with any asset property." + $ref: "#/components/schemas/ListTimeSeriesType" + description: "The type of the time series. The time series type can be one of the following values: ASSOCIATED – The time series is associated with an asset property. DISASSOCIATED – The time series isn't associated with any asset property." + - name: workspaceName + in: query + required: false + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTimeSeriesResponse" + /workspaces/{workspace_name}/searches: + post: + operationId: StartSearch + description: "Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one." + parameters: + - name: workspace_name + in: path + required: true + schema: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace whose data is searched. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + queryStatement: + $ref: "#/components/schemas/SearchQueryStatement" + clientToken: + $ref: "#/components/schemas/ClientToken" + searchType: + $ref: "#/components/schemas/SearchType" + searchFilters: + $ref: "#/components/schemas/SearchFilters" + groupId: + $ref: "#/components/schemas/GroupId" + required: + - queryStatement responses: - "200": + "202": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListTimeSeriesResponse" + $ref: "#/components/schemas/StartSearchResponse" /20200301/gateways/{gateway_id}/capability: post: operationId: UpdateGatewayCapabilityConfiguration @@ -3390,6 +4945,127 @@ components: minLength: 36 maxLength: 36 pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + WorkspaceName: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9_-]+$ + AssociateDataSegmentEntries: + type: array + items: + $ref: "#/components/schemas/AssociateDataSegmentEntry" + AssociateDataSegmentEntry: + description: Contains information about a data segment entry to associate with a dataset. + type: object + properties: + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source dataset that contains the data segment. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment to associate. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment to associate. + required: + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + TimeSeriesId: + type: string + minLength: 36 + maxLength: 73 + TimeInNanos: + description: Contains a timestamp with optional nanosecond granularity. + type: object + properties: + timeInSeconds: + $ref: "#/components/schemas/TimeInSeconds" + description: The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos. + offsetInNanos: + $ref: "#/components/schemas/OffsetInNanos" + description: The nanosecond offset from timeInSeconds. + required: + - timeInSeconds + TimeInSeconds: + type: integer + format: int64 + minimum: 1 + maximum: 9223372036854774 + OffsetInNanos: + type: integer + minimum: 0 + maximum: 999999999 + BatchAssociateDataSegmentsToDatasetResponse: + type: object + properties: + datasetId: + $ref: "#/components/schemas/ID" + description: The ID of the dataset. + datasetVersion: + $ref: "#/components/schemas/Version" + description: The version of the dataset after association. + failedAssociations: + $ref: "#/components/schemas/FailedDataSegmentAssociations" + description: A list of data segment associations that failed. + required: + - datasetId + - datasetVersion + - failedAssociations + Version: + type: string + minLength: 1 + maxLength: 10 + pattern: ^(0|([1-9]{1}\d*))$ + FailedDataSegmentAssociations: + type: array + items: + $ref: "#/components/schemas/FailedDataSegmentAssociation" + FailedDataSegmentAssociation: + description: Contains error information for a data segment association that failed. + type: object + properties: + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source dataset. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment. + errorCode: + $ref: "#/components/schemas/DataSegmentErrorCode" + description: The error code for the failed association. + errorMessage: + $ref: "#/components/schemas/DataSegmentErrorMessage" + description: The error message for the failed association. + required: + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + - errorCode + - errorMessage + DataSegmentErrorCode: + type: string + enum: + - INTERNAL_FAILURE + - VALIDATION_ERROR + - RESOURCE_NOT_FOUND + - LIMIT_EXCEEDED + - CONFLICTING_OPERATION + DataSegmentErrorMessage: + type: string + minLength: 1 + maxLength: 2048 IDs: type: array items: @@ -3427,6 +5103,146 @@ components: - INTERNAL_FAILURE AssetErrorMessage: type: string + DeleteDataSegmentEntries: + type: array + items: + $ref: "#/components/schemas/DeleteDataSegmentEntry" + DeleteDataSegmentEntry: + description: Contains information about a data segment entry to delete. + type: object + properties: + timeSeriesId: + $ref: "#/components/schemas/ID" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment to delete. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment to delete. + required: + - timeSeriesId + - startTimestamp + - endTimestamp + BatchDeleteDatasetDataSegmentsResponse: + type: object + properties: + datasetId: + $ref: "#/components/schemas/ID" + description: The ID of the dataset. + datasetVersion: + $ref: "#/components/schemas/Version" + description: The version of the dataset after deletion. + errors: + $ref: "#/components/schemas/FailedDataSegmentDeletions" + description: A list of data segment deletions that failed. + required: + - datasetId + - datasetVersion + - errors + FailedDataSegmentDeletions: + type: array + items: + $ref: "#/components/schemas/FailedDataSegmentDeletion" + FailedDataSegmentDeletion: + description: Contains error information for a data segment deletion that failed. + type: object + properties: + timeSeriesId: + $ref: "#/components/schemas/ID" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment. + errorCode: + $ref: "#/components/schemas/DataSegmentErrorCode" + description: The error code for the failed deletion. + errorMessage: + $ref: "#/components/schemas/DataSegmentErrorMessage" + description: The error message for the failed deletion. + required: + - timeSeriesId + - startTimestamp + - endTimestamp + - errorCode + - errorMessage + DisassociateDataSegmentEntries: + type: array + items: + $ref: "#/components/schemas/DisassociateDataSegmentEntry" + DisassociateDataSegmentEntry: + description: Contains information about a data segment entry to disassociate from a dataset. + type: object + properties: + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source dataset that contains the data segment. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment to disassociate. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment to disassociate. + required: + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + BatchDisassociateDataSegmentsFromDatasetResponse: + type: object + properties: + datasetId: + $ref: "#/components/schemas/ID" + description: The ID of the dataset. + datasetVersion: + $ref: "#/components/schemas/Version" + description: The version of the dataset after disassociation. + failedDisassociations: + $ref: "#/components/schemas/FailedDataSegmentDisassociations" + description: A list of data segment disassociations that failed. + required: + - datasetId + - datasetVersion + - failedDisassociations + FailedDataSegmentDisassociations: + type: array + items: + $ref: "#/components/schemas/FailedDataSegmentDisassociation" + FailedDataSegmentDisassociation: + description: Contains error information for a data segment disassociation that failed. + type: object + properties: + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source dataset. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment. + errorCode: + $ref: "#/components/schemas/DataSegmentErrorCode" + description: The error code for the failed disassociation. + errorMessage: + $ref: "#/components/schemas/DataSegmentErrorMessage" + description: The error message for the failed disassociation. + required: + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + - errorCode + - errorMessage BatchDisassociateProjectAssetsResponse: type: object properties: @@ -3827,27 +5643,6 @@ components: - S - I - U - TimeInNanos: - description: Contains a timestamp with optional nanosecond granularity. - type: object - properties: - timeInSeconds: - $ref: "#/components/schemas/TimeInSeconds" - description: The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos. - offsetInNanos: - $ref: "#/components/schemas/OffsetInNanos" - description: The nanosecond offset from timeInSeconds. - required: - - timeInSeconds - TimeInSeconds: - type: integer - format: int64 - minimum: 1 - maximum: 9223372036854774 - OffsetInNanos: - type: integer - minimum: 0 - maximum: 999999999 BatchGetAssetPropertyValueSkippedEntries: type: array items: @@ -4112,6 +5907,86 @@ components: type: array items: $ref: "#/components/schemas/TimeInNanos" + CancelEnrichmentJobResponse: + type: object + properties: + jobId: + $ref: "#/components/schemas/ID" + description: The unique identifier of the cancelled enrichment job. + status: + $ref: "#/components/schemas/EnrichmentJobStatus" + description: The status of the enrichment job after cancellation. This will be CANCELLED, indicating the job was successfully cancelled or was already in CANCELLED state (idempotent behavior). + required: + - jobId + - status + EnrichmentJobStatus: + description: "`

`Status of an enrichment job throughout its lifecycle.

`

`Status progression: PENDING → RUNNING → {COMPLETED, FAILED, TIMED_OUT, CANCELLED}

`
    ` `
  • `PENDING: Job has been accepted and is waiting to start processing
    • `
  • `RUNNING: Job is actively processing video data to generate embeddings
    • `
  • `COMPLETED: Job finished successfully; embeddings are available in IoT SiteWise
    • `
  • `FAILED: Job encountered an error during processing
    • `
  • `TIMED_OUT: Job exceeded the maximum processing time limit
    • `
  • `CANCELLED: Job was cancelled via CancelEnrichmentJob
`

`Terminal states (job will not change status): COMPLETED, FAILED, TIMED_OUT, CANCELLED

" + type: string + enum: + - PENDING + - RUNNING + - COMPLETED + - FAILED + - TIMED_OUT + - CANCELLED + ResourceName: + description: Reusable resource name with alphanumeric, hyphen, and underscore characters. + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9_-]+" + CancelPipelineExecutionRequestReasonString: + type: string + minLength: 1 + maxLength: 1024 + CancelPipelineExecutionResponse: + description: Response structure for CancelPipelineExecution operation. + type: object + properties: + state: + $ref: "#/components/schemas/PipelineExecutionState" + description: The current execution state of the pipeline. Can only be CANCELLING or CANCELLED. + required: + - state + PipelineExecutionState: + description: The state of a pipeline execution. + type: string + enum: + - NOT_STARTED + - RUNNING + - SUCCEEDED + - FAILED + - CANCELLING + - CANCELLED + QueryId: + description: The unique identifier for a query execution. + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9-]+" + CancelQueryResponse: + description: Contains the response for the CancelQuery operation. + type: object + properties: + queryId: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the cancelled query. + status: + $ref: "#/components/schemas/QueryStatus" + description: The current query status. + required: + - queryId + - status + QueryStatus: + description: The status of a query execution. + type: string + enum: + - SUBMITTED + - RUNNING + - COMPLETED + - FAILED + - CANCELED + - CANCELING Identity: description: Contains an identity that can access an IoT SiteWise Monitor resource. Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console. type: object @@ -4225,8 +6100,62 @@ components: ARN: type: string minLength: 1 - maxLength: 1600 - pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$ + maxLength: 1600 + pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$ + ApplicationName: + description: Name of the application + type: string + minLength: 1 + maxLength: 256 + pattern: "[A-Za-z0-9](?:[A-Za-z0-9 ._()\\-]*[A-Za-z0-9._()\\-])?" + Description: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[^\\u0000-\\u001F\\u007F]+" + CreateApplicationResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/ARN" + description: ARN of the application + id: + $ref: "#/components/schemas/ApplicationId" + description: Unique identifier of the application + dnsSubdomain: + $ref: "#/components/schemas/DnsSubdomain" + description: DNS subdomain for the application + name: + $ref: "#/components/schemas/ApplicationName" + description: Name of the application + status: + $ref: "#/components/schemas/ApplicationStatus" + description: Current status of the application + required: + - arn + - id + - dnsSubdomain + - name + - status + ApplicationId: + description: Unique identifier for the application + type: string + minLength: 36 + maxLength: 36 + pattern: "[a-z0-9-]{36}" + DnsSubdomain: + description: DNS-compliant subdomain label + type: string + minLength: 1 + maxLength: 63 + pattern: "[a-z0-9]([a-z0-9-]*[a-z0-9])?" + ApplicationStatus: + description: Current status of the application + type: string + enum: + - CREATING + - ACTIVE + - DELETING Name: type: string minLength: 1 @@ -4237,11 +6166,6 @@ components: minLength: 2 maxLength: 128 pattern: "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+" - Description: - type: string - minLength: 1 - maxLength: 2048 - pattern: "[^\\u0000-\\u001F\\u007F]+" CreateAssetResponse: type: object properties: @@ -4348,7 +6272,7 @@ components: description: The name of the property definition. dataType: $ref: "#/components/schemas/PropertyDataType" - description: The data type of the property definition. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property. + description: The data type of the property definition. The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property. dataTypeSpec: $ref: "#/components/schemas/Name" description: The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type. The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models. @@ -4370,6 +6294,9 @@ components: - DOUBLE - BOOLEAN - STRUCT + - VIDEO + - ANNOTATION + - JSON PropertyUnit: type: string minLength: 1 @@ -4686,6 +6613,9 @@ components: description: The path to the composite model listing the parent composite models. assetModelStatus: $ref: "#/components/schemas/AssetModelStatus" + assetModelId: + $ref: "#/components/schemas/ID" + description: The ID of the asset model. required: - assetModelCompositeModelId - assetModelCompositeModelPath @@ -4704,6 +6634,11 @@ components: name: $ref: "#/components/schemas/Name" description: The name of the path segment. + BulkImportJobName: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[\p{L}\p{N}\p{Zs}._:/-]+$ Files: type: array items: @@ -4721,6 +6656,15 @@ components: versionId: $ref: "#/components/schemas/String" description: The version ID to identify a specific version of the Amazon S3 object that contains your data. + alias: + $ref: "#/components/schemas/AssetPropertyAlias" + description: The alias associated with the file's time series. + startTime: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time for the file data. + fileFormat: + $ref: "#/components/schemas/FileFormat" + description: The file format of the data in S3. required: - bucket - key @@ -4730,28 +6674,6 @@ components: maxLength: 63 String: type: string - ErrorReportLocation: - description: The Amazon S3 destination where errors associated with the job creation request are saved. - type: object - properties: - bucket: - $ref: "#/components/schemas/Bucket" - description: The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent. - prefix: - $ref: "#/components/schemas/String" - description: Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide. - required: - - bucket - - prefix - JobConfiguration: - description: Contains the configuration information of a job, such as the file format used to save data in Amazon S3. - type: object - properties: - fileFormat: - $ref: "#/components/schemas/FileFormat" - description: The file format of the data in S3. - required: - - fileFormat FileFormat: description: The file format of the data in S3. type: object @@ -4762,6 +6684,12 @@ components: parquet: $ref: "#/components/schemas/Parquet" description: The file is in parquet format. + mp4: + $ref: "#/components/schemas/Mp4" + description: The MP4 format configuration. + annotation: + $ref: "#/components/schemas/Annotation" + description: The annotation format configuration. Csv: description: A .CSV file. type: object @@ -4789,6 +6717,32 @@ components: Parquet: description: A parquet file. type: object + Mp4: + description: The MP4 video format configuration for bulk import files. + type: object + Annotation: + description: The annotation format configuration for bulk import files. + type: object + ErrorReportLocation: + description: The Amazon S3 destination where errors associated with the job creation request are saved. + type: object + properties: + bucket: + $ref: "#/components/schemas/Bucket" + description: The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent. + prefix: + $ref: "#/components/schemas/String" + description: Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide. + required: + - bucket + - prefix + JobConfiguration: + description: Contains the configuration information of a job, such as the file format used to save data in Amazon S3. + type: object + properties: + fileFormat: + $ref: "#/components/schemas/FileFormat" + description: The file format of the data in S3. AdaptiveIngestion: type: boolean DeleteFilesAfterImport: @@ -4800,7 +6754,7 @@ components: $ref: "#/components/schemas/ID" description: The ID of the job. jobName: - $ref: "#/components/schemas/Name" + $ref: "#/components/schemas/BulkImportJobName" description: The unique name that helps identify the job request. jobStatus: $ref: "#/components/schemas/JobStatus" @@ -4822,7 +6776,7 @@ components: type: string minLength: 1 maxLength: 256 - pattern: ^[a-zA-Z0-9 _\-#$*!@]+$ + pattern: ^[a-zA-Z0-9 _\-#$*!@.]+$ RestrictedDescription: type: string minLength: 1 @@ -4913,6 +6867,35 @@ components: required: - dashboardId - dashboardArn + DatasetTypeEnum: + type: string + enum: + - SESSION + - CURATED + - EXTERNAL + DatasetConfig: + description: Contains the configuration for a dataset. + type: object + properties: + session: + $ref: "#/components/schemas/SessionConfig" + description: The session configuration for a session-type dataset. + SessionConfig: + description: Contains the session configuration for a session-type dataset. + type: object + properties: + sessionStartTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the session. + sessionEndTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the session. + required: + - sessionStartTimestamp + - sessionEndTimestamp + Metadata: + type: object + properties: {} DatasetSource: description: The data source for the dataset. type: object @@ -4933,10 +6916,12 @@ components: type: string enum: - KENDRA + - SITEWISE DatasetSourceFormat: type: string enum: - KNOWLEDGE_BASE + - TIMESERIES SourceDetail: description: The details of the dataset source associated with the dataset. type: object @@ -4992,6 +6977,189 @@ components: - UPDATING - DELETING - FAILED + S3Uri: + description: "`

`An S3 URI identifying an object location, in the form s3://bucket/key.

" + type: string + minLength: 1 + maxLength: 1024 + pattern: s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+ + ProcessingInput: + description: "`

`Input source for processing. Specify exactly one option.

" + type: object + properties: + timeseries: + $ref: "#/components/schemas/TimeseriesList" + description: "`

`List of individual timeseries items to process.

" + dataset: + $ref: "#/components/schemas/DatasetItem" + description: "`

`A dataset containing multiple items to process.

" + TimeseriesList: + description: "`

`A list of timeseries items to process.

" + type: array + items: + $ref: "#/components/schemas/TimeseriesItem" + TimeseriesItem: + description: "`

`A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.

" + type: object + properties: + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: "`

`The unique identifier for the timeseries. Mutually exclusive with propertyAlias.

" + propertyAlias: + $ref: "#/components/schemas/AssetPropertyAlias" + description: "`

`The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.

" + trimSettings: + $ref: "#/components/schemas/TrimSettings" + description: "`

`The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.

" + formatSettings: + $ref: "#/components/schemas/FormatSettings" + description: "`

`The optional format settings for the output.

" + TrimSettings: + description: "`

`Contains settings for trimming content to a specific time range.

" + type: object + properties: + startTime: + $ref: "#/components/schemas/TimeInNanos" + description: "`

`The start time for the trim range.

" + endTime: + $ref: "#/components/schemas/TimeInNanos" + description: "`

`The end time for the trim range. Must be greater than startTime.

" + required: + - startTime + - endTime + FormatSettings: + description: "`

`Contains the output format configuration for video processing.

" + type: object + properties: + framesPerSecond: + $ref: "#/components/schemas/PositiveInteger" + description: "`

`The target frame rate for the output.

" + widthInPixels: + $ref: "#/components/schemas/PositiveInteger" + description: "`

`The target width of the output, in pixels.

" + heightInPixels: + $ref: "#/components/schemas/PositiveInteger" + description: "`

`The target height of the output, in pixels.

" + PositiveInteger: + description: "`

`A positive integer used for frames per second and video dimensions.

" + type: integer + minimum: 1 + DatasetItem: + description: "`

`A dataset to process.

" + type: object + properties: + datasetId: + $ref: "#/components/schemas/DatasetId" + description: "`

`The unique identifier for the dataset.

" + trimSettings: + $ref: "#/components/schemas/TrimSettings" + description: "`

`The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.

" + exportDataTypes: + $ref: "#/components/schemas/ExportDataTypeList" + description: "`

`The optional subset of data types to export. If omitted, all data types are exported.

" + required: + - datasetId + DatasetId: + description: Unique identifier for a dataset (UUID format) + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExportDataTypeList: + description: "`

`A subset of ExportDataType values to export.

" + type: array + items: + $ref: "#/components/schemas/ExportDataType" + ExportDataType: + description: "`

`Data types that can be exported from a dataset.

" + type: string + enum: + - VIDEO + - TELEMETRY + - ANNOTATION + ExportErrorReportLocation: + description: "`

`Contains the location where error reports will be written on failure.

" + type: object + properties: + s3Uri: + $ref: "#/components/schemas/S3Uri" + description: "`

`The S3 URI prefix for the error report.

" + required: + - s3Uri + CreateDatasetExportJobResponse: + description: Response for create dataset export job request. + type: object + properties: + jobId: + $ref: "#/components/schemas/DatasetExportJobId" + description: The unique identifier for the dataset export job. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace in which the dataset export job was created. + required: + - jobId + - workspaceName + DatasetExportJobId: + description: "`

`The unique identifier for a dataset export job.

" + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + EnrichmentJobConfiguration: + description: Configuration for the enrichment job defining which analysis type to perform on video time-series data. Currently supports event detection enrichment. Exactly one member must be specified. + type: object + properties: + eventDetection: + $ref: "#/components/schemas/EventDetection" + description: Event detection configuration that generates embeddings from video time-series data enabling natural language similarity search on events. The service processes video data and creates embeddings stored in IoT SiteWise for semantic querying. + EventDetection: + description: "`

`Configuration for event detection enrichment on video time-series data.

`

`Event detection generates embeddings from video data enabling natural language similarity search on events. This allows customers to:

`
    ` `
  • `Query video events using semantic search after enrichment completes
    • `
  • `Find relevant video segments through natural language queries
    • `
  • `Search across video time-series data stored in IoT SiteWise
`

`You must specify the dataset, exactly one time-series identifier (timeSeriesId OR propertyAlias), and trim settings defining the video time window to process.

" + type: object + properties: + datasetId: + $ref: "#/components/schemas/ID" + description: "`

`The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.

" + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: "`

`Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.

" + propertyAlias: + $ref: "#/components/schemas/AssetPropertyAlias" + description: "`

`Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.

" + trimSettings: + $ref: "#/components/schemas/EnrichmentTrimSettings" + description: "`

`Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.

" + required: + - datasetId + - trimSettings + EnrichmentTrimSettings: + description: "`

`Time range settings for extracting a specific window of video time-series data to process.

`

`Trim settings define the time bounds for enrichment and must satisfy:

`
    ` `
  • `Start and end times must be within the dataset's time bounds
    • `
  • `Trim settings retrieve fully contained data segments within the specified time range
    • `
  • `endTime must be greater than startTime
    • `
  • `Both times should represent valid data ranges in the dataset
`

`Trim settings are required to:

`
    ` `
  • `Prevent accidentally analyzing unbounded datasets
    • `
  • `Ensure predictable processing time and costs
    • `
  • `Allow focused analysis on specific time periods of interest
" + type: object + properties: + startTime: + $ref: "#/components/schemas/TimeInNanos" + description: "`

`Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.

`

`Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)

" + endTime: + $ref: "#/components/schemas/TimeInNanos" + description: "`

`End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.

" + required: + - startTime + - endTime + CreateEnrichmentJobResponse: + type: object + properties: + jobId: + $ref: "#/components/schemas/ID" + description: Unique identifier for the enrichment job. Use this ID with DescribeEnrichmentJob to monitor progress or with CancelEnrichmentJob to cancel the job. + status: + $ref: "#/components/schemas/EnrichmentJobStatus" + description: Initial status of the enrichment job, typically PENDING. The job will transition to RUNNING when processing begins, then to a terminal state (COMPLETED, FAILED, TIMED_OUT, or CANCELLED). Use DescribeEnrichmentJob to track status changes. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the enrichment job was created in ISO 8601 format. + required: + - jobId + - status + - createdAt GatewayName: type: string minLength: 1 @@ -5074,6 +7242,96 @@ components: required: - gatewayId - gatewayArn + EnvironmentVariablesMap: + description: Map of environment variables for container configuration + type: object + properties: {} + ComputeNodeList: + description: A list of compute nodes forming a pipeline DAG. + type: array + items: + $ref: "#/components/schemas/ComputeNode" + ComputeNode: + description: A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes. + type: object + properties: + computeNodeName: + $ref: "#/components/schemas/ResourceName" + description: The unique name for this compute node within the pipeline. + taskName: + $ref: "#/components/schemas/ResourceName" + description: The name of the task to execute for this compute node. + environmentVariables: + type: object + properties: {} + description: Environment variables specific to this compute node. These override pipeline-level environment variables with the same key. + dependsOn: + $ref: "#/components/schemas/ComputeNodeNameList" + description: A list of compute node names that must complete successfully before this node can start. + required: + - computeNodeName + - taskName + ComputeNodeNameList: + description: A list of compute node names for declaring dependencies. + type: array + items: + $ref: "#/components/schemas/ResourceName" + CreatePipelineResponse: + description: Response structure for CreatePipeline operation. + type: object + properties: + pipelineName: + $ref: "#/components/schemas/ResourceName" + description: The name of the created pipeline. + pipelineArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the created pipeline. + version: + $ref: "#/components/schemas/Version" + description: The version of the newly created pipeline. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the pipeline. + required: + - pipelineName + - pipelineArn + - version + - status + ResourceStatus: + description: Contains information about the current status of a resource. + type: object + properties: + error: + $ref: "#/components/schemas/ResourceError" + description: Contains associated error information, if any. + state: + $ref: "#/components/schemas/ResourceState" + description: The current status of the resource. + ResourceError: + description: Contains the details of a resource error. + type: object + properties: + code: + $ref: "#/components/schemas/ResourceErrorCode" + description: The error code. + message: + $ref: "#/components/schemas/String" + description: The error message. + ResourceErrorCode: + description: The error code. + type: string + enum: + - VALIDATION_ERROR + - INTERNAL_FAILURE + ResourceState: + description: The lifecycle state of a resource. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED Email: type: string minLength: 1 @@ -5202,20 +7460,202 @@ components: CreateProjectResponse: type: object properties: - projectId: - $ref: "#/components/schemas/ID" - description: The ID of the project. - projectArn: - $ref: "#/components/schemas/ARN" - description: The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + projectId: + $ref: "#/components/schemas/ID" + description: The ID of the project. + projectArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + required: + - projectId + - projectArn + TaskConfiguration: + description: The task execution configuration. Specify a containerTaskConfiguration for a custom container workload. + type: object + properties: + containerTaskConfiguration: + $ref: "#/components/schemas/ContainerTaskConfiguration" + description: Configuration for running a custom container image on managed compute. + ContainerTaskConfiguration: + description: Configuration for a container task, including the container image, IAM role, and compute settings. + type: object + properties: + ecrUri: + $ref: "#/components/schemas/EcrUri" + description: The Amazon ECR image URI for the task container. + taskExecutionRole: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the IAM role that grants the containerized workload permissions to access AWS resources. + processingType: + $ref: "#/components/schemas/ProcessingType" + description: The processing type for compute resources. + processingUnit: + $ref: "#/components/schemas/ProcessingUnit" + description: The processing unit allocation that determines the vCPU, memory, and GPU resources. + command: + $ref: "#/components/schemas/CommandList" + description: The command to execute in the container. + timeoutSeconds: + $ref: "#/components/schemas/TimeoutSeconds" + description: "The timeout in seconds for task execution. Default: 3600 (1 hour)." + environmentVariables: + type: object + properties: {} + description: Environment variables passed to the container at runtime. + required: + - ecrUri + - taskExecutionRole + - processingType + - processingUnit + EcrUri: + description: "The Amazon ECR image URI for the container. Supported formats: Private: {account-id}.dkr.ecr.{region}.amazonaws.com/{repository}:{tag} Public: public.ecr.aws/{registry-alias}/{repository}:{tag} Tags and digests (@sha256:...) are optional. If omitted, latest is used. The image must be accessible from the task execution role." + type: string + minLength: 1 + maxLength: 1024 + pattern: ((\d{12}\.dkr\.ecr\.[a-z0-9-]+\.[a-z.]+)|public\.ecr\.aws/[a-z][a-z0-9]+([._-][a-z0-9]+)*)/[a-z0-9]+((\.||__|_|-+)[a-z0-9]+)*(/[a-z0-9]+((\.||__|_|-+)[a-z0-9]+)*)*(:[a-zA-Z0-9._-]+|@sha256:[a-f0-9]{64})? + IamRoleArn: + description: IAM Role ARN with strict validation requiring a 12-digit account ID. https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-cn|-us-gov)?:iam::\d{12}:role/[\w+=,.@/-]+ + ProcessingType: + description: The processing type for compute resources. Determines whether the task runs on standard CPU or GPU-accelerated hardware. + type: string + enum: + - GENERIC_COMPUTE_PROCESSING + - HARDWARE_ACCELERATED_PROCESSING + ProcessingUnit: + description: The processing unit allocation that determines the vCPU, memory, and GPU resources assigned to a task. Available units depend on the processing type. + type: string + enum: + - UNITS_2 + - UNITS_4 + - UNITS_8 + - UNITS_12 + - UNITS_16 + - UNITS_24 + - UNITS_32 + - UNITS_36 + - UNITS_48 + - UNITS_60 + - UNITS_64 + - UNITS_72 + - UNITS_84 + - UNITS_96 + CommandList: + description: A list of command strings to execute in the container. + type: array + items: + $ref: "#/components/schemas/String" + TimeoutSeconds: + description: "The timeout in seconds for task execution. Default: 3600 (1 hour)." + type: integer + format: int64 + minimum: 60 + maximum: 86400 + CreateTaskResponse: + description: Response structure for CreateTask operation. + type: object + properties: + taskName: + $ref: "#/components/schemas/ResourceName" + description: The name of the created task. + taskArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the created task. + version: + $ref: "#/components/schemas/Version" + description: The version of the newly created task. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the task. + required: + - taskName + - taskArn + - version + - status + WorkspaceEncryptionConfiguration: + description: Contains the encryption configuration for a workspace. + type: object + properties: + encryptionType: + $ref: "#/components/schemas/EncryptionType" + description: The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace's customer managed key configuration becomes active, the key can't be changed. + required: + - encryptionType + EncryptionType: + type: string + enum: + - SITEWISE_DEFAULT_ENCRYPTION + - KMS_BASED_ENCRYPTION + KmsKeyId: + type: string + minLength: 1 + maxLength: 2048 + CreateWorkspaceResponse: + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + workspaceArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the workspace. + workspaceStatus: + $ref: "#/components/schemas/WorkspaceStatus" + description: The status of the workspace, which is CREATING when the operation returns. + required: + - workspaceName + - workspaceArn + - workspaceStatus + WorkspaceStatus: + description: Contains information about the current status of a workspace. + type: object + properties: + state: + $ref: "#/components/schemas/WorkspaceState" + description: The current state of the workspace. + error: + $ref: "#/components/schemas/WorkspaceErrorDetails" + description: Contains associated error information, if any. + required: + - state + WorkspaceState: + description: The current state of a workspace. The state changes as the workspace is created, updated, or deleted. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + WorkspaceErrorDetails: + description: Contains the details of an error associated with a workspace. + type: object + properties: + code: + $ref: "#/components/schemas/ErrorCode" + description: The error code. + message: + $ref: "#/components/schemas/Description" + description: The error message. required: - - projectId - - projectArn + - code + - message DeleteAccessPolicyResponse: type: object + DeleteApplicationResponse: + type: object DeleteAssetResponse: type: object properties: + assetId: + $ref: "#/components/schemas/ID" + description: The ID of the asset. assetStatus: $ref: "#/components/schemas/AssetStatus" description: The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message. @@ -5224,6 +7664,9 @@ components: DeleteAssetModelResponse: type: object properties: + assetModelId: + $ref: "#/components/schemas/ID" + description: The ID of the asset model. assetModelStatus: $ref: "#/components/schemas/AssetModelStatus" description: The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message. @@ -5234,6 +7677,9 @@ components: properties: assetModelStatus: $ref: "#/components/schemas/AssetModelStatus" + assetModelId: + $ref: "#/components/schemas/ID" + description: The ID of the asset model. required: - assetModelStatus DeleteAssetModelInterfaceRelationshipResponse: @@ -5273,6 +7719,15 @@ components: description: The status of the dataset. This contains the state and any error messages. State is DELETING after a successfull call to this API, and any associated error message. required: - datasetStatus + DeletePipelineResponse: + description: Response structure for DeletePipeline operation. + type: object + properties: + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the pipeline. + required: + - status DeletePortalResponse: type: object properties: @@ -5283,6 +7738,23 @@ components: - portalStatus DeleteProjectResponse: type: object + DeleteTaskResponse: + description: Response structure for DeleteTask operation. + type: object + properties: + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the task. + required: + - status + DeleteWorkspaceResponse: + type: object + properties: + workspaceStatus: + $ref: "#/components/schemas/WorkspaceStatus" + description: The status of the workspace after the deletion request, which is DELETING when the operation returns. + required: + - workspaceStatus DescribeAccessPolicyResponse: type: object properties: @@ -5373,6 +7845,55 @@ components: description: The ID of the asset that the resource resolves to. required: - assetId + DescribeApplicationResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/ARN" + description: ARN of the application + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the application was created + dnsSubdomain: + $ref: "#/components/schemas/DnsSubdomain" + description: DNS subdomain for the application + description: + $ref: "#/components/schemas/ApplicationDescription" + description: Description of the application + id: + $ref: "#/components/schemas/ApplicationId" + description: Unique identifier of the application + idcApplicationArn: + $ref: "#/components/schemas/ARN" + description: Identity Center Application ARN associated with this application + name: + $ref: "#/components/schemas/ApplicationName" + description: Name of the application + status: + $ref: "#/components/schemas/ApplicationStatus" + description: Current status of the application + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the application was last updated + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: Name of the workspace this application belongs to + required: + - arn + - createdAt + - dnsSubdomain + - id + - idcApplicationArn + - name + - status + - updatedAt + - workspaceName + ApplicationDescription: + description: Description of the application + type: string + minLength: 1 + maxLength: 2048 + pattern: "[a-zA-Z0-9_-]+" ExcludeProperties: type: boolean DescribeAssetResponse: @@ -5741,7 +8262,7 @@ components: description: The name of the asset model property. dataType: $ref: "#/components/schemas/PropertyDataType" - description: The data type of the asset model property. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property. + description: The data type of the asset model property. The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property. dataTypeSpec: $ref: "#/components/schemas/Name" description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type. @@ -5840,11 +8361,6 @@ components: - id - name - type_ - Version: - type: string - minLength: 1 - maxLength: 10 - pattern: ^(0|([1-9]{1}\d*))$ InterfaceDetails: type: array items: @@ -6074,7 +8590,7 @@ components: description: The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data. files: $ref: "#/components/schemas/Files" - description: The files in the specified Amazon S3 bucket that contain your data. + description: "The files in the specified Amazon S3 bucket that contain your data. You can specify up to 100 files for each bulk import job. Each file supports the following size limits: Parquet files – Up to 256 MiB. Other file formats – Up to 5 GiB." errorReportLocation: $ref: "#/components/schemas/ErrorReportLocation" description: The Amazon S3 destination where errors associated with the job creation request are saved. @@ -6093,6 +8609,12 @@ components: deleteFilesAfterImport: $ref: "#/components/schemas/DeleteFilesAfterImport" description: If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage. + datasetId: + $ref: "#/components/schemas/ID" + description: The ID of the dataset. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. required: - jobId - jobName @@ -6100,7 +8622,6 @@ components: - jobRoleArn - files - errorReportLocation - - jobConfiguration - jobCreationDate - jobLastUpdateDate ComputationModelVersionFilter: @@ -6222,8 +8743,21 @@ components: $ref: "#/components/schemas/RestrictedName" description: The name of the dataset. datasetDescription: - $ref: "#/components/schemas/RestrictedDescription" + $ref: "#/components/schemas/Description" description: A description about the dataset, and its functionality. + datasetType: + $ref: "#/components/schemas/DatasetTypeEnum" + description: "The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource." + datasetConfig: + $ref: "#/components/schemas/DatasetConfig" + description: The configuration for the dataset. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset. + metadata: + type: object + properties: {} + description: The metadata for the dataset. datasetSource: $ref: "#/components/schemas/DatasetSource" description: The data source for the dataset. @@ -6239,6 +8773,9 @@ components: datasetVersion: $ref: "#/components/schemas/Version" description: The version of the dataset. + enrichmentStatus: + $ref: "#/components/schemas/DatasetEnrichment" + description: The enrichment status of the dataset. required: - datasetId - datasetArn @@ -6248,6 +8785,76 @@ components: - datasetStatus - datasetCreationDate - datasetLastUpdateDate + DatasetEnrichment: + description: Contains the enrichment status information for a dataset across data types. + type: object + properties: + video: + $ref: "#/components/schemas/DatasetEnrichmentEntry" + description: The enrichment status for video data in the dataset. + DatasetEnrichmentEntry: + description: Contains enrichment status information for a specific data type in a dataset. + type: object + properties: + status: + $ref: "#/components/schemas/DatasetEnrichmentStatus" + description: The enrichment status of the data type in the dataset. + lastEnrichedAt: + $ref: "#/components/schemas/Timestamp" + description: The date the data was last enriched, in Unix epoch time. + required: + - status + DatasetEnrichmentStatus: + type: string + enum: + - FULLY_ENRICHED + - PARTIALLY_ENRICHED + - NOT_ENRICHED + DescribeDatasetExportJobResponse: + description: Response for describe dataset export job request. + type: object + properties: + jobId: + $ref: "#/components/schemas/DatasetExportJobId" + description: The unique identifier for the dataset export job. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace that contains the dataset export job. + status: + $ref: "#/components/schemas/DatasetExportJobStatus" + description: The current status of the dataset export job. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the job started processing. + completedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the job completed, or null if the job is still running. + destinationS3Uri: + $ref: "#/components/schemas/S3Uri" + description: The S3 URI where output clips are written. + errorReportLocation: + $ref: "#/components/schemas/ExportErrorReportLocation" + description: The location where the error report will be written on failure. + input: + $ref: "#/components/schemas/ProcessingInput" + description: The processing input that was provided in the CreateDatasetExportJob request. + required: + - jobId + - workspaceName + - status + - startedAt + - destinationS3Uri + - errorReportLocation + - input + DatasetExportJobStatus: + description: "`

`The status of a dataset export job.

" + type: string + enum: + - SUBMITTED + - RUNNING + - COMPLETED + - COMPLETED_WITH_ERRORS + - FAILED DescribeDefaultEncryptionConfigurationResponse: type: object properties: @@ -6263,11 +8870,6 @@ components: required: - encryptionType - configurationStatus - EncryptionType: - type: string - enum: - - SITEWISE_DEFAULT_ENCRYPTION - - KMS_BASED_ENCRYPTION ConfigurationStatus: description: Contains current status information for the configuration. type: object @@ -6299,6 +8901,51 @@ components: required: - code - message + DescribeEnrichmentJobResponse: + type: object + properties: + jobId: + $ref: "#/components/schemas/ID" + description: The unique identifier of the enrichment job. + status: + $ref: "#/components/schemas/EnrichmentJobStatus" + description: "Current status of the enrichment job. Possible values: PENDING: Job is waiting to start processing RUNNING: Job is actively processing video data COMPLETED: Job finished successfully; embeddings available in IoT SiteWise FAILED: Job encountered an error; see failureMessage for details TIMED_OUT: Job exceeded maximum processing time limit CANCELLED: Job was cancelled by user request" + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace containing the job. + jobType: + $ref: "#/components/schemas/JobType" + description: The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type. + jobConfiguration: + $ref: "#/components/schemas/EnrichmentJobConfiguration" + description: The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the enrichment job was created in ISO 8601 format. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity. + completedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED. + cancelledAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED. + failureMessage: + $ref: "#/components/schemas/String" + description: Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors. + required: + - jobId + - status + - workspaceName + - jobType + - jobConfiguration + - createdAt + JobType: + description: "`

`The type of enrichment job, derived from the job configuration union member

" + type: string + enum: + - EVENT_DETECTION DescribeExecutionResponse: type: object properties: @@ -6468,6 +9115,271 @@ components: - ERROR - INFO - "OFF" + DescribePipelineResponse: + description: Response structure for DescribePipeline operation. + type: object + properties: + pipelineName: + $ref: "#/components/schemas/ResourceName" + description: A unique name of the pipeline within the workspace. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + description: + $ref: "#/components/schemas/Description" + description: The description of the pipeline. + pipelineArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the pipeline. + version: + $ref: "#/components/schemas/Version" + description: The version of the pipeline. + environmentVariables: + type: object + properties: {} + description: The environment variables shared across all compute nodes in the pipeline. + computations: + $ref: "#/components/schemas/ComputeNodeList" + description: The list of compute nodes that form the pipeline DAG. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the pipeline. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline was last updated, in Unix epoch time. + required: + - pipelineName + - workspaceName + - pipelineArn + - version + - computations + - status + - createdAt + - updatedAt + PaginationToken: + description: An opaque pagination token. Pass the value returned by a previous request to retrieve the next page of results. + type: string + minLength: 1 + maxLength: 4096 + DescribePipelineExecutionRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 250 + DescribePipelineExecutionResponse: + description: Response structure for DescribePipelineExecution operation. + type: object + properties: + pipelineExecutionId: + $ref: "#/components/schemas/ID" + description: The unique identifier of the pipeline execution. + pipelineName: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + pipelineVersion: + $ref: "#/components/schemas/Version" + description: The pipeline version this execution ran against. + status: + $ref: "#/components/schemas/PipelineExecutionStatus" + description: The current execution status of the pipeline. + startTime: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline execution started, in Unix epoch time. + endTime: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline execution completed, in Unix epoch time. + requestEnvironmentVariables: + $ref: "#/components/schemas/ExecutionEnvironmentVariables" + description: The environment variables provided as input for the pipeline execution. + executionPriority: + $ref: "#/components/schemas/ExecutionPriority" + description: Scheduling priority for the execution. When not specified, defaults to lowest priority. + computeNodeExecutionDetails: + $ref: "#/components/schemas/ComputeNodeExecutionDetailsList" + description: A list of compute node execution details within this pipeline execution. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + required: + - pipelineExecutionId + - pipelineName + - workspaceName + - pipelineVersion + - status + - requestEnvironmentVariables + - computeNodeExecutionDetails + PipelineExecutionStatus: + description: Current execution status of a pipeline. + type: object + properties: + state: + $ref: "#/components/schemas/PipelineExecutionState" + description: Current state of the pipeline execution. + stateDetails: + $ref: "#/components/schemas/PipelineExecutionStateDetails" + description: Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled). + required: + - state + PipelineExecutionStateDetails: + description: Additional information about the current execution status. Populated when the execution has terminated. + type: object + properties: + code: + $ref: "#/components/schemas/PipelineErrorCode" + description: Classification of the failure. Present when the execution failed. + message: + $ref: "#/components/schemas/String" + description: Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution. + details: + $ref: "#/components/schemas/DetailedErrorList" + description: Per-step error entries to help diagnose a failed execution. Present when the execution failed. + required: + - message + PipelineErrorCode: + description: Classification of a pipeline execution failure. + type: string + enum: + - VALIDATION_ERROR + - INTERNAL_FAILURE + - EXECUTION_ERROR + - TIMED_OUT + DetailedErrorList: + description: A list of detailed pipeline error entries. + type: array + items: + $ref: "#/components/schemas/DetailedPipelineError" + DetailedPipelineError: + description: Contains a detailed error entry for granular troubleshooting of pipeline failures. + type: object + properties: + code: + $ref: "#/components/schemas/DetailedPipelineErrorCode" + description: The error code. + message: + $ref: "#/components/schemas/String" + description: The associated error message. + required: + - code + - message + DetailedPipelineErrorCode: + description: The error code for a detailed pipeline error entry. + type: string + enum: + - VALIDATION_ERROR + - INTERNAL_FAILURE + - EXECUTION_ERROR + - TIMED_OUT + ExecutionEnvironmentVariables: + description: Environment variables provided as input for a pipeline execution. + type: object + properties: + global: + type: object + properties: {} + description: Global environment variables that apply to all compute nodes in the pipeline execution. + computeNodes: + type: object + properties: {} + description: Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides. + ExecutionPriority: + description: Scheduling priority for pipeline execution. Lower values indicate higher priority. When not specified, defaults to lowest priority. + type: integer + minimum: 0 + maximum: 2 + ComputeNodeExecutionDetailsList: + description: A list of compute node execution details. + type: array + items: + $ref: "#/components/schemas/ComputeNodeExecutionDetails" + ComputeNodeExecutionDetails: + description: Contains detailed execution information for a compute node within a pipeline execution. + type: object + properties: + computeNodeName: + $ref: "#/components/schemas/ResourceName" + description: The name of the compute node. + taskName: + $ref: "#/components/schemas/ResourceName" + description: The name of the task executed for this compute node. + taskArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the task. + taskVersion: + $ref: "#/components/schemas/Version" + description: The task version that executed for this compute node. + dependsOn: + $ref: "#/components/schemas/ComputeNodeNameList" + description: A list of compute node names that this node depends on. + status: + $ref: "#/components/schemas/ComputeNodeExecutionStatus" + description: The current execution status of the compute node. + startTime: + $ref: "#/components/schemas/Timestamp" + description: The time the compute node execution started, in Unix epoch time. + endTime: + $ref: "#/components/schemas/Timestamp" + description: The time the compute node execution completed, in Unix epoch time. + executionEnvironmentVariables: + type: object + properties: {} + description: The fully resolved environment variables used for this compute node execution. + required: + - computeNodeName + - taskName + - taskArn + - taskVersion + - dependsOn + - status + ComputeNodeExecutionStatus: + description: Current execution status of a compute node within a pipeline execution. + type: object + properties: + state: + $ref: "#/components/schemas/ComputeNodeExecutionState" + description: Current state of the compute node execution. + stateDetails: + $ref: "#/components/schemas/ComputeNodeExecutionStateDetails" + description: Additional information about the compute node's failure. Populated when the compute node has failed. + required: + - state + ComputeNodeExecutionState: + description: The state of an individual compute node execution. + type: string + enum: + - NOT_STARTED + - QUEUED + - RUNNING + - SUCCEEDED + - FAILED + ComputeNodeExecutionStateDetails: + description: Additional information about a compute node that has failed. + type: object + properties: + code: + $ref: "#/components/schemas/ComputeNodeErrorCode" + description: Classification of the failure. + message: + $ref: "#/components/schemas/String" + description: Human-readable description of why the compute node failed. + details: + $ref: "#/components/schemas/DetailedErrorList" + description: Detailed error entries to help diagnose the failure. + required: + - code + - message + ComputeNodeErrorCode: + description: Classification of a compute node execution failure. + type: string + enum: + - VALIDATION_ERROR + - INTERNAL_FAILURE + - EXECUTION_ERROR + - TIMED_OUT DescribePortalResponse: type: object properties: @@ -6582,6 +9494,122 @@ components: - portalId - projectCreationDate - projectLastUpdateDate + DescribeQueryResponse: + description: Contains the response for the DescribeQuery operation. + type: object + properties: + queryId: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution. + status: + $ref: "#/components/schemas/QueryStatus" + description: The current query status. + submittedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time when the query was submitted, in Unix epoch time. + completedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED. + statistics: + $ref: "#/components/schemas/QueryStatistics" + description: The query execution statistics. This field is present when the query status is COMPLETED. + errorMessage: + $ref: "#/components/schemas/QueryErrorMessage" + description: A human-readable error description. This field is present when the query status is FAILED. + required: + - queryId + - status + - submittedAt + QueryStatistics: + description: Contains statistics about a completed query execution. + type: object + properties: + rowCount: + $ref: "#/components/schemas/Long" + description: The total number of rows returned by the query. + bytesScanned: + $ref: "#/components/schemas/Long" + description: The total number of bytes scanned during query execution. + executionTimeInMillis: + $ref: "#/components/schemas/Long" + description: The total query execution time, in milliseconds. + required: + - rowCount + - bytesScanned + - executionTimeInMillis + Long: + type: integer + format: int64 + QueryErrorMessage: + description: A human-readable error description for a failed query. + type: string + minLength: 0 + maxLength: 1024 + SearchId: + description: The unique identifier of a search, assigned by the service when the search is started. + type: string + minLength: 23 + maxLength: 36 + pattern: "[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" + DescribeSearchResponse: + description: Output of the DescribeSearch operation. + type: object + properties: + searchId: + $ref: "#/components/schemas/SearchId" + description: The unique identifier of the search. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search runs against. + status: + $ref: "#/components/schemas/SearchStatus" + description: The current status of the search. + queryStatement: + $ref: "#/components/schemas/SearchQueryStatement" + description: The natural-language query that was submitted for the search. + searchType: + $ref: "#/components/schemas/SearchType" + description: The search strategy used for the search. + statusReason: + $ref: "#/components/schemas/String" + description: A human-readable explanation of the current status. Populated when the search has FAILED. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the search was started. + groupId: + $ref: "#/components/schemas/GroupId" + description: The group identifier associated with the search, if one was supplied on the request. + required: + - searchId + - workspaceName + - status + - queryStatement + - searchType + SearchStatus: + description: The lifecycle status of a search. + type: string + enum: + - QUEUED + - RUNNING + - SUCCEEDED + - FAILED + SearchQueryStatement: + description: A natural-language query describing the data to search for. Treated as sensitive and not logged. + type: string + minLength: 1 + maxLength: 5000 + SearchType: + description: The search strategy, which trades off latency against recall. DEEP runs the full semantic and structured search for the highest-quality matches; QUICK returns faster, lower-recall results. When searchType is omitted on a request, the search defaults to QUICK. + type: string + enum: + - DEEP + - QUICK + GroupId: + description: A caller-supplied identifier used to group related searches together. + type: string + minLength: 2 + maxLength: 36 + pattern: "[a-zA-Z0-9][a-zA-Z0-9-]*" DescribeStorageConfigurationResponse: type: object properties: @@ -6677,6 +9705,46 @@ components: description: If set to true, the data is stored indefinitely in the warm tier. DisallowIngestNullNaN: type: boolean + DescribeTaskResponse: + description: Response structure for DescribeTask operation. + type: object + properties: + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + taskName: + $ref: "#/components/schemas/ResourceName" + description: The name of the task. + description: + $ref: "#/components/schemas/Description" + description: The description of the task. + taskArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the task. + version: + $ref: "#/components/schemas/Version" + description: The version of the task. + taskConfiguration: + $ref: "#/components/schemas/TaskConfiguration" + description: The task execution configuration. Contains a containerTaskConfiguration for custom container workloads. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the task. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The time the task was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time the task was last updated, in Unix epoch time. + required: + - workspaceName + - taskName + - taskArn + - version + - taskConfiguration + - status + - createdAt + - updatedAt DescribeTimeSeriesResponse: type: object properties: @@ -6707,16 +9775,57 @@ components: timeSeriesArn: $ref: "#/components/schemas/ARN" description: The ARN of the time series, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. required: - timeSeriesId - dataType - timeSeriesCreationDate - timeSeriesLastUpdateDate - timeSeriesArn - TimeSeriesId: - type: string - minLength: 36 - maxLength: 73 + DescribeWorkspaceResponse: + type: object + properties: + workspaceArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the workspace. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + workspaceDescription: + $ref: "#/components/schemas/Description" + description: The description of the workspace. + workspaceStatus: + $ref: "#/components/schemas/WorkspaceStatus" + description: The status of the workspace, which contains the state and any error message. + encryptionConfiguration: + $ref: "#/components/schemas/WorkspaceEncryptionConfigurationInfo" + description: The encryption configuration information for the workspace. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The date the workspace was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date the workspace was last updated, in Unix epoch time. + required: + - workspaceArn + - workspaceName + - workspaceStatus + - createdAt + - updatedAt + WorkspaceEncryptionConfigurationInfo: + description: Contains the encryption configuration information for a workspace. + type: object + properties: + encryptionType: + $ref: "#/components/schemas/EncryptionType" + description: The type of encryption used for the workspace. + kmsKeyArn: + $ref: "#/components/schemas/ARN" + description: The key ARN of the KMS key used for KMS encryption if encryptionType is KMS_BASED_ENCRYPTION. + required: + - encryptionType ExecuteActionResponse: type: object properties: @@ -6728,6 +9837,7 @@ components: QueryStatement: type: string minLength: 1 + maxLength: 10000 pattern: ^[\s\S]+$ ExecuteQueryNextToken: type: string @@ -6848,6 +9958,44 @@ components: description: The token for the next set of results, or null if there are no additional results. required: - assetPropertyValueHistory + GetCaptureDataNextToken: + description: Pagination token for retrieving the next chunk of video data. + type: string + minLength: 1 + maxLength: 4096 + GetCaptureDataResponse: + description: Response containing the video data. + type: object + properties: + data: + $ref: "#/components/schemas/CaptureBlob" + description: The binary video data. + startTime: + $ref: "#/components/schemas/TimeInNanos" + description: The actual start time of the returned data. + endTime: + $ref: "#/components/schemas/TimeInNanos" + description: The actual end time of the returned data. + dataType: + $ref: "#/components/schemas/VideoDataType" + description: The type of the returned data. + nextToken: + $ref: "#/components/schemas/GetCaptureDataNextToken" + description: The token used to retrieve the next chunk. Absent if no more data is available. + required: + - data + - startTime + - endTime + - dataType + CaptureBlob: + description: A binary blob containing video data. + type: string + format: byte + VideoDataType: + description: The allowed video data types. + type: string + enum: + - VIDEO-MP4 IntervalInSeconds: type: integer format: int64 @@ -6891,6 +10039,90 @@ components: required: - timestamp - value + QueryMaxResults: + description: The maximum number of results to return for each paginated request. + type: integer + minimum: 1 + maximum: 10000 + QueryNextToken: + description: Pagination token for query results. + type: string + minLength: 1 + maxLength: 4096 + GetQueryResultsRowDisplay: + type: object + properties: + row: + type: array + description: The result rows. Each row is a list of string column values, positional to match the columnInfo order. Present when the query status is COMPLETED. + GetQueryResultsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/GetQueryResultsRowDisplay" + GetSearchResultsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 10000 + GetSearchResultsResponse: + description: Output of the GetSearchResults operation. + type: object + properties: + searchResults: + $ref: "#/components/schemas/SearchResultList" + description: A page of search results, ordered by descending relevance score. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use in a subsequent GetSearchResults call to retrieve the next page. Absent when there are no more results. + required: + - searchResults + SearchResultList: + description: A list of search results, ordered by descending relevance score. + type: array + items: + $ref: "#/components/schemas/SearchResult" + SearchResult: + description: A single matching segment of time-series data returned by a search. + type: object + properties: + searchId: + $ref: "#/components/schemas/SearchId" + description: The identifier of the search that produced this result. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search ran against. + datasetId: + $ref: "#/components/schemas/DatasetId" + description: The identifier of the dataset that contains the matching data. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The identifier of the time series that contains the matching data. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The start of the matching time-series segment, in nanoseconds since the Unix epoch. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The end of the matching time-series segment, in nanoseconds since the Unix epoch. + topTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch. + score: + $ref: "#/components/schemas/Float" + description: The relevance score of this result. Higher scores indicate a stronger match. + required: + - searchId + - workspaceName + - datasetId + - timeSeriesId + - startTimestamp + - endTimestamp + - topTimestamp + - score + Float: + type: number + format: float ConversationId: type: string minLength: 36 @@ -7169,6 +10401,51 @@ components: resolveTo: $ref: "#/components/schemas/ResolveTo" description: The detailed resource this action resolves to. + ListApplicationsResponse: + type: object + properties: + nextToken: + $ref: "#/components/schemas/NextToken" + description: Next Page Token + applications: + $ref: "#/components/schemas/ApplicationList" + description: List of applications + required: + - applications + ApplicationList: + description: List of applications + type: array + items: + $ref: "#/components/schemas/ApplicationSummary" + ApplicationSummary: + description: Summary of an application for list operations + type: object + properties: + arn: + $ref: "#/components/schemas/ARN" + description: ARN of the application + id: + $ref: "#/components/schemas/ApplicationId" + description: Unique identifier of the application + name: + $ref: "#/components/schemas/ApplicationName" + description: Name of the application + status: + $ref: "#/components/schemas/ApplicationStatus" + description: Current status of the application + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the application was created + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: Name of the workspace this application belongs to + required: + - arn + - id + - name + - status + - createdAt + - workspaceName ListAssetModelCompositeModelsResponse: type: object properties: @@ -7859,6 +11136,171 @@ components: required: - id - name + ListDatasetDataSegmentRelationshipsResponse: + type: object + properties: + dataSegmentRelationshipSummaries: + $ref: "#/components/schemas/DataSegmentRelationshipSummaries" + description: A list that summarizes each data segment relationship. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no additional results. + required: + - dataSegmentRelationshipSummaries + DataSegmentRelationshipSummaries: + type: array + items: + $ref: "#/components/schemas/DataSegmentRelationshipSummary" + DataSegmentRelationshipSummary: + description: Contains summary information about a data segment relationship between a source session dataset that contains the data and a curated dataset that references it, including the time series and timestamp range. + type: object + properties: + targetDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the curated dataset that references the data segment. + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source session dataset that contains the data segment. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment. + required: + - targetDatasetId + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + ListDatasetDataSegmentsResponse: + type: object + properties: + dataSegments: + $ref: "#/components/schemas/DataSegmentSummaries" + description: A list that summarizes each data segment. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no additional results. + required: + - dataSegments + DataSegmentSummaries: + type: array + items: + $ref: "#/components/schemas/DataSegmentSummary" + DataSegmentSummary: + description: Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status. + type: object + properties: + sourceDatasetId: + $ref: "#/components/schemas/ID" + description: The ID of the source dataset that contains the data segment. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The ID of the time series. + startTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision start time of the data segment. + endTimestamp: + $ref: "#/components/schemas/TimeInNanos" + description: The nanosecond-precision end time of the data segment. + alias: + $ref: "#/components/schemas/PropertyAlias" + description: The alias of the time series. + dataType: + $ref: "#/components/schemas/PropertyDataType" + description: The data type of the time series. + enrichment: + $ref: "#/components/schemas/DataSegmentEnrichment" + description: The enrichment information for the data segment. + required: + - sourceDatasetId + - timeSeriesId + - startTimestamp + - endTimestamp + - alias + - dataType + DataSegmentEnrichment: + description: Contains enrichment status information for a data segment. + type: object + properties: + status: + $ref: "#/components/schemas/EnrichmentStatus" + description: The enrichment status of the data segment. + lastEnrichedAt: + $ref: "#/components/schemas/Timestamp" + description: The date the data segment was last enriched, in Unix epoch time. + required: + - status + EnrichmentStatus: + type: string + enum: + - ENRICHED + - NOT_ENRICHED + DatasetExportJobFilter: + description: "`

`Filter for ListDatasetExportJobs. ALL returns jobs in any status; otherwise returns jobs in the specified status.

" + type: string + enum: + - ALL + - SUBMITTED + - RUNNING + - COMPLETED + - COMPLETED_WITH_ERRORS + - FAILED + ListExportJobsMaxResults: + description: "`

`The maximum number of results to return for each paginated request.

" + type: integer + minimum: 1 + maximum: 250 + ListExportJobsNextToken: + description: "`

`The token to be used for the next set of paginated results.

" + type: string + minLength: 1 + maxLength: 4096 + ListDatasetExportJobsResponse: + description: Response for list dataset export jobs request. + type: object + properties: + jobs: + $ref: "#/components/schemas/ExportJobSummaryList" + description: A list of dataset export job summaries. + nextToken: + $ref: "#/components/schemas/ListExportJobsNextToken" + description: The token for the next set of results, or null if there are no additional results. + required: + - jobs + ExportJobSummaryList: + description: "`

`A list of dataset export job summaries.

" + type: array + items: + $ref: "#/components/schemas/ExportJobSummary" + ExportJobSummary: + description: "`

`Contains summary information about a dataset export job.

" + type: object + properties: + jobId: + $ref: "#/components/schemas/DatasetExportJobId" + description: "`

`The unique identifier for the dataset export job.

" + status: + $ref: "#/components/schemas/DatasetExportJobStatus" + description: "`

`The current status of the dataset export job.

" + startedAt: + $ref: "#/components/schemas/Timestamp" + description: "`

`The timestamp when the job started processing.

" + completedAt: + $ref: "#/components/schemas/Timestamp" + description: "`

`The timestamp when the job completed, or null if the job is still running.

" + destinationS3Uri: + $ref: "#/components/schemas/S3Uri" + description: "`

`The S3 URI where output clips are written.

" + required: + - jobId + - status + - startedAt + - destinationS3Uri ListDatasetsResponse: type: object properties: @@ -7868,6 +11310,9 @@ components: nextToken: $ref: "#/components/schemas/NextToken" description: The token for the next set of results, or null if there are no additional results. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. required: - datasetSummaries DatasetSummaries: @@ -7888,8 +11333,14 @@ components: $ref: "#/components/schemas/RestrictedName" description: The name of the dataset. description: - $ref: "#/components/schemas/RestrictedDescription" + $ref: "#/components/schemas/Description" description: A description about the dataset, and its functionality. + sourceType: + $ref: "#/components/schemas/DatasetSourceType" + description: The data source type of the dataset. + datasetType: + $ref: "#/components/schemas/DatasetTypeEnum" + description: "The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource." creationDate: $ref: "#/components/schemas/Timestamp" description: The dataset creation date, in Unix epoch time. @@ -7899,6 +11350,9 @@ components: status: $ref: "#/components/schemas/DatasetStatus" description: The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use. + enrichmentStatus: + $ref: "#/components/schemas/DatasetEnrichment" + description: The enrichment status of the dataset. required: - id - arn @@ -7907,6 +11361,59 @@ components: - creationDate - lastUpdateDate - status + ListEnrichmentJobsResponse: + type: object + properties: + jobs: + $ref: "#/components/schemas/EnrichmentJobSummaries" + description: Array of job summaries matching the filter criteria, ordered by creation time descending (newest first). Each summary includes key identifiers (jobId, datasetId, propertyAlias/timeSeriesId) and status information without the full job configuration. Use DescribeEnrichmentJob to retrieve complete details. + nextToken: + $ref: "#/components/schemas/NextToken" + description: Pagination token to retrieve the next page of results. If present, more jobs exist that match the filter criteria. Include this token in a subsequent ListEnrichmentJobs request to retrieve the next page. If absent, you have retrieved all matching jobs. + required: + - jobs + EnrichmentJobSummaries: + type: array + items: + $ref: "#/components/schemas/EnrichmentJobSummary" + EnrichmentJobSummary: + description: "Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration. Use DescribeEnrichmentJob to retrieve: Complete job configuration (trim settings, full parameters) Detailed timestamps (completedAt, cancelledAt) Failure messages for failed jobs The summary is optimized for display in lists and dashboards, providing enough information to identify and filter jobs without the overhead of full configuration details." + type: object + properties: + jobId: + $ref: "#/components/schemas/ID" + description: Unique identifier for the enrichment job. + status: + $ref: "#/components/schemas/EnrichmentJobStatus" + description: "Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention." + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the IoT SiteWise workspace containing this job. + jobType: + $ref: "#/components/schemas/JobType" + description: The type of enrichment job. Currently EVENT_DETECTION is the only supported type. + datasetId: + $ref: "#/components/schemas/ID" + description: The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset. + propertyAlias: + $ref: "#/components/schemas/AssetPropertyAlias" + description: The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes. + timeSeriesId: + $ref: "#/components/schemas/TimeSeriesId" + description: The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp when the job was created in ISO 8601 format. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status. + required: + - jobId + - status + - workspaceName + - jobType + - datasetId + - createdAt ListExecutionsResponse: type: object properties: @@ -8025,7 +11532,107 @@ components: $ref: "#/components/schemas/ID" description: The ID of the asset model that has the interface applied to it. required: - - id + - id + ListPipelineExecutionsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 250 + ListPipelineExecutionsResponse: + description: Response structure for ListPipelineExecutions operation. + type: object + properties: + pipelineExecutionSummaries: + $ref: "#/components/schemas/PipelineExecutionSummaryList" + description: A list that summarizes each pipeline execution. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + required: + - pipelineExecutionSummaries + PipelineExecutionSummaryList: + description: A list of pipeline execution summaries. + type: array + items: + $ref: "#/components/schemas/PipelineExecutionSummary" + PipelineExecutionSummary: + description: Contains summary information about a pipeline execution. + type: object + properties: + pipelineExecutionId: + $ref: "#/components/schemas/ID" + description: The unique identifier of the pipeline execution. + pipelineVersion: + $ref: "#/components/schemas/Version" + description: The pipeline version this execution ran against. + status: + $ref: "#/components/schemas/PipelineExecutionStatus" + description: The current execution status of the pipeline. + executionPriority: + $ref: "#/components/schemas/ExecutionPriority" + description: Scheduling priority for the execution. When not specified, defaults to lowest priority. + startTime: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline execution started, in Unix epoch time. + endTime: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline execution completed, in Unix epoch time. + required: + - pipelineExecutionId + - pipelineVersion + - status + ListPipelinesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 250 + ListPipelinesResponse: + description: Response structure for ListPipelines operation. + type: object + properties: + pipelineSummaries: + $ref: "#/components/schemas/PipelineSummaries" + description: A list that summarizes each pipeline in the workspace. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + required: + - pipelineSummaries + PipelineSummaries: + description: A list of pipeline summaries. + type: array + items: + $ref: "#/components/schemas/PipelineSummary" + PipelineSummary: + description: Contains summary information about a pipeline. + type: object + properties: + pipelineName: + $ref: "#/components/schemas/ResourceName" + description: The name of the pipeline. + description: + $ref: "#/components/schemas/Description" + description: The description of the pipeline. + pipelineArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the pipeline. + version: + $ref: "#/components/schemas/Version" + description: The version of the pipeline. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the pipeline. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time the pipeline was last updated, in Unix epoch time. + required: + - pipelineName + - pipelineArn + - version + - status + - createdAt + - updatedAt ListPortalsResponse: type: object properties: @@ -8124,6 +11731,142 @@ components: required: - id - name + QueryFilter: + description: Filter for ListQueries. Returns only queries with the specified status. + type: string + minLength: 1 + maxLength: 64 + QueryListNextToken: + description: Pagination token for the query list. + type: string + minLength: 1 + maxLength: 4096 + ListQueriesResponse: + description: Contains the response for the ListQueries operation. + type: object + properties: + queries: + $ref: "#/components/schemas/QuerySummaryList" + description: A list of query summaries for the workspace. + nextToken: + $ref: "#/components/schemas/QueryListNextToken" + description: The token for the next set of results, or null if there are no additional results. + required: + - queries + QuerySummaryList: + description: A list of query summaries. + type: array + items: + $ref: "#/components/schemas/QuerySummary" + QuerySummary: + description: Contains summary information about a query. + type: object + properties: + queryId: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution. + status: + $ref: "#/components/schemas/QueryStatus" + description: The current query status. + submittedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time when the query was submitted, in Unix epoch time. + completedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time when the query reached a terminal state, in Unix epoch time. + required: + - queryId + - status + - submittedAt + ListSearchesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListSearchesFilters: + description: Optional filters for ListSearches. When multiple filters are set, a search must match all of them. + type: object + properties: + statusFilter: + $ref: "#/components/schemas/SearchStatusFilterList" + description: Returns only searches whose status is one of the listed values. + startedAfter: + $ref: "#/components/schemas/Timestamp" + description: Returns only searches started at or after this time. + startedBefore: + $ref: "#/components/schemas/Timestamp" + description: Returns only searches started at or before this time. + groupIdFilter: + $ref: "#/components/schemas/GroupIdFilterList" + description: Returns only searches whose groupId is one of the listed values. + searchTypeFilter: + $ref: "#/components/schemas/SearchTypeFilterList" + description: Returns only searches whose searchType is one of the listed values. + SearchStatusFilterList: + description: A filter on search status. Matches searches whose status is any of the listed values. + type: array + items: + $ref: "#/components/schemas/SearchStatus" + GroupIdFilterList: + description: A filter on group identifier. Matches searches whose groupId is any of the listed values. + type: array + items: + $ref: "#/components/schemas/GroupId" + SearchTypeFilterList: + description: A filter on search type. Matches searches whose searchType is any of the listed values. + type: array + items: + $ref: "#/components/schemas/SearchType" + ListSearchesResponse: + description: Output of the ListSearches operation. + type: object + properties: + searchSummaries: + $ref: "#/components/schemas/SearchSummaries" + description: A page of search summaries, most recently started first. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use in a subsequent ListSearches call to retrieve the next page. Absent when there are no more searches. + required: + - searchSummaries + SearchSummaries: + description: A list of search summaries returned by ListSearches. + type: array + items: + $ref: "#/components/schemas/SearchSummary" + SearchSummary: + description: A summary of a single search as returned by ListSearches. + type: object + properties: + searchId: + $ref: "#/components/schemas/SearchId" + description: The unique identifier of the search. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search runs against. + status: + $ref: "#/components/schemas/SearchStatus" + description: The current status of the search. + queryStatement: + $ref: "#/components/schemas/SearchQueryStatement" + description: The natural-language query that was submitted for the search. + searchType: + $ref: "#/components/schemas/SearchType" + description: The search strategy used for the search. + statusReason: + $ref: "#/components/schemas/String" + description: A human-readable explanation of the current status. Populated when the search has FAILED. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The time at which the search was started. + groupId: + $ref: "#/components/schemas/GroupId" + description: The group identifier associated with the search, if one was supplied on the request. + required: + - searchId + - workspaceName + - status + - queryStatement + - searchType AmazonResourceName: type: string minLength: 1 @@ -8135,6 +11878,59 @@ components: type: object properties: {} description: The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. + ListTasksRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 250 + ListTasksResponse: + description: Response structure for ListTasks operation. + type: object + properties: + taskSummaries: + $ref: "#/components/schemas/TaskSummaries" + description: A list that summarizes each task in the workspace. + nextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token to be used for the next set of paginated results. + required: + - taskSummaries + TaskSummaries: + description: A list of task summaries. + type: array + items: + $ref: "#/components/schemas/TaskSummary" + TaskSummary: + description: Contains summary information about a task. + type: object + properties: + taskName: + $ref: "#/components/schemas/ResourceName" + description: The name of the task. + description: + $ref: "#/components/schemas/Description" + description: The description of the task. + taskArn: + $ref: "#/components/schemas/ARN" + description: The ARN of the task. + version: + $ref: "#/components/schemas/Version" + description: The version of the task. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the task. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The time the task was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The time the task was last updated, in Unix epoch time. + required: + - taskName + - taskArn + - version + - status + - createdAt + - updatedAt ListTimeSeriesType: type: string enum: @@ -8149,6 +11945,9 @@ components: nextToken: $ref: "#/components/schemas/NextToken" description: The token for the next set of results, or null if there are no additional results. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. required: - TimeSeriesSummaries TimeSeriesSummaries: @@ -8192,6 +11991,46 @@ components: - timeSeriesCreationDate - timeSeriesLastUpdateDate - timeSeriesArn + ListWorkspacesResponse: + type: object + properties: + workspaceSummaries: + $ref: "#/components/schemas/WorkspaceSummaries" + description: A list that summarizes each workspace. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no additional results. + required: + - workspaceSummaries + WorkspaceSummaries: + type: array + items: + $ref: "#/components/schemas/WorkspaceSummary" + WorkspaceSummary: + description: Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps. + type: object + properties: + name: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace. + arn: + $ref: "#/components/schemas/ARN" + description: The ARN of the workspace. + status: + $ref: "#/components/schemas/WorkspaceStatus" + description: The status of the workspace. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The date the workspace was created, in Unix epoch time. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date the workspace was last updated, in Unix epoch time. + required: + - name + - arn + - status + - createdAt + - updatedAt PropertyMappingConfiguration: description: Contains configuration options for mapping properties from an interface asset model to an asset model where the interface is applied. type: object @@ -8228,10 +12067,6 @@ components: - interfaceAssetModelId - assetModelArn - assetModelStatus - KmsKeyId: - type: string - minLength: 1 - maxLength: 2048 PutDefaultEncryptionConfigurationResponse: type: object properties: @@ -8277,6 +12112,94 @@ components: required: - storageType - configurationStatus + StartPipelineExecutionResponse: + description: Response structure for StartPipelineExecution operation. + type: object + properties: + pipelineExecutionId: + $ref: "#/components/schemas/ID" + description: The unique identifier of the created pipeline execution. + required: + - pipelineExecutionId + QueryString: + description: The SQL query statement. + type: string + minLength: 1 + maxLength: 10240 + StartQueryResponse: + description: Contains the response for the StartQuery operation. + type: object + properties: + queryId: + $ref: "#/components/schemas/QueryId" + description: The unique identifier for the query execution. + status: + $ref: "#/components/schemas/QueryStatus" + description: The initial query status. The value is always SUBMITTED upon creation. + required: + - queryId + - status + SearchFilters: + description: Optional filters that restrict a search to a subset of the workspace's data. + type: object + properties: + timeSeriesIds: + $ref: "#/components/schemas/TimeSeriesIdList" + description: Restricts the search to these time series. + datasetIds: + $ref: "#/components/schemas/DataSetIdList" + description: Restricts the search to these datasets. + timeIntervals: + $ref: "#/components/schemas/TimeIntervalList" + description: Restricts the search to these time intervals. + TimeSeriesIdList: + description: A list of time-series identifiers to restrict a search to. + type: array + items: + $ref: "#/components/schemas/TimeSeriesId" + DataSetIdList: + description: A list of dataset identifiers to restrict a search to. + type: array + items: + $ref: "#/components/schemas/DatasetId" + TimeIntervalList: + description: A list of time intervals to restrict a search to. + type: array + items: + $ref: "#/components/schemas/TimeInterval" + TimeInterval: + description: Contains a time interval with a start time and an end time. Use a time interval to restrict an operation, such as a search, to a specific time range. + type: object + properties: + startTime: + $ref: "#/components/schemas/TimeInNanos" + description: The start of the time interval. + endTime: + $ref: "#/components/schemas/TimeInNanos" + description: The end of the time interval. + required: + - startTime + - endTime + StartSearchResponse: + description: Output of the StartSearch operation. + type: object + properties: + searchId: + $ref: "#/components/schemas/SearchId" + description: The unique identifier assigned to the newly started search. + workspaceName: + $ref: "#/components/schemas/WorkspaceName" + description: The name of the workspace the search runs against. + status: + $ref: "#/components/schemas/SearchStatus" + description: The initial status of the search. A newly started search is QUEUED. + groupId: + $ref: "#/components/schemas/GroupId" + description: The group identifier associated with the search, if one was supplied on the request. + required: + - searchId + - workspaceName + - status TagResourceResponse: type: object TagKeyList: @@ -8294,6 +12217,9 @@ components: UpdateAssetResponse: type: object properties: + assetId: + $ref: "#/components/schemas/ID" + description: The ID of the asset. assetStatus: $ref: "#/components/schemas/AssetStatus" description: The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message. @@ -8302,6 +12228,9 @@ components: UpdateAssetModelResponse: type: object properties: + assetModelId: + $ref: "#/components/schemas/ID" + description: The ID of the asset model. assetModelStatus: $ref: "#/components/schemas/AssetModelStatus" description: The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message. @@ -8315,6 +12244,9 @@ components: description: The path to the composite model listing the parent composite models. assetModelStatus: $ref: "#/components/schemas/AssetModelStatus" + assetModelId: + $ref: "#/components/schemas/ID" + description: The ID of the asset model. required: - assetModelCompositeModelPath - assetModelStatus @@ -8352,6 +12284,19 @@ components: required: - capabilityNamespace - capabilitySyncStatus + UpdatePipelineResponse: + description: Response structure for UpdatePipeline operation. + type: object + properties: + version: + $ref: "#/components/schemas/Version" + description: The new version of the pipeline created by this update. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the pipeline. + required: + - version + - status Image: description: "Contains an image that is one of the following: An image file. Choose this option to upload a new image. The ID of an existing image. Choose this option to keep an existing image." type: object @@ -8371,6 +12316,27 @@ components: - portalStatus UpdateProjectResponse: type: object + UpdateTaskResponse: + description: Response structure for UpdateTask operation. + type: object + properties: + version: + $ref: "#/components/schemas/Version" + description: The new version of the task created by this update. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current lifecycle status of the task. + required: + - version + - status + UpdateWorkspaceResponse: + type: object + properties: + workspaceStatus: + $ref: "#/components/schemas/WorkspaceStatus" + description: The status of the workspace after the update, which is UPDATING when the operation returns. + required: + - workspaceStatus x-stackQL-resources: assets: id: aws.iotsitewise.assets @@ -8494,42 +12460,166 @@ components: config: requestBodyTranslate: algorithm: naive - disassociate_time_series_from_asset_property: + disassociate_time_series_from_asset_property: + operation: + $ref: "#/paths/~1timeseries~1disassociate~1/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_asset_properties: + operation: + $ref: "#/paths/~1assets~1{asset_id}~1properties/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.assetPropertySummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/asset_properties/methods/describe_asset_property" + - $ref: "#/components/x-stackQL-resources/asset_properties/methods/list_asset_properties" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/asset_properties/methods/associate_time_series_to_asset_property" + - $ref: "#/components/x-stackQL-resources/asset_properties/methods/update_asset_property" + delete: [] + workspaces: + id: aws.iotsitewise.workspaces + name: workspaces + title: workspaces + methods: + batch_associate_data_segments_to_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1data-segments~1associate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + batch_disassociate_data_segments_from_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1data-segments~1disassociate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + cancel_enrichment_job: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1enrichment-jobs~1{job_id}~1cancel/post" + response: + openAPIDocKey: "200" + mediaType: application/json + cancel_query: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1queries~1{query_id}~1cancel/post" + response: + openAPIDocKey: "202" + mediaType: application/json + create_workspace: + operation: + $ref: "#/paths/~1workspaces/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_workspaces: + operation: + $ref: "#/paths/~1workspaces/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.workspaceSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_workspace: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + describe_workspace: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_workspace: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + start_query: operation: - $ref: "#/paths/~1timeseries~1disassociate~1/post" + $ref: "#/paths/~1workspaces~1{workspace_name}~1queries/post" response: - openAPIDocKey: "200" + openAPIDocKey: "202" + mediaType: application/json request: nativeCasing: pascal config: requestBodyTranslate: algorithm: naive - list_asset_properties: + start_search: operation: - $ref: "#/paths/~1assets~1{asset_id}~1properties/get" + $ref: "#/paths/~1workspaces~1{workspace_name}~1searches/post" response: - openAPIDocKey: "200" + openAPIDocKey: "202" mediaType: application/json - objectKey: $.assetPropertySummaries request: nativeCasing: pascal config: - pagination: - requestToken: - key: nextToken - location: query - responseToken: - key: $.nextToken - location: body + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/asset_properties/methods/describe_asset_property" - - $ref: "#/components/x-stackQL-resources/asset_properties/methods/list_asset_properties" - insert: [] + - $ref: "#/components/x-stackQL-resources/workspaces/methods/describe_workspace" + - $ref: "#/components/x-stackQL-resources/workspaces/methods/list_workspaces" + insert: + - $ref: "#/components/x-stackQL-resources/workspaces/methods/create_workspace" update: - - $ref: "#/components/x-stackQL-resources/asset_properties/methods/associate_time_series_to_asset_property" - - $ref: "#/components/x-stackQL-resources/asset_properties/methods/update_asset_property" - delete: [] + - $ref: "#/components/x-stackQL-resources/workspaces/methods/update_workspace" + delete: + - $ref: "#/components/x-stackQL-resources/workspaces/methods/delete_workspace" project_assets: id: aws.iotsitewise.project_assets name: project_assets @@ -8586,6 +12676,45 @@ components: insert: [] update: [] delete: [] + dataset_data_segments: + id: aws.iotsitewise.dataset_data_segments + name: dataset_data_segments + title: dataset_data_segments + methods: + batch_delete_dataset_data_segments: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1data-segments~1batch-delete/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_dataset_data_segments: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1data-segments/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.dataSegments + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dataset_data_segments/methods/list_dataset_data_segments" + insert: [] + update: [] + delete: [] asset_property_aggregates: id: aws.iotsitewise.asset_property_aggregates name: asset_property_aggregates @@ -8698,6 +12827,96 @@ components: insert: [] update: [] delete: [] + pipelines: + id: aws.iotsitewise.pipelines + name: pipelines + title: pipelines + methods: + cancel_pipeline_execution: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}~1executions~1{pipeline_execution_id}~1cancel/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_pipeline: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_pipelines: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.pipelineSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_pipeline: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_pipeline: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_pipeline: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + start_pipeline_execution: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}~1executions/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/pipelines/methods/describe_pipeline" + - $ref: "#/components/x-stackQL-resources/pipelines/methods/list_pipelines" + insert: + - $ref: "#/components/x-stackQL-resources/pipelines/methods/create_pipeline" + update: + - $ref: "#/components/x-stackQL-resources/pipelines/methods/update_pipeline" + delete: + - $ref: "#/components/x-stackQL-resources/pipelines/methods/delete_pipeline" access_policies: id: aws.iotsitewise.access_policies name: access_policies @@ -8766,6 +12985,60 @@ components: - $ref: "#/components/x-stackQL-resources/access_policies/methods/update_access_policy" delete: - $ref: "#/components/x-stackQL-resources/access_policies/methods/delete_access_policy" + applications: + id: aws.iotsitewise.applications + name: applications + title: applications + methods: + create_application: + operation: + $ref: "#/paths/~1applications/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_applications: + operation: + $ref: "#/paths/~1applications/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.applications + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_application: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1applications~1{id}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + describe_application: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1applications~1{id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/applications/methods/describe_application" + - $ref: "#/components/x-stackQL-resources/applications/methods/list_applications" + insert: + - $ref: "#/components/x-stackQL-resources/applications/methods/create_application" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/applications/methods/delete_application" asset_models: id: aws.iotsitewise.asset_models name: asset_models @@ -8945,6 +13218,8 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/bulk_import_jobs/methods/describe_bulk_import_job" @@ -9096,24 +13371,141 @@ components: name: datasets title: datasets methods: - create_dataset: + create_dataset: + operation: + $ref: "#/paths/~1datasets/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_datasets: + operation: + $ref: "#/paths/~1datasets/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.datasetSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + describe_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_dataset: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}/put" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/datasets/methods/list_datasets" + - $ref: "#/components/x-stackQL-resources/datasets/methods/describe_dataset" + insert: + - $ref: "#/components/x-stackQL-resources/datasets/methods/create_dataset" + update: + - $ref: "#/components/x-stackQL-resources/datasets/methods/update_dataset" + delete: + - $ref: "#/components/x-stackQL-resources/datasets/methods/delete_dataset" + dataset_export_jobs: + id: aws.iotsitewise.dataset_export_jobs + name: dataset_export_jobs + title: dataset_export_jobs + methods: + create_dataset_export_job: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1dataset-export-jobs/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_dataset_export_jobs: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1dataset-export-jobs/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.jobs + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + describe_dataset_export_job: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1dataset-export-jobs~1{job_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dataset_export_jobs/methods/describe_dataset_export_job" + - $ref: "#/components/x-stackQL-resources/dataset_export_jobs/methods/list_dataset_export_jobs" + insert: + - $ref: "#/components/x-stackQL-resources/dataset_export_jobs/methods/create_dataset_export_job" + update: [] + delete: [] + enrichment_jobs: + id: aws.iotsitewise.enrichment_jobs + name: enrichment_jobs + title: enrichment_jobs + methods: + create_enrichment_job: operation: - $ref: "#/paths/~1datasets/post" + $ref: "#/paths/~1workspaces~1{workspace_name}~1enrichment-jobs/post" response: - openAPIDocKey: "202" + openAPIDocKey: "200" mediaType: application/json request: nativeCasing: pascal config: requestBodyTranslate: algorithm: naive - list_datasets: + list_enrichment_jobs: operation: - $ref: "#/paths/~1datasets/get" + $ref: "#/paths/~1workspaces~1{workspace_name}~1enrichment-jobs/get" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.datasetSummaries + objectKey: $.jobs request: nativeCasing: pascal config: @@ -9124,41 +13516,20 @@ components: responseToken: key: $.nextToken location: body - delete_dataset: - operation: - $ref: "#/paths/~1datasets~1{dataset_id}/delete" - response: - openAPIDocKey: "202" - mediaType: application/json - request: - nativeCasing: pascal - describe_dataset: + describe_enrichment_job: operation: - $ref: "#/paths/~1datasets~1{dataset_id}/get" + $ref: "#/paths/~1workspaces~1{workspace_name}~1enrichment-jobs~1{job_id}/get" response: openAPIDocKey: "200" mediaType: application/json - update_dataset: - operation: - $ref: "#/paths/~1datasets~1{dataset_id}/put" - response: - openAPIDocKey: "202" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/datasets/methods/list_datasets" - - $ref: "#/components/x-stackQL-resources/datasets/methods/describe_dataset" + - $ref: "#/components/x-stackQL-resources/enrichment_jobs/methods/describe_enrichment_job" + - $ref: "#/components/x-stackQL-resources/enrichment_jobs/methods/list_enrichment_jobs" insert: - - $ref: "#/components/x-stackQL-resources/datasets/methods/create_dataset" - update: - - $ref: "#/components/x-stackQL-resources/datasets/methods/update_dataset" - delete: - - $ref: "#/components/x-stackQL-resources/datasets/methods/delete_dataset" + - $ref: "#/components/x-stackQL-resources/enrichment_jobs/methods/create_enrichment_job" + update: [] + delete: [] gateways: id: aws.iotsitewise.gateways name: gateways @@ -9359,6 +13730,74 @@ components: - $ref: "#/components/x-stackQL-resources/projects/methods/update_project" delete: - $ref: "#/components/x-stackQL-resources/projects/methods/delete_project" + tasks: + id: aws.iotsitewise.tasks + name: tasks + title: tasks + methods: + create_task: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1tasks/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_tasks: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1tasks/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.taskSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_task: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1tasks~1{task_name}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_task: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1tasks~1{task_name}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_task: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1tasks~1{task_name}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tasks/methods/describe_task" + - $ref: "#/components/x-stackQL-resources/tasks/methods/list_tasks" + insert: + - $ref: "#/components/x-stackQL-resources/tasks/methods/create_task" + update: + - $ref: "#/components/x-stackQL-resources/tasks/methods/update_task" + delete: + - $ref: "#/components/x-stackQL-resources/tasks/methods/delete_task" asset_model_interface_relationships: id: aws.iotsitewise.asset_model_interface_relationships name: asset_model_interface_relationships @@ -9620,6 +14059,8 @@ components: openAPIDocKey: "200" mediaType: application/json objectKey: $.loggingOptions + request: + nativeCasing: pascal put_logging_options: operation: $ref: "#/paths/~1logging/put" @@ -9639,6 +14080,124 @@ components: replace: - $ref: "#/components/x-stackQL-resources/logging_options/methods/put_logging_options" delete: [] + pipeline_executions: + id: aws.iotsitewise.pipeline_executions + name: pipeline_executions + title: pipeline_executions + methods: + describe_pipeline_execution: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}~1executions~1{pipeline_execution_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.computeNodeExecutionDetails + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + list_pipeline_executions: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1pipelines~1{pipeline_name}~1executions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.pipelineExecutionSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/pipeline_executions/methods/describe_pipeline_execution" + - $ref: "#/components/x-stackQL-resources/pipeline_executions/methods/list_pipeline_executions" + insert: [] + update: [] + delete: [] + queries: + id: aws.iotsitewise.queries + name: queries + title: queries + methods: + describe_query: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1queries~1{query_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_queries: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1queries/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.queries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/queries/methods/describe_query" + - $ref: "#/components/x-stackQL-resources/queries/methods/list_queries" + insert: [] + update: [] + delete: [] + searches: + id: aws.iotsitewise.searches + name: searches + title: searches + methods: + describe_search: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1searches~1{search_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_searches: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1searches~1list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.searchSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/searches/methods/describe_search" + - $ref: "#/components/x-stackQL-resources/searches/methods/list_searches" + insert: [] + update: [] + delete: [] storage_configurations: id: aws.iotsitewise.storage_configurations name: storage_configurations @@ -9669,6 +14228,28 @@ components: replace: - $ref: "#/components/x-stackQL-resources/storage_configurations/methods/put_storage_configuration" delete: [] + capture_datas: + id: aws.iotsitewise.capture_datas + name: capture_datas + title: capture_datas + methods: + get_capture_data: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1get-capture-data/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/capture_datas/methods/get_capture_data" + insert: [] + update: [] + delete: [] interpolated_asset_property_values: id: aws.iotsitewise.interpolated_asset_property_values name: interpolated_asset_property_values @@ -9697,6 +14278,68 @@ components: insert: [] update: [] delete: [] + query_results: + id: aws.iotsitewise.query_results + name: query_results + title: query_results + methods: + get_query_results: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1queries~1{query_id}~1results/get" + response: + openAPIDocKey: "200" + mediaType: application/json + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetQueryResultsOutputDisplay" + transform: + type: golang_template_json_v0.3.0 + body: '{{- $lst := index . "rows" -}}{{- $tok := index . "nextToken" -}}{"line_items": [{{- if eq (kindOf $lst) "slice" -}}{{- range $i, $v := $lst -}}{{- if $i }},{{ end }}{"row": {{ toJson $v }}}{{- end -}}{{- end -}}]{{- if $tok }}, "nextToken": {{ toJson $tok }}{{- end }}}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/query_results/methods/get_query_results" + insert: [] + update: [] + delete: [] + search_results: + id: aws.iotsitewise.search_results + name: search_results + title: search_results + methods: + get_search_results: + operation: + $ref: "#/paths/~1workspaces~1{workspace_name}~1searches~1{search_id}~1results/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.searchResults + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/search_results/methods/get_search_results" + insert: [] + update: [] + delete: [] asset_model_properties: id: aws.iotsitewise.asset_model_properties name: asset_model_properties @@ -9867,6 +14510,34 @@ components: insert: [] update: [] delete: [] + dataset_data_segment_relationships: + id: aws.iotsitewise.dataset_data_segment_relationships + name: dataset_data_segment_relationships + title: dataset_data_segment_relationships + methods: + list_dataset_data_segment_relationships: + operation: + $ref: "#/paths/~1datasets~1{dataset_id}~1data-segment-relationships/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.dataSegmentRelationshipSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dataset_data_segment_relationships/methods/list_dataset_data_segment_relationships" + insert: [] + update: [] + delete: [] interface_relationships: id: aws.iotsitewise.interface_relationships name: interface_relationships diff --git a/providers/src/aws/v00.00.00000/services/iotwireless.yaml b/providers/src/aws/v00.00.00000/services/iotwireless.yaml index 48c4c630..f8dff8c6 100644 --- a/providers/src/aws/v00.00.00000/services/iotwireless.yaml +++ b/providers/src/aws/v00.00.00000/services/iotwireless.yaml @@ -3222,6 +3222,9 @@ components: $ref: "#/components/schemas/DlClass" ParticipatingGateways: $ref: "#/components/schemas/ParticipatingGatewaysMulticast" + DefaultSessionParameters: + $ref: "#/components/schemas/DefaultSessionParametersMulticast" + description: The default session parameters for the multicast group. DlClass: description: DlClass for LoRaWAM, valid values are ClassB and ClassC. type: string @@ -3247,6 +3250,24 @@ components: type: integer minimum: 0 maximum: 60000 + DefaultSessionParametersMulticast: + description: The default session parameters for the multicast group. + type: object + properties: + DlDr: + $ref: "#/components/schemas/DlDr" + DlFreq: + $ref: "#/components/schemas/DlFreq" + DlDr: + description: Downlink data rate. + type: integer + minimum: 0 + maximum: 15 + DlFreq: + description: Downlink frequency. + type: integer + minimum: 100000000 + maximum: 1000000000 CreateMulticastGroupResponse: type: object properties: @@ -4533,6 +4554,9 @@ components: $ref: "#/components/schemas/NumberOfDevicesInGroup" ParticipatingGateways: $ref: "#/components/schemas/ParticipatingGatewaysMulticast" + DefaultSessionParameters: + $ref: "#/components/schemas/DefaultSessionParametersMulticast" + description: The default session parameters for the multicast group. NumberOfDevicesRequested: description: Number of devices that are requested to be associated with the multicast group. type: integer @@ -4559,16 +4583,6 @@ components: PingSlotPeriod: $ref: "#/components/schemas/PingSlotPeriod" description: The PingSlotPeriod value. - DlDr: - description: Downlink data rate. - type: integer - minimum: 0 - maximum: 15 - DlFreq: - description: Downlink frequency. - type: integer - minimum: 100000000 - maximum: 1000000000 SessionStartTimeTimestamp: description: Timestamp of when the multicast group session is to start. type: string diff --git a/providers/src/aws/v00.00.00000/services/ivs.yaml b/providers/src/aws/v00.00.00000/services/ivs.yaml index 30b5243f..aaf2112f 100644 --- a/providers/src/aws/v00.00.00000/services/ivs.yaml +++ b/providers/src/aws/v00.00.00000/services/ivs.yaml @@ -101,6 +101,8 @@ paths: $ref: "#/components/schemas/AdConfigurationName" mediaTailorPlaybackConfigurations: $ref: "#/components/schemas/MediaTailorPlaybackConfigurationsList" + postRollConfiguration: + $ref: "#/components/schemas/PostRollConfiguration" tags: $ref: "#/components/schemas/Tags" required: @@ -943,6 +945,35 @@ paths: application/json: schema: $ref: "#/components/schemas/StopStreamResponse" + /UpdateAdConfiguration: + post: + operationId: UpdateAdConfiguration + description: Updates a specified ad configuration. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/AdConfigurationArn" + name: + $ref: "#/components/schemas/AdConfigurationName" + mediaTailorPlaybackConfigurations: + $ref: "#/components/schemas/MediaTailorPlaybackConfigurationsList" + postRollConfiguration: + $ref: "#/components/schemas/PostRollConfiguration" + required: + - arn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAdConfigurationResponse" /UpdateChannel: post: operationId: UpdateChannel @@ -1435,6 +1466,25 @@ components: minLength: 0 maxLength: 128 pattern: arn:aws:mediatailor:[a-z0-9-]+:[0-9]+:playbackConfiguration/[a-zA-Z0-9-]+ + PostRollConfiguration: + description: Configuration for the post-roll ad break to use for this ad configuration. + type: object + properties: + durationSeconds: + $ref: "#/components/schemas/AdDurationSeconds" + description: Duration of the post-roll ad break, in seconds. + enabled: + $ref: "#/components/schemas/Boolean" + description: Whether the post-roll ad configuration is enabled. + required: + - durationSeconds + - enabled + AdDurationSeconds: + type: integer + minimum: 1 + maximum: 300 + Boolean: + type: boolean Tags: type: object properties: {} @@ -1457,7 +1507,10 @@ components: description: Ad configuration name. Defaults to “”. mediaTailorPlaybackConfigurations: $ref: "#/components/schemas/MediaTailorPlaybackConfigurationsList" - description: List of integration configurations with media tailor resources. + description: List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens. + postRollConfiguration: + $ref: "#/components/schemas/PostRollConfiguration" + description: Configuration for the post-roll ad break to use for this ad configuration. tags: type: object properties: {} @@ -1470,8 +1523,6 @@ components: minLength: 0 maxLength: 128 pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+ - Boolean: - type: boolean CreateChannelResponse: type: object properties: @@ -1960,10 +2011,6 @@ components: properties: keyPair: $ref: "#/components/schemas/PlaybackKeyPair" - AdDurationSeconds: - type: integer - minimum: 1 - maximum: 300 InsertAdBreakResponse: type: object properties: @@ -2011,7 +2058,10 @@ components: description: Ad configuration name. Defaults to “”. mediaTailorPlaybackConfigurations: $ref: "#/components/schemas/MediaTailorPlaybackConfigurationsList" - description: List of integration configurations with media tailor resources. + description: List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens. + postRollConfiguration: + $ref: "#/components/schemas/PostRollConfiguration" + description: Configuration for the post-roll ad break to use for this ad configuration. tags: type: object properties: {} @@ -2339,6 +2389,14 @@ components: pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]+) UntagResourceResponse: type: object + UpdateAdConfigurationResponse: + type: object + properties: + adConfiguration: + $ref: "#/components/schemas/AdConfiguration" + description: Object specifying the updated ad configuration. + required: + - adConfiguration UpdateChannelResponse: type: object properties: @@ -2622,13 +2680,25 @@ components: location: body requestBodyTranslate: algorithm: naive + update_ad_configuration: + operation: + $ref: "#/paths/~1UpdateAdConfiguration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/ad_configurations/methods/get_ad_configuration" - $ref: "#/components/x-stackQL-resources/ad_configurations/methods/list_ad_configurations" insert: - $ref: "#/components/x-stackQL-resources/ad_configurations/methods/create_ad_configuration" - update: [] + update: + - $ref: "#/components/x-stackQL-resources/ad_configurations/methods/update_ad_configuration" delete: - $ref: "#/components/x-stackQL-resources/ad_configurations/methods/delete_ad_configuration" playback_restriction_policies: diff --git a/providers/src/aws/v00.00.00000/services/kafka.yaml b/providers/src/aws/v00.00.00000/services/kafka.yaml index 16c26bdf..44019c12 100644 --- a/providers/src/aws/v00.00.00000/services/kafka.yaml +++ b/providers/src/aws/v00.00.00000/services/kafka.yaml @@ -103,6 +103,83 @@ paths: application/json: schema: $ref: "#/components/schemas/ListScramSecretsOutputDisplay" + /v1/clusters/{cluster_arn}/channels: + post: + operationId: CreateChannel + description: Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg. + parameters: + - name: cluster_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the cluster. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ChannelName: + $ref: "#/components/schemas/__string" + EncryptionConfiguration: + $ref: "#/components/schemas/EncryptionConfiguration" + IcebergDestinationConfiguration: + $ref: "#/components/schemas/IcebergDestinationConfiguration" + S3DestinationConfiguration: + $ref: "#/components/schemas/S3DestinationConfiguration" + Tags: + $ref: "#/components/schemas/__mapOf__string" + TopicConfigurationList: + $ref: "#/components/schemas/__listOfTopicConfiguration" + LoggingInfo: + $ref: "#/components/schemas/ChannelLoggingInfo" + required: + - ChannelName + - TopicConfigurationList + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateChannelResponse" + get: + operationId: ListChannels + description: Returns the list of channels in a cluster. + parameters: + - name: cluster_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the cluster. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: Maximum number of channels to return in a single response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/__string" + description: If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels. + - name: topicNameFilter + in: query + required: false + schema: + $ref: "#/components/schemas/__string" + description: Filters results to channels whose topic name matches the specified value. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListChannelsResponse" /v1/clusters: post: operationId: CreateCluster @@ -473,6 +550,87 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateVpcConnectionResponse" + /v1/clusters/{cluster_arn}/channels/{channel_arn}: + delete: + operationId: DeleteChannel + description: Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes. + parameters: + - name: channel_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + - name: cluster_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the cluster. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteChannelResponse" + get: + operationId: DescribeChannel + description: Returns the current configuration and state of a channel. + parameters: + - name: channel_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + - name: cluster_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the cluster. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeChannelResponse" + put: + operationId: UpdateChannel + description: Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied. + parameters: + - name: channel_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + - name: cluster_arn + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the cluster. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + IcebergDestinationUpdate: + $ref: "#/components/schemas/IcebergDestinationUpdate" + S3DestinationUpdate: + $ref: "#/components/schemas/S3DestinationUpdate" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateChannelResponse" /v1/clusters/{cluster_arn}: delete: operationId: DeleteCluster @@ -1722,6 +1880,310 @@ components: UnprocessedScramSecrets: $ref: "#/components/schemas/__listOfUnprocessedScramSecret" description: List of errors when disassociating secrets to cluster. + EncryptionConfiguration: + description: The AWS KMS encryption configuration applied to data at rest. + type: object + properties: + KmsKeyArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data. + required: + - KmsKeyArn + IcebergDestinationConfiguration: + description: Configuration of an Apache Iceberg destination for a channel. + type: object + properties: + AppendOnly: + $ref: "#/components/schemas/__boolean" + description: Whether the destination is append-only. Must be true; updates and deletes are not supported. + Catalog: + $ref: "#/components/schemas/Catalog" + description: The AWS Glue Data Catalog and S3 Tables warehouse used by the destination. + DataFreshnessInSeconds: + $ref: "#/components/schemas/__integer" + description: "The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600." + DeadLetterQueueS3: + $ref: "#/components/schemas/DeadLetterQueueS3" + description: The Amazon S3 bucket and prefix where MSK writes records that fail to deliver. + DestinationTableList: + $ref: "#/components/schemas/__listOfDestinationTable" + description: The destination Iceberg tables. Currently exactly one table must be specified. + SchemaEvolution: + $ref: "#/components/schemas/SchemaEvolution" + description: Configuration controlling whether the destination table's schema is evolved to match incoming records. + ServiceExecutionRoleArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket. + TableCreation: + $ref: "#/components/schemas/TableCreation" + description: Configuration controlling whether MSK creates the destination table if it does not already exist. + CompressionType: + $ref: "#/components/schemas/IcebergCompressionType" + description: The compression codec for Iceberg table data files. Defaults to ZSTD. + required: + - DeadLetterQueueS3 + - DestinationTableList + - ServiceExecutionRoleArn + - SchemaEvolution + - TableCreation + - AppendOnly + __boolean: + type: boolean + Catalog: + description: Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by the Apache Iceberg destination. + type: object + properties: + CatalogArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation. + WarehouseLocation: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse. + __integer: + type: integer + DeadLetterQueueS3: + description: Configuration of the Amazon S3 bucket where records that fail to deliver are stored. + type: object + properties: + BucketArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket. + ErrorOutputPrefix: + $ref: "#/components/schemas/__string" + description: An optional prefix prepended to every dead-letter Amazon S3 object key. + ExpectedBucketOwner: + $ref: "#/components/schemas/__string" + description: Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket. + required: + - BucketArn + __listOfDestinationTable: + type: array + items: + $ref: "#/components/schemas/DestinationTable" + DestinationTable: + description: Configuration of an Apache Iceberg destination table. + type: object + properties: + DestinationDatabaseName: + $ref: "#/components/schemas/__string" + description: The name of the destination namespace (database) in the AWS Glue Data Catalog. + DestinationTableName: + $ref: "#/components/schemas/__string" + description: The name of the destination Apache Iceberg table. + PartitionSpec: + $ref: "#/components/schemas/PartitionSpec" + description: The partition specification for the destination table. + PartitionSpec: + description: Partition specification for an Apache Iceberg destination table. + type: object + properties: + PartitionStrategy: + $ref: "#/components/schemas/PartitionStrategy" + description: The partitioning strategy applied to records written to the table. + SourceList: + $ref: "#/components/schemas/__listOfPartitionSource" + description: The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp. + required: + - PartitionStrategy + PartitionStrategy: + description: The partitioning strategy used to partition records in the destination Apache Iceberg table. + type: string + enum: + - TIME_HOUR + __listOfPartitionSource: + type: array + items: + $ref: "#/components/schemas/PartitionSource" + PartitionSource: + description: A source column used by an Apache Iceberg destination table's partition specification. + type: object + properties: + SourceName: + $ref: "#/components/schemas/__string" + description: Source name. + SchemaEvolution: + description: Configuration controlling whether the Apache Iceberg destination table's schema is evolved as incoming records change. + type: object + properties: + EnableSchemaEvolution: + $ref: "#/components/schemas/__boolean" + description: Whether to allow MSK to evolve the destination table's schema. Must be false for the current release. + TableCreation: + description: Configuration controlling whether MSK creates the destination Apache Iceberg table if it does not already exist. + type: object + properties: + EnableTableCreation: + $ref: "#/components/schemas/__boolean" + description: Whether MSK creates the destination table on the customer's behalf. Must be true for the current release. + IcebergCompressionType: + description: Compression codec for Iceberg table data files. Defaults to ZSTD. + type: string + enum: + - ZSTD + - SNAPPY + S3DestinationConfiguration: + description: Configuration of an Amazon S3 destination for a channel. + type: object + properties: + DataFreshnessInSeconds: + $ref: "#/components/schemas/__integer" + description: "The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600." + DeadLetterQueueS3: + $ref: "#/components/schemas/DeadLetterQueueS3" + description: The Amazon S3 bucket and prefix where MSK writes records that fail to deliver. + ServiceExecutionRoleArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket. + Storage: + $ref: "#/components/schemas/S3Storage" + description: The Amazon S3 bucket, prefix, and storage class for delivered records. + required: + - Storage + - ServiceExecutionRoleArn + - DeadLetterQueueS3 + S3Storage: + description: Storage configuration for an Amazon S3 destination bucket. + type: object + properties: + BucketArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the destination Amazon S3 bucket. + CompressionType: + $ref: "#/components/schemas/S3CompressionType" + description: The compression codec applied to delivered Amazon S3 objects. + OutputPrefix: + $ref: "#/components/schemas/__string" + description: An optional prefix prepended to every Amazon S3 object key written by the channel. + OutputKeyTemplate: + $ref: "#/components/schemas/__string" + description: An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}. + StorageClass: + $ref: "#/components/schemas/S3StorageClass" + description: The Amazon S3 storage class for delivered objects. + ExpectedBucketOwner: + $ref: "#/components/schemas/__string" + description: Optional 12-digit AWS account ID expected to own the Amazon S3 bucket. + required: + - BucketArn + - StorageClass + - CompressionType + S3CompressionType: + description: The compression codec applied to delivered Amazon S3 objects. + type: string + enum: + - NONE + - GZIP + - ZSTD + S3StorageClass: + description: The Amazon S3 storage class applied to delivered objects. + type: string + enum: + - STANDARD + - INTELLIGENT_TIERING + - GLACIER_IR + __mapOf__string: + type: object + properties: {} + __listOfTopicConfiguration: + type: array + items: + $ref: "#/components/schemas/TopicConfiguration" + TopicConfiguration: + description: Configuration of an Apache Kafka topic that feeds a channel. + type: object + properties: + RecordConverter: + $ref: "#/components/schemas/RecordConverter" + description: Configuration that controls how Apache Kafka record values are deserialized for the destination. + RecordSchema: + $ref: "#/components/schemas/RecordSchema" + description: The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR). + TopicArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the topic. + required: + - RecordConverter + - TopicArn + RecordConverter: + description: Configuration that controls how Apache Kafka record values are deserialized for the destination. + type: object + properties: + ValueConverter: + $ref: "#/components/schemas/ValueConverter" + description: The deserialization format applied to Apache Kafka record values. + required: + - ValueConverter + ValueConverter: + description: The deserialization format applied to Apache Kafka record values. + type: string + enum: + - BYTE_ARRAY + - JSON + - JSON_SCHEMA_GSR + - STRING + RecordSchema: + description: Schema configuration that controls how Apache Kafka record values are validated. + type: object + properties: + GsrArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table. + required: + - GsrArn + ChannelLoggingInfo: + description: Configuration for the destinations to which the channel publishes operational logs. + type: object + properties: + CloudWatchLogs: + $ref: "#/components/schemas/CloudWatchLogs" + description: Details of the CloudWatch Logs destination for Channel logs. + Firehose: + $ref: "#/components/schemas/Firehose" + description: Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs. + S3: + $ref: "#/components/schemas/S3" + description: Details of the Amazon S3 destination for Channel logs. + CloudWatchLogs: + type: object + properties: + Enabled: + $ref: "#/components/schemas/__boolean" + LogGroup: + $ref: "#/components/schemas/__string" + required: + - Enabled + Firehose: + type: object + properties: + DeliveryStream: + $ref: "#/components/schemas/__string" + Enabled: + $ref: "#/components/schemas/__boolean" + required: + - Enabled + S3: + type: object + properties: + Bucket: + $ref: "#/components/schemas/__string" + Enabled: + $ref: "#/components/schemas/__boolean" + Prefix: + $ref: "#/components/schemas/__string" + required: + - Enabled + CreateChannelResponse: + description: Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous create. + type: object + properties: + ChannelArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + ClusterOperationArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the cluster operation. + required: + - ChannelArn BrokerNodeGroupInfo: description: Describes the setup to be used for Apache Kafka broker nodes in the cluster. type: object @@ -1786,10 +2248,6 @@ components: VolumeThroughput: $ref: "#/components/schemas/__integer" description: Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. - __boolean: - type: boolean - __integer: - type: integer __integerMin1Max16384: type: integer minimum: 1 @@ -2042,55 +2500,39 @@ components: LoggingInfo: type: object properties: + AuthorizerLogs: + $ref: "#/components/schemas/AuthorizerLogs" + description: You can configure your MSK cluster to send authorizer logs to different destination types. BrokerLogs: $ref: "#/components/schemas/BrokerLogs" required: - BrokerLogs - BrokerLogs: + AuthorizerLogs: + description: The authorizer logs configuration for this MSK cluster. type: object properties: CloudWatchLogs: $ref: "#/components/schemas/CloudWatchLogs" + description: Details of the CloudWatch Logs destination for authorizer logs. Firehose: $ref: "#/components/schemas/Firehose" + description: Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs. S3: $ref: "#/components/schemas/S3" - CloudWatchLogs: - type: object - properties: - Enabled: - $ref: "#/components/schemas/__boolean" - LogGroup: - $ref: "#/components/schemas/__string" - required: - - Enabled - Firehose: - type: object - properties: - DeliveryStream: - $ref: "#/components/schemas/__string" - Enabled: - $ref: "#/components/schemas/__boolean" - required: - - Enabled - S3: + description: Details of the Amazon S3 destination for authorizer logs. + BrokerLogs: type: object properties: - Bucket: - $ref: "#/components/schemas/__string" - Enabled: - $ref: "#/components/schemas/__boolean" - Prefix: - $ref: "#/components/schemas/__string" - required: - - Enabled + CloudWatchLogs: + $ref: "#/components/schemas/CloudWatchLogs" + Firehose: + $ref: "#/components/schemas/Firehose" + S3: + $ref: "#/components/schemas/S3" __integerMin1Max15: type: integer minimum: 1 maximum: 15 - __mapOf__string: - type: object - properties: {} StorageMode: description: Controls storage mode for various supported storage tiers. type: string @@ -2339,8 +2781,9 @@ components: SaslScram: $ref: "#/components/schemas/KafkaClusterSaslScramAuthentication" description: Details for SASL/SCRAM client authentication. - required: - - SaslScram + MTLS: + $ref: "#/components/schemas/KafkaClusterMTLSAuthentication" + description: Details for mTLS client authentication. KafkaClusterSaslScramAuthentication: description: Details for SASL/SCRAM client authentication. type: object @@ -2360,6 +2803,15 @@ components: enum: - SHA256 - SHA512 + KafkaClusterMTLSAuthentication: + description: Details for mTLS client authentication. + type: object + properties: + SecretArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the Secrets Manager secret. + required: + - SecretArn KafkaClusterEncryptionInTransit: description: Details of encryption in transit to the Apache Kafka cluster. type: object @@ -2661,6 +3113,18 @@ components: - FAILED - REJECTED - REJECTING + DeleteChannelResponse: + description: Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous delete. + type: object + properties: + ChannelArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + ClusterOperationArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the cluster operation. + required: + - ChannelArn DeleteClusterResponse: type: object properties: @@ -2711,6 +3175,84 @@ components: State: $ref: "#/components/schemas/VpcConnectionState" description: The state of the VPC connection. + DescribeChannelResponse: + description: Contains the current configuration and state of a channel. + type: object + properties: + ChannelArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + ChannelName: + $ref: "#/components/schemas/__string" + description: The name of the channel. + EncryptionConfiguration: + $ref: "#/components/schemas/EncryptionConfiguration" + description: The encryption configuration applied to the channel. + IcebergDestinationConfiguration: + $ref: "#/components/schemas/IcebergDestinationConfiguration" + description: The Apache Iceberg destination for the channel, if configured. + S3DestinationConfiguration: + $ref: "#/components/schemas/S3DestinationConfiguration" + description: The Amazon S3 destination for the channel, if configured. + Status: + $ref: "#/components/schemas/ChannelStatus" + description: The current lifecycle state of the channel. + DestinationType: + $ref: "#/components/schemas/ChannelDestinationType" + description: The type of destination configured for the channel. + CreationTime: + $ref: "#/components/schemas/__timestampIso8601" + description: The time when the channel was created. + TopicConfigurationList: + $ref: "#/components/schemas/__listOfTopicConfiguration" + description: The list of topic configurations for the channel. + LoggingInfo: + $ref: "#/components/schemas/ChannelLoggingInfo" + description: The destinations to which the channel publishes operational logs. + StateInfo: + $ref: "#/components/schemas/ChannelStateInfo" + description: Additional context for the current channel state, populated when the channel is in FAILED. + ClusterOperationArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING. + Tags: + type: object + properties: {} + description: The tags attached to the channel. + required: + - ChannelArn + - ChannelName + - TopicConfigurationList + - Status + - DestinationType + - CreationTime + ChannelStatus: + description: The lifecycle state of a channel. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + - SUSPENDING + - SUSPENDED + ChannelDestinationType: + description: The type of destination configured for the channel. + type: string + enum: + - ICEBERG + - S3 + ChannelStateInfo: + description: Additional context for the current channel state, populated when the channel is in FAILED. + type: object + properties: + Code: + $ref: "#/components/schemas/__string" + description: A short, machine-readable code identifying the failure cause. + Message: + $ref: "#/components/schemas/__string" + description: A human-readable message describing the failure. DescribeClusterResponse: type: object properties: @@ -3555,6 +4097,48 @@ components: TargetVersions: $ref: "#/components/schemas/__listOf__string" description: A list of Apache Kafka versions. + ListChannelsResponse: + description: Returns the list of channels in the cluster. + type: object + properties: + Channels: + $ref: "#/components/schemas/__listOfChannelInfo" + description: The list of channels in the cluster. + NextToken: + $ref: "#/components/schemas/__string" + description: If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page. + __listOfChannelInfo: + type: array + items: + $ref: "#/components/schemas/ChannelInfo" + ChannelInfo: + description: Summary information about a channel returned by ListChannels. + type: object + properties: + ChannelArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + ChannelName: + $ref: "#/components/schemas/__string" + description: The name of the channel. + Status: + $ref: "#/components/schemas/ChannelStatus" + description: The current lifecycle state of the channel. + CreationTime: + $ref: "#/components/schemas/__timestampIso8601" + description: The time when the channel was created. + DestinationType: + $ref: "#/components/schemas/ChannelDestinationType" + description: The type of destination configured for the channel. + ClusterOperationArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING. + required: + - ChannelArn + - ChannelName + - Status + - CreationTime + - DestinationType ListClientVpcConnectionsResponse: type: object properties: @@ -4048,6 +4632,36 @@ components: ClusterOperationArn: $ref: "#/components/schemas/__string" description: The Amazon Resource Name (ARN) of the cluster operation. + IcebergDestinationUpdate: + description: Update payload for an Apache Iceberg destination. + type: object + properties: + DataFreshnessInSeconds: + $ref: "#/components/schemas/__integer" + description: "The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900." + required: + - DataFreshnessInSeconds + S3DestinationUpdate: + description: Update payload for an Amazon S3 destination. + type: object + properties: + DataFreshnessInSeconds: + $ref: "#/components/schemas/__integer" + description: "The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900." + required: + - DataFreshnessInSeconds + UpdateChannelResponse: + description: Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update. + type: object + properties: + ChannelArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) that uniquely identifies the channel. + ClusterOperationArn: + $ref: "#/components/schemas/__string" + description: The Amazon Resource Name (ARN) of the cluster operation. + required: + - ChannelArn UpdateClusterConfigurationResponse: type: object properties: @@ -4404,6 +5018,63 @@ components: insert: [] update: [] delete: [] + channels: + id: aws.kafka.channels + name: channels + title: channels + methods: + create_channel: + operation: + $ref: "#/paths/~1v1~1clusters~1{cluster_arn}~1channels/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_channels: + operation: + $ref: "#/paths/~1v1~1clusters~1{cluster_arn}~1channels/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + delete_channel: + operation: + $ref: "#/paths/~1v1~1clusters~1{cluster_arn}~1channels~1{channel_arn}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_channel: + operation: + $ref: "#/paths/~1v1~1clusters~1{cluster_arn}~1channels~1{channel_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_channel: + operation: + $ref: "#/paths/~1v1~1clusters~1{cluster_arn}~1channels~1{channel_arn}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/channels/methods/describe_channel" + - $ref: "#/components/x-stackQL-resources/channels/methods/list_channels" + insert: + - $ref: "#/components/x-stackQL-resources/channels/methods/create_channel" + update: + - $ref: "#/components/x-stackQL-resources/channels/methods/update_channel" + delete: + - $ref: "#/components/x-stackQL-resources/channels/methods/delete_channel" cluster_v2s: id: aws.kafka.cluster_v2s name: cluster_v2s diff --git a/providers/src/aws/v00.00.00000/services/kendra.yaml b/providers/src/aws/v00.00.00000/services/kendra.yaml index b2089c35..10a69f24 100644 --- a/providers/src/aws/v00.00.00000/services/kendra.yaml +++ b/providers/src/aws/v00.00.00000/services/kendra.yaml @@ -3495,7 +3495,7 @@ components: $ref: "#/components/schemas/WebCrawlerConfiguration" WorkDocsConfiguration: $ref: "#/components/schemas/WorkDocsConfiguration" - description: Provides the configuration information to connect to Amazon WorkDocs as your data source. + description: Provides the configuration information to connect to WorkDocs as your data source. FsxConfiguration: $ref: "#/components/schemas/FsxConfiguration" description: Provides the configuration information to connect to Amazon FSx as your data source. Amazon Kendra now supports an upgraded Amazon FSx Windows connector. You must now use the TemplateConfiguration object instead of the FsxConfiguration object to configure your connector. Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector. We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024. @@ -4602,27 +4602,27 @@ components: - Port - Credentials WorkDocsConfiguration: - description: Provides the configuration information to connect to Amazon WorkDocs as your data source. Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions. + description: Provides the configuration information to connect to WorkDocs as your data source. WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions. type: object properties: OrganizationId: $ref: "#/components/schemas/OrganizationId" - description: The identifier of the directory corresponding to your Amazon WorkDocs site repository. You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console. + description: The identifier of the directory corresponding to your WorkDocs site repository. You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your WorkDocs site directory has an ID, which is the organization ID. You can also set up a new WorkDocs directory in the Directory Service console and enable a WorkDocs site for the directory in the WorkDocs console. CrawlComments: $ref: "#/components/schemas/Boolean" description: TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on. The default is set to FALSE. UseChangeLog: $ref: "#/components/schemas/Boolean" - description: TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs. + description: TRUE to use the WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in WorkDocs. InclusionPatterns: $ref: "#/components/schemas/DataSourceInclusionsExclusionsStrings" - description: A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. + description: A list of regular expression patterns to include certain files in your WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. ExclusionPatterns: $ref: "#/components/schemas/DataSourceInclusionsExclusionsStrings" - description: A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. + description: A list of regular expression patterns to exclude certain files in your WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. FieldMappings: $ref: "#/components/schemas/DataSourceToIndexFieldMappingList" - description: A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata. + description: A list of DataSourceToIndexFieldMapping objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to WorkDocs fields. For more information, see Mapping data source fields. The WorkDocs data source field names must exist in your WorkDocs custom metadata. required: - OrganizationId OrganizationId: diff --git a/providers/src/aws/v00.00.00000/services/keyspacesstreams.yaml b/providers/src/aws/v00.00.00000/services/keyspacesstreams.yaml index db96566e..e4e8957f 100644 --- a/providers/src/aws/v00.00.00000/services/keyspacesstreams.yaml +++ b/providers/src/aws/v00.00.00000/services/keyspacesstreams.yaml @@ -242,6 +242,9 @@ components: nextShardIterator: $ref: "#/components/schemas/ShardIterator" description: The next position in the shard from which to start sequentially reading data records. If null, the shard has been closed and the requested iterator will not return any more data. + iteratorDescription: + $ref: "#/components/schemas/IteratorDescription" + description: Provides information about the current iterator at the time GetRecords request was processed by Keyspaces. RecordList: type: array items: @@ -316,6 +319,18 @@ components: type: string minLength: 21 maxLength: 48 + IteratorDescription: + description: Provides information about the current iterator. + type: object + properties: + iteratorPosition: + $ref: "#/components/schemas/IteratorPosition" + description: "Indicates the current iterator's position within the shard. The possible values are: AT_TIP - No more records are currently available. BEHIND_TIP - Additional records may be available. Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally." + IteratorPosition: + type: string + enum: + - AT_TIP + - BEHIND_TIP StreamArn: type: string minLength: 37 diff --git a/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml b/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml index 2e43f144..146e1b73 100644 --- a/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml +++ b/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml @@ -2090,6 +2090,7 @@ components: - FLINK-1_19 - FLINK-1_20 - FLINK-2_2 + - FLINK-2_3 ApplicationConfiguration: description: Specifies the creation parameters for a Managed Service for Apache Flink application. type: object diff --git a/providers/src/aws/v00.00.00000/services/kms.yaml b/providers/src/aws/v00.00.00000/services/kms.yaml index e26b27e2..c9383549 100644 --- a/providers/src/aws/v00.00.00000/services/kms.yaml +++ b/providers/src/aws/v00.00.00000/services/kms.yaml @@ -183,7 +183,7 @@ paths: /CreateGrant: post: operationId: CreateGrant - description: "Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. The CreateGrant operation returns a GrantToken and a GrantId. When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant. However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the Key Management Service Developer Guide . The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:CreateGrant (key policy) Related operations: ListGrants ListRetirableGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." + description: "Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies. You can create a grant for an Amazon Web Services principal (IAM user, IAM role, or Amazon Web Services account) by specifying the GranteePrincipal parameter. You can also create a grant for an Amazon Web Services service principal by specifying the GranteeServicePrincipal parameter. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. The CreateGrant operation returns a GrantToken and a GrantId. When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant. However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the Key Management Service Developer Guide . The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:CreateGrant (key policy) Related operations: ListGrants ListRetirableGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." parameters: - name: X-Amz-Target in: header @@ -206,16 +206,16 @@ paths: description: "Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key. Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey." GranteePrincipal: $ref: "#/components/schemas/PrincipalIdType" - description: The identity that gets the permissions specified in the grant. To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . + description: The identity that gets the permissions specified in the grant. To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . You must specify either GranteePrincipal or GranteeServicePrincipal, but not both. RetiringPrincipal: $ref: "#/components/schemas/PrincipalIdType" - description: The principal that has permission to use the RetireGrant operation to retire the grant. To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide. + description: The principal that has permission to use the RetireGrant operation to retire the grant. To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide. You can specify either RetiringPrincipal or RetiringServicePrincipal, but not both. Operations: $ref: "#/components/schemas/GrantOperationList" description: A list of operations that the grant permits. This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide. Constraints: $ref: "#/components/schemas/GrantConstraints" - description: Specifies a grant constraint. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints, which allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in the constraint. The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. Operations with these keys don't support an encryption context. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide . + description: Specifies a grant constraint. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. KMS supports the following grant constraints. EncryptionContextEquals and EncryptionContextSubset — These encryption context grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in the constraint. Encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. Operations with these keys don't support an encryption context. Grants with encryption context grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with an encryption context grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide . SourceArn — This grant constraint allows the permissions in the grant only when the request is made on behalf of a specific Amazon Web Services resource, identified by its Amazon Resource Name (ARN). This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint is supported on grants for all types of KMS keys and can also be applied to the DescribeKey operation when specified in the request. However, it does not apply to RetireGrant operation. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. GrantTokens: $ref: "#/components/schemas/GrantTokenList" description: A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide. @@ -225,9 +225,14 @@ paths: DryRun: $ref: "#/components/schemas/NullableBooleanType" description: Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide. + GranteeServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: The Amazon Web Services service principal that gets the permissions specified in the grant. When you specify a GranteeServicePrincipal, you must also specify a SourceArn grant constraint. In addition, you must specify either a RetiringPrincipal or a RetiringServicePrincipal. You must specify either GranteePrincipal or GranteeServicePrincipal, but not both. + RetiringServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: The Amazon Web Services service principal that has permission to use the RetireGrant operation to retire the grant. You can specify either RetiringPrincipal or RetiringServicePrincipal, but not both. required: - KeyId - - GranteePrincipal responses: "200": description: Success @@ -1325,7 +1330,7 @@ paths: /ListGrants: post: operationId: ListGrants - description: "Gets a list of all grants for the specified KMS key. You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:ListGrants (key policy) Related operations: CreateGrant ListRetirableGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." + description: "Gets a list of all grants for the specified KMS key. You must specify the KMS key in all requests. You can filter the grant list by grant ID, grantee principal, or grantee service principal. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account. When a grant is created with the GranteeServicePrincipal field, the ListGrants response always includes a GranteeServicePrincipal that indicates the grantee is actually an Amazon Web Services service principal. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:ListGrants (key policy) Related operations: CreateGrant ListRetirableGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." parameters: - name: X-Amz-Target in: header @@ -1357,7 +1362,10 @@ paths: description: Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant. GranteePrincipal: $ref: "#/components/schemas/PrincipalIdType" - description: Returns only grants where the specified principal is the grantee principal for the grant. + description: Returns only grants where the specified principal is the grantee principal for the grant. You can specify either GranteePrincipal or GranteeServicePrincipal, but not both. + GranteeServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal. You can specify either GranteePrincipal or GranteeServicePrincipal, but not both. required: - KeyId responses: @@ -1524,7 +1532,7 @@ paths: /ListRetirableGrants: post: operationId: ListRetirableGrants - description: "Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal. You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. Cross-account use: You must specify a principal in your Amazon Web Services account. This operation returns a list of grants where the retiring principal specified in the ListRetirableGrants request is the same retiring principal on the grant. This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own. Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account. KMS authorizes ListRetirableGrants requests by evaluating the caller account's kms:ListRetirableGrants permissions. The authorized resource in ListRetirableGrants calls is the retiring principal specified in the request. KMS does not evaluate the caller's permissions to verify their access to any KMS keys or grants that might be returned by the ListRetirableGrants call. Related operations: CreateGrant ListGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." + description: "Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal or retiring service principal. You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. Cross-account use: You must specify a principal in your Amazon Web Services account. This operation returns a list of grants where the retiring principal specified in the ListRetirableGrants request is the same retiring principal on the grant. This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own. Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account. When listing retirable grants by RetiringPrincipal, KMS authorizes ListRetirableGrants requests by evaluating the caller account's kms:ListRetirableGrants permissions. The authorized resource in ListRetirableGrants calls is the retiring principal specified in the request. KMS does not evaluate the caller's permissions to verify their access to any KMS keys or grants that might be returned by the ListRetirableGrants call. The RetiringServicePrincipal filter is only usable by callers in a service principal. Related operations: CreateGrant ListGrants RetireGrant RevokeGrant Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." parameters: - name: X-Amz-Target in: header @@ -1550,9 +1558,10 @@ paths: description: Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. RetiringPrincipal: $ref: "#/components/schemas/PrincipalIdType" - description: The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account. To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . - required: - - RetiringPrincipal + description: The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account. To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide . You must specify either RetiringPrincipal or RetiringServicePrincipal, but not both. + RetiringServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: The retiring service principal for which to list grants. This filter is only usable by callers in a service principal. You must specify either RetiringPrincipal or RetiringServicePrincipal, but not both. responses: "200": description: Success @@ -1601,7 +1610,7 @@ paths: /ReEncrypt: post: operationId: ReEncrypt - description: "Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using a KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation. If your ciphertext was encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data. If your ciphertext was encrypted under a symmetric encryption KMS key, the SourceKeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the ReEncrypt operation fails. This practice ensures that you use the KMS key that you intend. To reencrypt the data, you must use the DestinationKeyId parameter to specify the KMS key that re-encrypts the data after it is decrypted. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key. When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, use the key ARN or alias ARN. A short key ID is also acceptable for the source key when decrypting symmetric ciphertexts, though using a full key ARN is recommended to be more explicit about the intended KMS key. Required permissions: kms:ReEncryptFrom permission on the source KMS key (key policy) kms:ReEncryptTo permission on the destination KMS key (key policy) To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy. Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." + description: "Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using a KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation. If your ciphertext was encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data. If your ciphertext was encrypted under a symmetric encryption KMS key, the SourceKeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the ReEncrypt operation fails. This practice ensures that you use the KMS key that you intend. To reencrypt the data, you must use the DestinationKeyId parameter to specify the KMS key that re-encrypts the data after it is decrypted. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key. When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. When using grants with SourceArn constraints for ReEncrypt operations, the grants on both the source KMS key (for ReEncryptFrom) and the destination KMS key (for ReEncryptTo) must specify the same SourceArn value. Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, use the key ARN or alias ARN. A short key ID is also acceptable for the source key when decrypting symmetric ciphertexts, though using a full key ARN is recommended to be more explicit about the intended KMS key. Required permissions: kms:ReEncryptFrom permission on the source KMS key (key policy) kms:ReEncryptTo permission on the destination KMS key (key policy) To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy. Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency." parameters: - name: X-Amz-Target in: header @@ -2398,7 +2407,7 @@ components: - VerifyMac - DeriveSharedSecret GrantConstraints: - description: "Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context. KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant. In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary. However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive. To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext:context-key in the Key Management Service Developer Guide ." + description: "Use this structure to allow cryptographic operations in the grant only when the operation request meets the specified constraints. KMS supports the following grant constraints: EncryptionContextEquals and EncryptionContextSubset — These encryption context constraints apply only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Encryption context grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant. In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary. However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive. To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext:context-key in the Key Management Service Developer Guide . SourceArn — This grant constraint allows the permissions in the grant only when the request is made on behalf of a specific Amazon Web Services resource, identified by its Amazon Resource Name (ARN). This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint is supported on grants for all types of KMS keys and can also be applied to the DescribeKey operation when specified in the request. However, it does not apply to RetireGrant operation." type: object properties: EncryptionContextSubset: @@ -2409,6 +2418,14 @@ components: type: object properties: {} description: A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint. + SourceArn: + $ref: "#/components/schemas/GrantConstraintSourceArnType" + description: The Amazon Resource Name (ARN) of an Amazon Web Services resource on behalf of which the request is made. This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint ensures that the principal can use the KMS key only when the request is made on behalf of the specified resource. + GrantConstraintSourceArnType: + type: string + minLength: 20 + maxLength: 512 + pattern: ^arn:aws[a-z0-9-]*:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:.+$ GrantTokenList: type: array items: @@ -2424,6 +2441,11 @@ components: pattern: ^[a-zA-Z0-9:/_-]+$ NullableBooleanType: type: boolean + ServicePrincipalType: + type: string + minLength: 1 + maxLength: 128 + pattern: ^([A-Za-z0-9\-]+)\.([A-Za-z0-9\-]+)(\.[A-Za-z0-9\-]+)+$ CreateGrantResponse: type: object properties: @@ -3321,7 +3343,7 @@ components: description: The date and time when the grant was created. GranteePrincipal: $ref: "#/components/schemas/PrincipalIdType" - description: The identity that gets the permissions in the grant. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals. + description: The identity that gets the permissions in the grant. When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account. RetiringPrincipal: $ref: "#/components/schemas/PrincipalIdType" description: The principal that can retire the grant. @@ -3333,7 +3355,13 @@ components: description: The list of operations permitted by the grant. Constraints: $ref: "#/components/schemas/GrantConstraints" - description: A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. + description: The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows. + GranteeServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: The Amazon Web Services service principal that gets the permissions in the grant. + RetiringServicePrincipal: + $ref: "#/components/schemas/ServicePrincipalType" + description: The Amazon Web Services service principal that can retire the grant. ListKeyPoliciesRowDisplay: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/lambda.yaml b/providers/src/aws/v00.00.00000/services/lambda.yaml index 4ee5ef6d..6e5caefc 100644 --- a/providers/src/aws/v00.00.00000/services/lambda.yaml +++ b/providers/src/aws/v00.00.00000/services/lambda.yaml @@ -120,6 +120,10 @@ paths: $ref: "#/components/schemas/Principal" SourceArn: $ref: "#/components/schemas/Arn" + FunctionUrlAuthType: + $ref: "#/components/schemas/FunctionUrlAuthType" + InvokedViaFunctionUrl: + $ref: "#/components/schemas/InvokedViaFunctionUrl" SourceAccount: $ref: "#/components/schemas/SourceOwner" EventSourceToken: @@ -128,10 +132,6 @@ paths: $ref: "#/components/schemas/String" PrincipalOrgID: $ref: "#/components/schemas/PrincipalOrgID" - FunctionUrlAuthType: - $ref: "#/components/schemas/FunctionUrlAuthType" - InvokedViaFunctionUrl: - $ref: "#/components/schemas/InvokedViaFunctionUrl" required: - StatementId - Action @@ -295,6 +295,10 @@ paths: $ref: "#/components/schemas/KMSKeyArnNonEmpty" Tags: $ref: "#/components/schemas/Tags" + PropagateTags: + $ref: "#/components/schemas/PropagateTags" + TelemetryConfig: + $ref: "#/components/schemas/CapacityProviderTelemetryConfig" required: - CapacityProviderName - VpcConfig @@ -409,6 +413,14 @@ paths: $ref: "#/components/schemas/BatchSize" FilterCriteria: $ref: "#/components/schemas/FilterCriteria" + KMSKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + MetricsConfig: + $ref: "#/components/schemas/EventSourceMappingMetricsConfig" + LoggingConfig: + $ref: "#/components/schemas/EventSourceMappingLoggingConfig" + ScalingConfig: + $ref: "#/components/schemas/ScalingConfig" MaximumBatchingWindowInSeconds: $ref: "#/components/schemas/MaximumBatchingWindowInSeconds" ParallelizationFactor: @@ -443,16 +455,8 @@ paths: $ref: "#/components/schemas/AmazonManagedKafkaEventSourceConfig" SelfManagedKafkaEventSourceConfig: $ref: "#/components/schemas/SelfManagedKafkaEventSourceConfig" - ScalingConfig: - $ref: "#/components/schemas/ScalingConfig" DocumentDBEventSourceConfig: $ref: "#/components/schemas/DocumentDBEventSourceConfig" - KMSKeyArn: - $ref: "#/components/schemas/KMSKeyArn" - MetricsConfig: - $ref: "#/components/schemas/EventSourceMappingMetricsConfig" - LoggingConfig: - $ref: "#/components/schemas/EventSourceMappingLoggingConfig" ProvisionedPollerConfig: $ref: "#/components/schemas/ProvisionedPollerConfig" required: @@ -529,6 +533,8 @@ paths: $ref: "#/components/schemas/MemorySize" Publish: $ref: "#/components/schemas/Boolean" + PublishTo: + $ref: "#/components/schemas/FunctionVersionLatestPublished" VpcConfig: $ref: "#/components/schemas/VpcConfig" PackageType: @@ -547,10 +553,10 @@ paths: $ref: "#/components/schemas/LayerList" FileSystemConfigs: $ref: "#/components/schemas/FileSystemConfigList" - ImageConfig: - $ref: "#/components/schemas/ImageConfig" CodeSigningConfigArn: $ref: "#/components/schemas/CodeSigningConfigArn" + ImageConfig: + $ref: "#/components/schemas/ImageConfig" Architectures: $ref: "#/components/schemas/ArchitecturesList" EphemeralStorage: @@ -559,14 +565,12 @@ paths: $ref: "#/components/schemas/SnapStart" LoggingConfig: $ref: "#/components/schemas/LoggingConfig" + TenancyConfig: + $ref: "#/components/schemas/TenancyConfig" CapacityProviderConfig: $ref: "#/components/schemas/CapacityProviderConfig" - PublishTo: - $ref: "#/components/schemas/FunctionVersionLatestPublished" DurableConfig: $ref: "#/components/schemas/DurableConfig" - TenancyConfig: - $ref: "#/components/schemas/TenancyConfig" required: - FunctionName responses: @@ -620,7 +624,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/FunctionName" + $ref: "#/components/schemas/FunctionUrlFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - name: Qualifier in: query @@ -658,7 +662,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/FunctionName" + $ref: "#/components/schemas/FunctionUrlFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - name: Qualifier in: query @@ -677,7 +681,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/FunctionName" + $ref: "#/components/schemas/FunctionUrlFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - name: Qualifier in: query @@ -700,7 +704,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/FunctionName" + $ref: "#/components/schemas/FunctionUrlFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - name: Qualifier in: query @@ -863,6 +867,10 @@ paths: properties: CapacityProviderScalingConfig: $ref: "#/components/schemas/CapacityProviderScalingConfig" + PropagateTags: + $ref: "#/components/schemas/PropagateTags" + TelemetryConfig: + $ref: "#/components/schemas/CapacityProviderTelemetryConfig" responses: "202": description: Success @@ -944,7 +952,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/UUIDString" description: The identifier of the event source mapping. responses: "202": @@ -961,7 +969,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/UUIDString" description: The identifier of the event source mapping. responses: "200": @@ -978,7 +986,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/UUIDString" description: The identifier of the event source mapping. requestBody: required: false @@ -995,8 +1003,18 @@ paths: $ref: "#/components/schemas/BatchSize" FilterCriteria: $ref: "#/components/schemas/FilterCriteria" + KMSKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + MetricsConfig: + $ref: "#/components/schemas/EventSourceMappingMetricsConfig" + LoggingConfig: + $ref: "#/components/schemas/EventSourceMappingLoggingConfig" + ScalingConfig: + $ref: "#/components/schemas/ScalingConfig" MaximumBatchingWindowInSeconds: $ref: "#/components/schemas/MaximumBatchingWindowInSeconds" + ParallelizationFactor: + $ref: "#/components/schemas/ParallelizationFactor" DestinationConfig: $ref: "#/components/schemas/DestinationConfig" MaximumRecordAgeInSeconds: @@ -1005,28 +1023,18 @@ paths: $ref: "#/components/schemas/BisectBatchOnFunctionError" MaximumRetryAttempts: $ref: "#/components/schemas/MaximumRetryAttemptsEventSourceMapping" - ParallelizationFactor: - $ref: "#/components/schemas/ParallelizationFactor" - SourceAccessConfigurations: - $ref: "#/components/schemas/SourceAccessConfigurations" TumblingWindowInSeconds: $ref: "#/components/schemas/TumblingWindowInSeconds" + SourceAccessConfigurations: + $ref: "#/components/schemas/SourceAccessConfigurations" FunctionResponseTypes: $ref: "#/components/schemas/FunctionResponseTypeList" - ScalingConfig: - $ref: "#/components/schemas/ScalingConfig" AmazonManagedKafkaEventSourceConfig: $ref: "#/components/schemas/AmazonManagedKafkaEventSourceConfig" SelfManagedKafkaEventSourceConfig: $ref: "#/components/schemas/SelfManagedKafkaEventSourceConfig" DocumentDBEventSourceConfig: $ref: "#/components/schemas/DocumentDBEventSourceConfig" - KMSKeyArn: - $ref: "#/components/schemas/KMSKeyArn" - MetricsConfig: - $ref: "#/components/schemas/EventSourceMappingMetricsConfig" - LoggingConfig: - $ref: "#/components/schemas/EventSourceMappingLoggingConfig" ProvisionedPollerConfig: $ref: "#/components/schemas/ProvisionedPollerConfig" responses: @@ -1442,6 +1450,12 @@ paths: schema: $ref: "#/components/schemas/DurableExecutionArn" description: The Amazon Resource Name (ARN) of the durable execution. + - name: IncludeExecutionData + in: query + required: false + schema: + $ref: "#/components/schemas/IncludeExecutionData" + description: Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true. responses: "200": description: Success @@ -1847,7 +1861,7 @@ paths: required: false schema: $ref: "#/components/schemas/DurableExecutionName" - description: Optional unique name for the durable execution. When you start your special function, you can give it a unique name to identify this specific execution. It's like giving a nickname to a task. + description: A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error. If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names. - name: Qualifier in: query required: false @@ -1916,12 +1930,6 @@ paths: schema: $ref: "#/components/schemas/NamespacedFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - - name: X-Amz-Invocation-Type - in: header - required: false - schema: - $ref: "#/components/schemas/ResponseStreamingInvocationType" - description: "Use one of the following options: RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data. DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function." - name: X-Amz-Log-Type in: header required: false @@ -1946,6 +1954,12 @@ paths: schema: $ref: "#/components/schemas/TenantId" description: The identifier of the tenant in a multi-tenant Lambda function. + - name: X-Amz-Invocation-Type + in: header + required: false + schema: + $ref: "#/components/schemas/ResponseStreamingInvocationType" + description: "Use one of the following options: RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data. DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function." requestBody: required: false content: @@ -2008,7 +2022,7 @@ paths: required: false schema: $ref: "#/components/schemas/ReverseOrder" - description: Set to true to return results in reverse chronological order (newest first). Default is false. + description: Set to true to return results in chronological order (oldest first). Default is false. - name: Marker in: query required: false @@ -2067,7 +2081,7 @@ paths: in: path required: true schema: - $ref: "#/components/schemas/FunctionName" + $ref: "#/components/schemas/FunctionUrlFunctionName" description: The name or ARN of the Lambda function. Name formats Function name – my-function. Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - name: Marker in: query @@ -2153,6 +2167,12 @@ paths: operationId: ListLayerVersions description: Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture. parameters: + - name: CompatibleArchitecture + in: query + required: false + schema: + $ref: "#/components/schemas/Architecture" + description: The compatible instruction set architecture. - name: CompatibleRuntime in: query required: false @@ -2177,12 +2197,6 @@ paths: schema: $ref: "#/components/schemas/MaxLayerListItems" description: The maximum number of versions to return. - - name: CompatibleArchitecture - in: query - required: false - schema: - $ref: "#/components/schemas/Architecture" - description: The compatible instruction set architecture. responses: "200": description: Success @@ -2211,12 +2225,12 @@ paths: $ref: "#/components/schemas/Description" Content: $ref: "#/components/schemas/LayerVersionContentInput" + CompatibleArchitectures: + $ref: "#/components/schemas/CompatibleArchitectures" CompatibleRuntimes: $ref: "#/components/schemas/CompatibleRuntimes" LicenseInfo: $ref: "#/components/schemas/LicenseInfo" - CompatibleArchitectures: - $ref: "#/components/schemas/CompatibleArchitectures" responses: "201": description: Success @@ -2229,6 +2243,12 @@ paths: operationId: ListLayers description: Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture. parameters: + - name: CompatibleArchitecture + in: query + required: false + schema: + $ref: "#/components/schemas/Architecture" + description: The compatible instruction set architecture. - name: CompatibleRuntime in: query required: false @@ -2247,12 +2267,6 @@ paths: schema: $ref: "#/components/schemas/MaxLayerListItems" description: The maximum number of layers to return. - - name: CompatibleArchitecture - in: query - required: false - schema: - $ref: "#/components/schemas/Architecture" - description: The compatible instruction set architecture. responses: "200": description: Success @@ -2600,20 +2614,22 @@ paths: $ref: "#/components/schemas/S3Key" S3ObjectVersion: $ref: "#/components/schemas/S3ObjectVersion" + S3ObjectStorageMode: + $ref: "#/components/schemas/S3ObjectStorageMode" ImageUri: $ref: "#/components/schemas/String" + Architectures: + $ref: "#/components/schemas/ArchitecturesList" Publish: $ref: "#/components/schemas/Boolean" + PublishTo: + $ref: "#/components/schemas/FunctionVersionLatestPublished" DryRun: $ref: "#/components/schemas/Boolean" RevisionId: $ref: "#/components/schemas/String" - Architectures: - $ref: "#/components/schemas/ArchitecturesList" SourceKMSKeyArn: $ref: "#/components/schemas/KMSKeyArn" - PublishTo: - $ref: "#/components/schemas/FunctionVersionLatestPublished" responses: "200": description: Success @@ -2670,7 +2686,7 @@ components: type: string minLength: 1 maxLength: 140 - pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ LayerVersionNumber: type: integer format: int64 @@ -2688,6 +2704,8 @@ components: pattern: lambda:GetLayerVersion LayerPermissionAllowedPrincipal: type: string + minLength: 0 + maxLength: 10000 pattern: \d{12}|\*|arn:(aws[a-zA-Z-]*):iam::\d{12}:root OrganizationId: type: string @@ -2707,7 +2725,7 @@ components: type: string minLength: 1 maxLength: 256 - pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))? + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:|(((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?))(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))? NumericLatestPublishedOrAliasQualifier: type: string minLength: 1 @@ -2715,13 +2733,26 @@ components: pattern: \$(LATEST(\.PUBLISHED)?)|[a-zA-Z0-9-_$]+ Action: type: string + minLength: 0 + maxLength: 10000 pattern: (lambda:[*]|lambda:[a-zA-Z]+|[*]) Principal: type: string + minLength: 0 + maxLength: 2048 pattern: "[^\\s]+" Arn: type: string - pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) + minLength: 0 + maxLength: 10000 + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) + FunctionUrlAuthType: + type: string + enum: + - NONE + - AWS_IAM + InvokedViaFunctionUrl: + type: boolean SourceOwner: type: string minLength: 0 @@ -2737,13 +2768,6 @@ components: minLength: 12 maxLength: 34 pattern: o-[a-z0-9]{10,32} - FunctionUrlAuthType: - type: string - enum: - - NONE - - AWS_IAM - InvokedViaFunctionUrl: - type: boolean AddPermissionResponse: type: object properties: @@ -2788,7 +2812,7 @@ components: description: The action to take on the operation. Payload: $ref: "#/components/schemas/OperationPayload" - description: The payload for successful operations. + description: The payload for successful operations. The maximum payload size is 6 MB for synchronous EXECUTION operations (RequestResponse invocationType), 1 MB for asynchronous EXECUTION (Event invocationType) and CHAINED_INVOKE operations, and 256 KB for CONTEXT, STEP, WAIT, and CALLBACK operations. Error: $ref: "#/components/schemas/ErrorObject" description: The error information for failed operations. @@ -2909,14 +2933,19 @@ components: type: object properties: TimeoutSeconds: - $ref: "#/components/schemas/DurationSeconds" + $ref: "#/components/schemas/CallbackOptionsTimeoutSecondsInteger" description: The timeout for the callback operation in seconds. If not specified or set to 0, the callback has no timeout. HeartbeatTimeoutSeconds: - $ref: "#/components/schemas/DurationSeconds" + $ref: "#/components/schemas/CallbackOptionsHeartbeatTimeoutSecondsInteger" description: The heartbeat timeout for the callback operation, in seconds. If not specified or set to 0, heartbeat timeout is disabled. - DurationSeconds: + CallbackOptionsTimeoutSecondsInteger: + type: integer + minimum: 0 + maximum: 99999999 + CallbackOptionsHeartbeatTimeoutSecondsInteger: type: integer minimum: 0 + maximum: 99999999 ChainedInvokeOptions: description: Configuration options for chained function invocations in durable executions, including retry settings and timeout configuration. type: object @@ -3110,7 +3139,7 @@ components: type: string minLength: 1 maxLength: 140 - pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? Alias: type: string minLength: 1 @@ -3159,7 +3188,7 @@ components: type: string minLength: 0 maxLength: 10000 - pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))? + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))? Version: type: string minLength: 1 @@ -3169,7 +3198,7 @@ components: type: string minLength: 1 maxLength: 140 - pattern: (arn:aws[a-zA-Z-]*:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ + pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ CapacityProviderVpcConfig: description: VPC configuration that specifies the network settings for compute instances managed by the capacity provider. type: object @@ -3189,12 +3218,18 @@ components: $ref: "#/components/schemas/SubnetId" SubnetId: type: string + minLength: 0 + maxLength: 1024 + pattern: subnet-[0-9a-z]* CapacityProviderSecurityGroupIds: type: array items: $ref: "#/components/schemas/SecurityGroupId" SecurityGroupId: type: string + minLength: 0 + maxLength: 1024 + pattern: sg-[0-9a-zA-Z]* CapacityProviderPermissionsConfig: description: Configuration that specifies the permissions required for the capacity provider to manage compute resources. type: object @@ -3206,6 +3241,8 @@ components: - CapacityProviderOperatorRoleArn RoleArn: type: string + minLength: 0 + maxLength: 10000 pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ InstanceRequirements: description: Specifications that define the characteristics and constraints for compute instances used by the capacity provider. @@ -3237,7 +3274,7 @@ components: type: string minLength: 1 maxLength: 30 - pattern: "[a-zA-Z0-9\\.\\-]+" + pattern: "[a-zA-Z0-9\\.\\*\\-]+" CapacityProviderScalingConfig: description: Configuration that defines how the capacity provider scales compute instances based on demand and policies. type: object @@ -3294,6 +3331,50 @@ components: Tags: type: object properties: {} + PropagateTags: + description: Configuration for tag propagation to managed resources launched by the capacity provider. + type: object + properties: + Mode: + $ref: "#/components/schemas/PropagateTagsMode" + description: The tag propagation mode. Set to Explicit to propagate the tags specified in ExplicitTags to managed resources. Set to None to disable tag propagation. + ExplicitTags: + type: object + properties: {} + description: A list of tags to apply to managed resources when Mode is set to Explicit. You can specify up to 40 tags. + PropagateTagsMode: + type: string + enum: + - None + - Explicit + CapacityProviderTelemetryConfig: + description: Configuration that specifies the telemetry collection for the capacity provider. + type: object + properties: + LoggingConfig: + $ref: "#/components/schemas/CapacityProviderLoggingConfig" + description: The capacity provider's Amazon CloudWatch Logs configuration settings. + CapacityProviderLoggingConfig: + description: The capacity provider's Amazon CloudWatch Logs configuration settings. + type: object + properties: + SystemLogLevel: + $ref: "#/components/schemas/SystemLogLevel" + description: Set this property to filter the system logs for your capacity provider that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. + LogGroup: + $ref: "#/components/schemas/LogGroup" + description: The name of the Amazon CloudWatch log group the capacity provider sends logs to. By default, Lambda capacity providers send logs to a default log group named /aws/lambda/capacity-provider/. To use a different log group, enter an existing log group or enter a new log group name. + SystemLogLevel: + type: string + enum: + - DEBUG + - INFO + - WARN + LogGroup: + type: string + minLength: 1 + maxLength: 512 + pattern: "[\\.\\-_/#A-Za-z0-9]+" CreateCapacityProviderResponse: type: object properties: @@ -3330,6 +3411,11 @@ components: LastModified: $ref: "#/components/schemas/Timestamp" description: The date and time when the capacity provider was last modified. + PropagateTags: + $ref: "#/components/schemas/PropagateTags" + TelemetryConfig: + $ref: "#/components/schemas/CapacityProviderTelemetryConfig" + description: The telemetry configuration for the capacity provider, including logging settings. required: - CapacityProviderArn - State @@ -3339,7 +3425,7 @@ components: type: string minLength: 1 maxLength: 140 - pattern: arn:aws[a-zA-Z-]*:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:capacity-provider:[a-zA-Z0-9-_]+ + pattern: arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:capacity-provider:[a-zA-Z0-9-_]+ CapacityProviderState: type: string enum: @@ -3349,9 +3435,14 @@ components: - Deleting KMSKeyArn: type: string + minLength: 0 + maxLength: 10000 pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() Timestamp: type: string + minLength: 0 + maxLength: 100 + pattern: .* AllowedPublishers: description: List of signing profiles that can sign a code package. type: object @@ -3420,7 +3511,7 @@ components: type: string minLength: 0 maxLength: 200 - pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} Enabled: type: boolean BatchSize: @@ -3449,7 +3540,48 @@ components: type: string minLength: 0 maxLength: 4096 - pattern: .* + pattern: "[\\s\\S]*" + EventSourceMappingMetricsConfig: + description: The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce. + type: object + properties: + Metrics: + $ref: "#/components/schemas/EventSourceMappingMetricList" + description: The metrics you want your event source mapping to produce, including EventCount, ErrorCount, KafkaMetrics. EventCount to receive metrics related to the number of events processed by your event source mapping. ErrorCount (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the number of errors in your event source mapping processing. KafkaMetrics (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the Kafka consumers from your event source mapping. For more information about these metrics, see Event source mapping metrics. + EventSourceMappingMetricList: + type: array + items: + $ref: "#/components/schemas/EventSourceMappingMetric" + EventSourceMappingMetric: + type: string + enum: + - EventCount + - ErrorCount + - KafkaMetrics + EventSourceMappingLoggingConfig: + description: (Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping. + type: object + properties: + SystemLogLevel: + $ref: "#/components/schemas/EventSourceMappingSystemLogLevel" + description: The log level you want your event source mapping to use. Lambda event poller only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. For more information about these metrics, see Event source mapping logging. + EventSourceMappingSystemLogLevel: + type: string + enum: + - DEBUG + - INFO + - WARN + ScalingConfig: + description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. + type: object + properties: + MaximumConcurrency: + $ref: "#/components/schemas/MaximumConcurrency" + description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. + MaximumConcurrency: + type: integer + minimum: 2 + maximum: 1000 MaximumBatchingWindowInSeconds: type: integer minimum: 0 @@ -3488,7 +3620,7 @@ components: type: string minLength: 0 maxLength: 350 - pattern: $|kafka://([^.]([a-zA-Z0-9\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) + pattern: $|kafka://([^.]([a-zA-Z0-9\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) OnFailure: description: A destination for events that failed processing. For more information, see Adding a destination. type: object @@ -3557,7 +3689,7 @@ components: type: string minLength: 1 maxLength: 200 - pattern: "[a-zA-Z0-9-\\/*:_+=.@-]*" + pattern: "[ a-zA-Z0-9-\\/*:_+=.@-]*" SelfManagedEventSource: description: The self-managed Apache Kafka cluster for your event source. type: object @@ -3656,17 +3788,6 @@ components: SchemaRegistryConfig: $ref: "#/components/schemas/KafkaSchemaRegistryConfig" description: Specific configuration settings for a Kafka schema registry. - ScalingConfig: - description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. - type: object - properties: - MaximumConcurrency: - $ref: "#/components/schemas/MaximumConcurrency" - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. - MaximumConcurrency: - type: integer - minimum: 2 - maximum: 1000 DocumentDBEventSourceConfig: description: Specific configuration settings for a DocumentDB event source. type: object @@ -3695,36 +3816,6 @@ components: enum: - UpdateLookup - Default - EventSourceMappingMetricsConfig: - description: The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce. - type: object - properties: - Metrics: - $ref: "#/components/schemas/EventSourceMappingMetricList" - description: The metrics you want your event source mapping to produce, including EventCount, ErrorCount, KafkaMetrics. EventCount to receive metrics related to the number of events processed by your event source mapping. ErrorCount (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the number of errors in your event source mapping processing. KafkaMetrics (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the Kafka consumers from your event source mapping. For more information about these metrics, see Event source mapping metrics. - EventSourceMappingMetricList: - type: array - items: - $ref: "#/components/schemas/EventSourceMappingMetric" - EventSourceMappingMetric: - type: string - enum: - - EventCount - - ErrorCount - - KafkaMetrics - EventSourceMappingLoggingConfig: - description: (Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping. - type: object - properties: - SystemLogLevel: - $ref: "#/components/schemas/EventSourceMappingSystemLogLevel" - description: The log level you want your event source mapping to use. Lambda event poller only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. For more information about these metrics, see Event source mapping logging. - EventSourceMappingSystemLogLevel: - type: string - enum: - - DEBUG - - INFO - - WARN ProvisionedPollerConfig: description: The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source. type: object @@ -3745,7 +3836,7 @@ components: MaximumNumberOfPollers: type: integer minimum: 1 - maximum: 2000 + maximum: 10000 ProvisionedPollerGroupName: type: string minLength: 0 @@ -3756,7 +3847,7 @@ components: type: object properties: UUID: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/UUIDString" description: The identifier of the event source mapping. StartingPosition: $ref: "#/components/schemas/EventSourcePosition" @@ -3779,6 +3870,21 @@ components: FilterCriteria: $ref: "#/components/schemas/FilterCriteria" description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering. If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key. + FilterCriteriaError: + $ref: "#/components/schemas/FilterCriteriaError" + description: An object that contains details about an error related to filter criteria encryption. + KMSKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. + MetricsConfig: + $ref: "#/components/schemas/EventSourceMappingMetricsConfig" + description: The metrics configuration for your event source. For more information, see Event source mapping metrics. + LoggingConfig: + $ref: "#/components/schemas/EventSourceMappingLoggingConfig" + description: (Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging. + ScalingConfig: + $ref: "#/components/schemas/ScalingConfig" + description: (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources. FunctionArn: $ref: "#/components/schemas/FunctionArn" description: The ARN of the Lambda function. @@ -3830,30 +3936,19 @@ components: SelfManagedKafkaEventSourceConfig: $ref: "#/components/schemas/SelfManagedKafkaEventSourceConfig" description: Specific configuration settings for a self-managed Apache Kafka event source. - ScalingConfig: - $ref: "#/components/schemas/ScalingConfig" - description: (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources. DocumentDBEventSourceConfig: $ref: "#/components/schemas/DocumentDBEventSourceConfig" description: Specific configuration settings for a DocumentDB event source. - KMSKeyArn: - $ref: "#/components/schemas/KMSKeyArn" - description: The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. - FilterCriteriaError: - $ref: "#/components/schemas/FilterCriteriaError" - description: An object that contains details about an error related to filter criteria encryption. EventSourceMappingArn: $ref: "#/components/schemas/EventSourceMappingArn" description: The Amazon Resource Name (ARN) of the event source mapping. - MetricsConfig: - $ref: "#/components/schemas/EventSourceMappingMetricsConfig" - description: The metrics configuration for your event source. For more information, see Event source mapping metrics. - LoggingConfig: - $ref: "#/components/schemas/EventSourceMappingLoggingConfig" - description: (Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging. ProvisionedPollerConfig: $ref: "#/components/schemas/ProvisionedPollerConfig" description: (Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode. + UUIDString: + type: string + minLength: 36 + maxLength: 36 FilterCriteriaError: description: An object that contains details about an error related to filter criteria encryption. type: object @@ -3878,7 +3973,7 @@ components: type: string minLength: 85 maxLength: 120 - pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} Runtime: type: string enum: @@ -3890,44 +3985,49 @@ components: - nodejs12.x - nodejs14.x - nodejs16.x + - nodejs18.x + - nodejs20.x + - nodejs22.x + - nodejs24.x - java8 - java8.al2 - java11 + - java17 + - java21 + - java25 - python2.7 - python3.6 - python3.7 - python3.8 - python3.9 + - python3.10 + - python3.11 + - python3.12 + - python3.13 + - python3.14 - dotnetcore1.0 - dotnetcore2.0 - dotnetcore2.1 - dotnetcore3.1 - dotnet6 - dotnet8 + - dotnet10 - nodejs4.3-edge - go1.x - ruby2.5 - ruby2.7 - - provided - - provided.al2 - - nodejs18.x - - python3.10 - - java17 - ruby3.2 - ruby3.3 - ruby3.4 - - python3.11 - - nodejs20.x - - provided.al2023 - - python3.12 - - java21 - - python3.13 - - nodejs22.x - - nodejs24.x - - python3.14 - - java25 - - dotnet10 - ruby4.0 + - provided + - provided.al2 + - provided.al2023 + - nodejs26.x + - python3.15 + - java8.al2023 + - java11.al2023 + - java17.al2023 Handler: type: string minLength: 0 @@ -3949,6 +4049,9 @@ components: S3ObjectVersion: $ref: "#/components/schemas/S3ObjectVersion" description: For versioned objects, the version of the deployment package object to use. + S3ObjectStorageMode: + $ref: "#/components/schemas/S3ObjectStorageMode" + description: "Specifies how the deployment package is stored. Valid values: COPY (default) – Uploads a copy of your deployment package to Lambda. REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket." ImageUri: $ref: "#/components/schemas/String" description: URI of a container image in the Amazon ECR registry. @@ -3967,19 +4070,32 @@ components: type: string minLength: 1 maxLength: 1024 + pattern: .* S3ObjectVersion: type: string minLength: 1 maxLength: 1024 + pattern: .* + S3ObjectStorageMode: + description: The method Lambda uses to store a function's deployment package — either by copying the package into Lambda-managed storage (COPY) or by referencing it directly from the source Amazon S3 bucket (REFERENCE). + type: string + enum: + - COPY + - REFERENCE Timeout: type: integer minimum: 1 + maximum: 5400 MemorySize: type: integer minimum: 128 maximum: 32768 Boolean: type: boolean + FunctionVersionLatestPublished: + type: string + enum: + - LATEST_PUBLISHED VpcConfig: description: The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC. type: object @@ -4017,6 +4133,8 @@ components: description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. ResourceArn: type: string + minLength: 0 + maxLength: 10000 pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() Environment: description: A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. @@ -4045,8 +4163,8 @@ components: LayerVersionArn: type: string minLength: 1 - maxLength: 140 - pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+ + maxLength: 2048 + pattern: ((arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+)|(arn:[a-zA-Z0-9-]+:lambda:::awslayer:[a-zA-Z0-9-_]+)) FileSystemConfigList: type: array items: @@ -4068,7 +4186,7 @@ components: type: string minLength: 0 maxLength: 256 - pattern: arn:aws[a-zA-Z-]*:elasticfilesystem:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:access-point/fsap-[a-f0-9]{17}$|^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40} + pattern: arn:aws[a-zA-Z-]*:elasticfilesystem:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:access-point/fsap-[a-f0-9]{17}$|^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40} LocalMountPath: type: string minLength: 0 @@ -4150,17 +4268,19 @@ components: - WARN - ERROR - FATAL - SystemLogLevel: + TenancyConfig: + description: Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation. + type: object + properties: + TenantIsolationMode: + $ref: "#/components/schemas/TenantIsolationMode" + description: Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID. + required: + - TenantIsolationMode + TenantIsolationMode: type: string enum: - - DEBUG - - INFO - - WARN - LogGroup: - type: string - minLength: 1 - maxLength: 512 - pattern: "[\\.\\-_/#A-Za-z0-9]+" + - PER_TENANT CapacityProviderConfig: description: Configuration for the capacity provider that manages compute resources for Lambda functions. type: object @@ -4194,14 +4314,13 @@ components: format: double minimum: 2 maximum: 8 - FunctionVersionLatestPublished: - type: string - enum: - - LATEST_PUBLISHED DurableConfig: - description: Configuration settings for durable functions, including execution timeout and retention period for execution history. + description: Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads. type: object properties: + KMSKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads. RetentionPeriodInDays: $ref: "#/components/schemas/RetentionPeriodInDays" description: The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API. @@ -4216,19 +4335,6 @@ components: type: integer minimum: 1 maximum: 31622400 - TenancyConfig: - description: Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation. - type: object - properties: - TenantIsolationMode: - $ref: "#/components/schemas/TenantIsolationMode" - description: Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID. - required: - - TenantIsolationMode - TenantIsolationMode: - type: string - enum: - - PER_TENANT FunctionConfiguration: description: Details about a function's configuration. type: object @@ -4314,18 +4420,18 @@ components: FileSystemConfigs: $ref: "#/components/schemas/FileSystemConfigList" description: Connection settings for an Amazon EFS file system or an Amazon S3 Files file system. - PackageType: - $ref: "#/components/schemas/PackageType" - description: The type of deployment package. Set to Image for container image and set Zip for .zip file archive. - ImageConfigResponse: - $ref: "#/components/schemas/ImageConfigResponse" - description: The function's image configuration values. SigningProfileVersionArn: $ref: "#/components/schemas/Arn" description: The ARN of the signing profile version. SigningJobArn: $ref: "#/components/schemas/Arn" description: The ARN of the signing job. + PackageType: + $ref: "#/components/schemas/PackageType" + description: The type of deployment package. Set to Image for container image and set Zip for .zip file archive. + ImageConfigResponse: + $ref: "#/components/schemas/ImageConfigResponse" + description: The function's image configuration values. Architectures: $ref: "#/components/schemas/ArchitecturesList" description: The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64. @@ -4341,6 +4447,9 @@ components: LoggingConfig: $ref: "#/components/schemas/LoggingConfig" description: The function's Amazon CloudWatch Logs configuration settings. + TenancyConfig: + $ref: "#/components/schemas/TenancyConfig" + description: The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant. CapacityProviderConfig: $ref: "#/components/schemas/CapacityProviderConfig" description: Configuration for the capacity provider that manages compute resources for Lambda functions. @@ -4350,14 +4459,11 @@ components: DurableConfig: $ref: "#/components/schemas/DurableConfig" description: The function's durable execution configuration settings, if the function is configured for durability. - TenancyConfig: - $ref: "#/components/schemas/TenancyConfig" - description: The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant. NameSpacedFunctionArn: type: string minLength: 0 maxLength: 10000 - pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))? + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))? Long: type: integer format: int64 @@ -4469,7 +4575,7 @@ components: - InvalidRuntime - InvalidZipFileException - FunctionError - - DrainingDurableExecutions + - ServiceQuotaExceededException - VcpuLimitExceeded - CapacityProviderScalingLimitExceeded - InsufficientCapacity @@ -4483,6 +4589,8 @@ components: - FunctionError.TooManyExtensions - FunctionError.InitResourceExhausted - DisallowedByVpcEncryptionControl + - DrainingDurableExecutions + - DependencyError LastUpdateStatus: type: string enum: @@ -4515,6 +4623,7 @@ components: - InvalidRuntime - InvalidZipFileException - FunctionError + - ServiceQuotaExceededException - VcpuLimitExceeded - CapacityProviderScalingLimitExceeded - InsufficientCapacity @@ -4528,6 +4637,7 @@ components: - FunctionError.TooManyExtensions - FunctionError.InitResourceExhausted - DisallowedByVpcEncryptionControl + - DependencyError ImageConfigResponse: description: Response to a GetFunctionConfiguration request. type: object @@ -4577,7 +4687,7 @@ components: type: string minLength: 26 maxLength: 2048 - pattern: arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+ + pattern: arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}::runtime:.+ RuntimeVersionError: description: Any error returned when the runtime version information for the function could not be retrieved. type: object @@ -4588,6 +4698,11 @@ components: Message: $ref: "#/components/schemas/SensitiveString" description: The error message. + FunctionUrlFunctionName: + type: string + minLength: 1 + maxLength: 140 + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]{1,64})(:((?!\d+$)[0-9a-zA-Z-_]+))? FunctionUrlQualifier: type: string minLength: 1 @@ -4763,6 +4878,8 @@ components: description: The code signing configuration required: - CodeSigningConfig + IncludeExecutionData: + type: boolean GetDurableExecutionResponse: description: The response from the GetDurableExecution operation, containing detailed information about the durable execution. type: object @@ -4800,6 +4917,12 @@ components: TraceHeader: $ref: "#/components/schemas/TraceHeader" description: The trace headers associated with the durable execution. + ExecutionDataIncluded: + $ref: "#/components/schemas/ExecutionDataIncluded" + description: Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request. + DurableConfig: + $ref: "#/components/schemas/DurableConfig" + description: Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads. required: - DurableExecutionArn - DurableExecutionName @@ -4834,7 +4957,7 @@ components: type: string minLength: 0 maxLength: 8192 - IncludeExecutionData: + ExecutionDataIncluded: type: boolean ItemCount: type: integer @@ -5004,6 +5127,9 @@ components: description: Indicates if the error payload was truncated due to size limits. Truncated: type: boolean + DurationSeconds: + type: integer + minimum: 0 ExecutionSucceededDetails: description: Details about a durable execution that succeeded. type: object @@ -5303,7 +5429,7 @@ components: $ref: "#/components/schemas/String" description: The service that's hosting the file. Location: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/SensitiveStringOnServerOnly" description: A presigned URL that you can use to download the deployment package. ImageUri: $ref: "#/components/schemas/String" @@ -5311,9 +5437,42 @@ components: ResolvedImageUri: $ref: "#/components/schemas/String" description: The resolved URI for the image. + ResolvedS3Object: + $ref: "#/components/schemas/ResolvedS3Object" + description: The resolved Amazon S3 object that contains the deployment package. SourceKMSKeyArn: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/KMSKeyArn" description: The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key. + Error: + $ref: "#/components/schemas/FunctionCodeLocationError" + description: An object that contains details about an error related to function deployment package retrieval. + SensitiveStringOnServerOnly: + type: string + minLength: 0 + maxLength: 10000 + ResolvedS3Object: + description: Details about the resolved Amazon S3 object that contains a function's deployment package. + type: object + properties: + S3Bucket: + $ref: "#/components/schemas/S3Bucket" + description: The Amazon S3 bucket that contains the deployment package. + S3Key: + $ref: "#/components/schemas/S3Key" + description: The Amazon S3 key of the deployment package. + S3ObjectVersion: + $ref: "#/components/schemas/S3ObjectVersion" + description: The version of the deployment package object. + FunctionCodeLocationError: + description: Contains details about an error that occurred when Lambda attempted to retrieve a function's deployment package. + type: object + properties: + ErrorCode: + $ref: "#/components/schemas/String" + description: The error code that identifies why Lambda failed to retrieve the deployment package. + Message: + $ref: "#/components/schemas/SensitiveString" + description: The human-readable message that describes why Lambda failed to retrieve the deployment package. TagsError: description: An object that contains details about an error related to retrieving tags. type: object @@ -5394,7 +5553,7 @@ components: type: string minLength: 1 maxLength: 140 - pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+) + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+) GetFunctionRecursionConfigResponse: type: object properties: @@ -5488,21 +5647,21 @@ components: Version: $ref: "#/components/schemas/LayerVersionNumber" description: The version number. + CompatibleArchitectures: + $ref: "#/components/schemas/CompatibleArchitectures" + description: A list of compatible instruction set architectures. CompatibleRuntimes: $ref: "#/components/schemas/CompatibleRuntimes" description: The layer's compatible runtimes. The following list includes deprecated runtimes. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes. LicenseInfo: $ref: "#/components/schemas/LicenseInfo" description: The layer's software license. - CompatibleArchitectures: - $ref: "#/components/schemas/CompatibleArchitectures" - description: A list of compatible instruction set architectures. LayerVersionContentOutput: description: Details about a version of an Lambda layer. type: object properties: Location: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/SensitiveStringOnServerOnly" description: A link to the layer archive in Amazon S3 that is valid for 10 minutes. CodeSha256: $ref: "#/components/schemas/String" @@ -5511,16 +5670,23 @@ components: $ref: "#/components/schemas/Long" description: The size of the layer archive in bytes. SigningProfileVersionArn: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) for a signing profile version. SigningJobArn: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) of a signing job. + ResolvedS3Object: + $ref: "#/components/schemas/ResolvedS3Object" + description: The resolved Amazon S3 object that contains the layer archive. LayerArn: type: string minLength: 1 - maxLength: 140 - pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+ + maxLength: 2048 + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:layer:[a-zA-Z0-9-_]+ + CompatibleArchitectures: + type: array + items: + $ref: "#/components/schemas/Architecture" CompatibleRuntimes: type: array items: @@ -5529,10 +5695,7 @@ components: type: string minLength: 0 maxLength: 512 - CompatibleArchitectures: - type: array - items: - $ref: "#/components/schemas/Architecture" + pattern: .* GetLayerVersionPolicyResponse: type: object properties: @@ -5590,12 +5753,12 @@ components: UpdateRuntimeOn: $ref: "#/components/schemas/UpdateRuntimeOn" description: The current runtime update mode of the function. - RuntimeVersionArn: - $ref: "#/components/schemas/RuntimeVersionArn" - description: The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned. FunctionArn: $ref: "#/components/schemas/NameSpacedFunctionArn" description: The Amazon Resource Name (ARN) of your function. + RuntimeVersionArn: + $ref: "#/components/schemas/RuntimeVersionArn" + description: The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned. UpdateRuntimeOn: type: string enum: @@ -5785,6 +5948,9 @@ components: EndTimestamp: $ref: "#/components/schemas/ExecutionTimestamp" description: The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). + KMSKeyArn: + $ref: "#/components/schemas/KMSKeyArn" + description: The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads. required: - DurableExecutionArn - DurableExecutionName @@ -5905,7 +6071,9 @@ components: - State MasterRegion: type: string - pattern: ALL|[a-z]{2}(-gov)?-[a-z]+-\d{1} + minLength: 1 + maxLength: 50 + pattern: ALL|(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1} FunctionVersion: type: string enum: @@ -5970,15 +6138,15 @@ components: CreatedDate: $ref: "#/components/schemas/Timestamp" description: The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000. + CompatibleArchitectures: + $ref: "#/components/schemas/CompatibleArchitectures" + description: A list of compatible instruction set architectures. CompatibleRuntimes: $ref: "#/components/schemas/CompatibleRuntimes" description: The layer's compatible runtimes. The following list includes deprecated runtimes. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes. LicenseInfo: $ref: "#/components/schemas/LicenseInfo" description: The layer's open-source license. - CompatibleArchitectures: - $ref: "#/components/schemas/CompatibleArchitectures" - description: A list of compatible instruction set architectures. ListLayersResponse: type: object properties: @@ -6050,8 +6218,8 @@ components: TaggableResource: type: string minLength: 1 - maxLength: 256 - pattern: arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:(function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|capacity-provider:[a-zA-Z0-9-_]+) + maxLength: 10000 + pattern: arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:(function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|(capacity-provider|network-connector):[a-zA-Z0-9-_]{1,64}) ListTagsResponse: type: object properties: @@ -6081,6 +6249,9 @@ components: S3ObjectVersion: $ref: "#/components/schemas/S3ObjectVersion" description: For versioned objects, the version of the layer archive object to use. + S3ObjectStorageMode: + $ref: "#/components/schemas/S3ObjectStorageMode" + description: "Specifies how the layer archive is stored. Valid values: COPY (default) – Uploads a copy of your layer archive to Lambda. REFERENCE – Lambda references the layer archive from the specified Amazon S3 bucket." ZipFile: $ref: "#/components/schemas/Blob" description: The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you. @@ -6105,15 +6276,15 @@ components: Version: $ref: "#/components/schemas/LayerVersionNumber" description: The version number. + CompatibleArchitectures: + $ref: "#/components/schemas/CompatibleArchitectures" + description: A list of compatible instruction set architectures. CompatibleRuntimes: $ref: "#/components/schemas/CompatibleRuntimes" description: The layer's compatible runtimes. The following list includes deprecated runtimes. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes. LicenseInfo: $ref: "#/components/schemas/LicenseInfo" description: The layer's software license. - CompatibleArchitectures: - $ref: "#/components/schemas/CompatibleArchitectures" - description: A list of compatible instruction set architectures. PutFunctionCodeSigningConfigResponse: type: object properties: @@ -6144,12 +6315,12 @@ components: RequestedProvisionedConcurrentExecutions: $ref: "#/components/schemas/PositiveInteger" description: The amount of provisioned concurrency requested. - AvailableProvisionedConcurrentExecutions: - $ref: "#/components/schemas/NonNegativeInteger" - description: The amount of provisioned concurrency available. AllocatedProvisionedConcurrentExecutions: $ref: "#/components/schemas/NonNegativeInteger" description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions. + AvailableProvisionedConcurrentExecutions: + $ref: "#/components/schemas/NonNegativeInteger" + description: The amount of provisioned concurrency available. Status: $ref: "#/components/schemas/ProvisionedConcurrencyStatusEnum" description: The status of the allocation process. @@ -6204,6 +6375,9 @@ components: $ref: "#/components/schemas/TagKey" TagKey: type: string + minLength: 1 + maxLength: 128 + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) UpdateCapacityProviderResponse: type: object properties: @@ -6504,6 +6678,8 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal send_durable_execution_callback_failure: operation: $ref: "#/paths/~12025-12-01~1durable-execution-callbacks~1{callback_id}~1fail/post" diff --git a/providers/src/aws/v00.00.00000/services/lambda_core.yaml b/providers/src/aws/v00.00.00000/services/lambda_core.yaml new file mode 100644 index 00000000..6c67ddfb --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/lambda_core.yaml @@ -0,0 +1,557 @@ +openapi: 3.0.0 +info: + version: "2026-04-30" + title: AWS Lambda Core + description: AWS Lambda Core + x-serviceName: lambda + x-serviceAlias: lambda_core + x-protocol: rest-json + x-apiVersion: "2026-04-30" + x-endpointPrefix: lambda +servers: + - url: https://lambda.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for lambda-core +paths: + /2026-04-04/network-connectors: + post: + operationId: CreateNetworkConnector + description: Creates a network connector that enables Lambda compute resources to route outbound traffic through your Amazon VPC. The network connector provisions elastic network interfaces (ENIs) in the subnets you specify, providing a managed network path to private resources such as databases, caches, and internal APIs. This operation is asynchronous. The network connector starts in PENDING state while ENIs are provisioned in your VPC (provisioning typically takes up to 10 minutes). Use GetNetworkConnector to poll the connector state until it reaches ACTIVE. Once active, you can attach the connector to Lambda MicroVMs at run time using the egressNetworkConnectors parameter on RunMicroVm. This operation is idempotent when you provide a ClientToken — if you retry a request that completed successfully using the same client token, the operation returns the existing connector without creating a duplicate. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/NetworkConnectorName" + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + ClientToken: + $ref: "#/components/schemas/ClientTokenString" + Tags: + $ref: "#/components/schemas/NetworkConnectorTags" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateNetworkConnectorResponse" + get: + operationId: ListNetworkConnectors + description: Returns a paginated list of network connectors in your account for the current Region. You can optionally filter results by connector state. Use the Marker parameter from a previous response to retrieve the next page of results. Each item in the response includes the connector ARN, name, ID, type, current state, and last modified timestamp. To retrieve full configuration details for a specific connector, use GetNetworkConnector. + parameters: + - name: State + in: query + required: false + schema: + $ref: "#/components/schemas/NetworkConnectorState" + description: Optional filter to return only connectors in the specified state (for example, ACTIVE or FAILED). + - name: Marker + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous ListNetworkConnectors response. Use this value to retrieve the next page of results. + - name: MaxItems + in: query + required: false + schema: + $ref: "#/components/schemas/MaxHundredListItems" + description: "The maximum number of connectors to return per page. Valid range: 1 to 100." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListNetworkConnectorsResponse" + /2026-04-04/network-connectors/{identifier}: + delete: + operationId: DeleteNetworkConnector + description: Initiates deletion of a network connector. The connector transitions to DELETING state while elastic network interfaces are cleaned up asynchronously. After deletion completes, subsequent calls to GetNetworkConnector return ResourceNotFoundException. This operation is idempotent — calling delete on a connector that is already deleting or has been deleted succeeds without error. You can delete connectors in ACTIVE or FAILED states. Before deleting a connector, ensure that no Lambda MicroVMs are using it, as they will lose VPC egress connectivity immediately. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/NetworkConnectorIdentifier" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteNetworkConnectorResponse" + get: + operationId: GetNetworkConnector + description: Retrieves the current configuration, state, and metadata of a network connector. The Identifier parameter accepts the connector ID, name, or full ARN. Use this operation to poll connector state after creation or update, or to inspect the current VPC configuration and any failure reasons. The response includes the full connector configuration, current state, and — if the connector has been updated — the LastUpdateStatus and LastUpdateStatusReasonCode fields that indicate whether the most recent update succeeded or failed. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/NetworkConnectorIdentifier" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetNetworkConnectorResponse" + put: + operationId: UpdateNetworkConnector + description: Updates the VPC configuration or operator role of an existing network connector. You can modify the subnet IDs, security group IDs, network protocol, or operator role. The connector must be in ACTIVE state to accept updates. This operation is asynchronous. The connector remains in ACTIVE state during the update — existing workloads that reference this connector are not disrupted. Use GetNetworkConnector to monitor the LastUpdateStatus field, which transitions through InProgress to Successful or Failed. If the update fails, the LastUpdateStatusReasonCode field provides a specific error code for troubleshooting. This operation is idempotent when you provide a ClientToken. + parameters: + - name: identifier + in: path + required: true + schema: + $ref: "#/components/schemas/NetworkConnectorIdentifier" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + ClientToken: + $ref: "#/components/schemas/ClientTokenString" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateNetworkConnectorResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + NetworkConnectorName: + type: string + minLength: 1 + maxLength: 140 + pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)|[a-zA-Z0-9_-]{1,64} + NetworkConnectorConfiguration: + description: The network configuration for a network connector. Different connector types use different configuration shapes; specify the configuration that matches your connector type. + type: object + properties: + VpcEgressConfiguration: + $ref: "#/components/schemas/NetworkConnectorVpcEgressConfiguration" + description: Configuration for a VPC egress network connector. Specifies the subnets, security groups, and network protocol for routing outbound traffic through your VPC. + NetworkConnectorVpcEgressConfiguration: + description: Configuration for a VPC egress network connector. Specifies the VPC subnets, security groups, network protocol, and associated Lambda compute resource types. + type: object + properties: + SubnetIds: + $ref: "#/components/schemas/NetworkConnectorSubnetIds" + description: The IDs of the VPC subnets where Lambda provisions elastic network interfaces (ENIs). Specify 1 to 16 subnets. All subnets must be in the same VPC. + SecurityGroupIds: + $ref: "#/components/schemas/NetworkConnectorSecurityGroupIds" + description: The IDs of the VPC security groups to attach to the ENIs. Specify 0 to 5 security groups. All security groups must be in the same VPC as the subnets. + NetworkProtocol: + $ref: "#/components/schemas/NetworkProtocol" + description: The network protocol for the connector. Specify IPv4 for IPv4-only networking, or DualStack for both IPv4 and IPv6. + AssociatedComputeResourceTypes: + $ref: "#/components/schemas/AssociatedComputeResourceTypesList" + description: The types of Lambda compute resources that can use this connector. Currently, only MicroVm is supported. + NetworkConnectorSubnetIds: + type: array + items: + $ref: "#/components/schemas/NetworkConnectorSubnetId" + NetworkConnectorSubnetId: + type: string + minLength: 0 + maxLength: 1024 + pattern: subnet-[0-9a-z]* + NetworkConnectorSecurityGroupIds: + type: array + items: + $ref: "#/components/schemas/NetworkConnectorSecurityGroupId" + NetworkConnectorSecurityGroupId: + type: string + minLength: 0 + maxLength: 1024 + pattern: sg-[0-9a-zA-Z]* + NetworkProtocol: + type: string + enum: + - IPv4 + - DualStack + AssociatedComputeResourceTypesList: + type: array + items: + $ref: "#/components/schemas/ComputeResourceType" + ComputeResourceType: + type: string + enum: + - MicroVm + NetworkConnectorRoleArn: + type: string + minLength: 0 + maxLength: 10000 + pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + ClientTokenString: + type: string + minLength: 1 + maxLength: 64 + NetworkConnectorTags: + type: object + properties: {} + CreateNetworkConnectorResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/NetworkConnectorArn" + description: The Amazon Resource Name (ARN) of the network connector. + Name: + $ref: "#/components/schemas/NetworkConnectorName" + description: The name of the network connector. + Id: + $ref: "#/components/schemas/NetworkConnectorId" + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + description: The network configuration of the connector, including VPC subnets and security groups. + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + description: The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector. + State: + $ref: "#/components/schemas/NetworkConnectorState" + description: The current state of the network connector. + required: + - Arn + - Name + - Id + NetworkConnectorArn: + type: string + minLength: 1 + maxLength: 140 + pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?) + NetworkConnectorId: + description: The unique identifier for a network connector, assigned by the service at creation time + type: string + minLength: 1 + maxLength: 140 + NetworkConnectorState: + type: string + enum: + - PENDING + - ACTIVE + - INACTIVE + - FAILED + - DELETING + - DELETE_FAILED + NetworkConnectorIdentifier: + description: A flexible identifier that accepts a network connector ID, name, or ARN + type: string + minLength: 1 + maxLength: 140 + DeleteNetworkConnectorResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/NetworkConnectorArn" + description: The Amazon Resource Name (ARN) of the network connector. + Name: + $ref: "#/components/schemas/NetworkConnectorName" + description: The name of the network connector. + Id: + $ref: "#/components/schemas/NetworkConnectorId" + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + description: The network configuration of the connector, including VPC subnets and security groups. + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + description: The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector. + State: + $ref: "#/components/schemas/NetworkConnectorState" + description: The current state of the network connector. The State field is typically DELETING after this call. + required: + - Arn + - Name + - Id + GetNetworkConnectorResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/NetworkConnectorArn" + description: The Amazon Resource Name (ARN) of the network connector. + Name: + $ref: "#/components/schemas/NetworkConnectorName" + description: The name of the network connector. + Id: + $ref: "#/components/schemas/NetworkConnectorId" + Version: + $ref: "#/components/schemas/NetworkConnectorVersion" + description: The version number of the connector configuration, incremented on each update. + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + description: The network configuration of the connector, including VPC subnets and security groups. + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + description: The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector. + State: + $ref: "#/components/schemas/NetworkConnectorState" + description: The current state of the network connector. + StateReason: + $ref: "#/components/schemas/String" + description: A human-readable explanation of the current state, populated when the state is FAILED or DELETE_FAILED. + StateReasonCode: + $ref: "#/components/schemas/NetworkConnectorStateReasonCode" + description: A machine-readable code indicating the reason for the current state. Use this for programmatic error handling. + LastUpdateStatus: + $ref: "#/components/schemas/NetworkConnectorLastUpdateStatus" + description: The status of the most recent update operation (Successful, Failed, or InProgress). + LastUpdateStatusReason: + $ref: "#/components/schemas/NetworkConnectorLastUpdateStatusReason" + description: A human-readable explanation of the last update status. + LastUpdateStatusReasonCode: + $ref: "#/components/schemas/NetworkConnectorLastUpdateStatusReasonCode" + description: A machine-readable code indicating the reason for the last update status. Use this for programmatic error handling. + LastModified: + $ref: "#/components/schemas/CoreTimestamp" + description: The date and time when the connector configuration was last modified. + required: + - Arn + - Name + - Id + NetworkConnectorVersion: + type: integer + format: int64 + minimum: 0 + String: + type: string + NetworkConnectorStateReasonCode: + type: string + enum: + - DisallowedByVpcEncryptionControl + - Ec2RequestLimitExceeded + - InsufficientRolePermissions + - InternalError + - InvalidSecurityGroup + - InvalidSubnet + - SubnetOutOfIPAddresses + NetworkConnectorLastUpdateStatus: + type: string + enum: + - Successful + - Failed + - InProgress + NetworkConnectorLastUpdateStatusReason: + type: string + NetworkConnectorLastUpdateStatusReasonCode: + type: string + enum: + - DisallowedByVpcEncryptionControl + - Ec2RequestLimitExceeded + - InsufficientRolePermissions + - InternalError + - InvalidSecurityGroup + - InvalidSubnet + - SubnetOutOfIPAddresses + CoreTimestamp: + type: string + format: date-time + MaxHundredListItems: + type: integer + minimum: 1 + maximum: 100 + ListNetworkConnectorsResponse: + type: object + properties: + NetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorsList" + description: A list of network connector summaries for the current page of results. + NextMarker: + $ref: "#/components/schemas/String" + description: The pagination token to include in a subsequent request to retrieve the next page. This value is null when there are no more results. + required: + - NetworkConnectors + NetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnectorSummary" + NetworkConnectorSummary: + description: Summary information about a network connector returned by ListNetworkConnectors. Contains identifying fields and current state. To retrieve full configuration details, use GetNetworkConnector. + type: object + properties: + Arn: + $ref: "#/components/schemas/NetworkConnectorArn" + description: The ARN of the network connector. + Name: + $ref: "#/components/schemas/NetworkConnectorName" + description: The name of the network connector. + Id: + $ref: "#/components/schemas/NetworkConnectorId" + Type: + $ref: "#/components/schemas/NetworkConnectorType" + description: The type of the network connector (VPC_EGRESS). + State: + $ref: "#/components/schemas/NetworkConnectorState" + description: The current state of the network connector. + LastModified: + $ref: "#/components/schemas/CoreTimestamp" + description: The date and time when the connector was last modified. + required: + - Arn + - Name + - Id + - Type + NetworkConnectorType: + type: string + enum: + - VPC_EGRESS + UpdateNetworkConnectorResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/NetworkConnectorArn" + description: The Amazon Resource Name (ARN) of the network connector. + Name: + $ref: "#/components/schemas/NetworkConnectorName" + description: The name of the network connector. + Id: + $ref: "#/components/schemas/NetworkConnectorId" + OperatorRole: + $ref: "#/components/schemas/NetworkConnectorRoleArn" + description: The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector. + Configuration: + $ref: "#/components/schemas/NetworkConnectorConfiguration" + description: The network configuration of the connector, including VPC subnets and security groups. + State: + $ref: "#/components/schemas/NetworkConnectorState" + description: The current state of the network connector. + LastUpdateStatus: + $ref: "#/components/schemas/NetworkConnectorLastUpdateStatus" + description: The status of this update operation (typically InProgress immediately after the call). + LastUpdateStatusReason: + $ref: "#/components/schemas/NetworkConnectorLastUpdateStatusReason" + description: A human-readable explanation of the update status. + LastModified: + $ref: "#/components/schemas/CoreTimestamp" + description: The timestamp of this update. + required: + - Arn + - Name + - Id + x-stackQL-resources: + network_connectors: + id: aws.lambda_core.network_connectors + name: network_connectors + title: network_connectors + methods: + create_network_connector: + operation: + $ref: "#/paths/~12026-04-04~1network-connectors/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_network_connectors: + operation: + $ref: "#/paths/~12026-04-04~1network-connectors/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.NetworkConnectors + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: Marker + location: query + responseToken: + key: $.NextMarker + location: body + delete_network_connector: + operation: + $ref: "#/paths/~12026-04-04~1network-connectors~1{identifier}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + get_network_connector: + operation: + $ref: "#/paths/~12026-04-04~1network-connectors~1{identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_network_connector: + operation: + $ref: "#/paths/~12026-04-04~1network-connectors~1{identifier}/put" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/network_connectors/methods/get_network_connector" + - $ref: "#/components/x-stackQL-resources/network_connectors/methods/list_network_connectors" + insert: + - $ref: "#/components/x-stackQL-resources/network_connectors/methods/create_network_connector" + update: + - $ref: "#/components/x-stackQL-resources/network_connectors/methods/update_network_connector" + delete: + - $ref: "#/components/x-stackQL-resources/network_connectors/methods/delete_network_connector" diff --git a/providers/src/aws/v00.00.00000/services/lambda_microvms.yaml b/providers/src/aws/v00.00.00000/services/lambda_microvms.yaml new file mode 100644 index 00000000..dedc8233 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/lambda_microvms.yaml @@ -0,0 +1,2351 @@ +openapi: 3.0.0 +info: + version: "2025-09-09" + title: Lambda MicroVMs + description: Lambda MicroVMs + x-serviceName: lambda + x-serviceAlias: lambda_microvms + x-protocol: rest-json + x-apiVersion: "2025-09-09" + x-endpointPrefix: lambda +servers: + - url: https://lambda.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for lambda-microvms +paths: + /2025-09-09/microvms/{microvm_identifier}/auth-token: + post: + operationId: CreateMicrovmAuthToken + description: Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to create an authentication token for. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + expirationInMinutes: + $ref: "#/components/schemas/PositiveInteger" + allowedPorts: + $ref: "#/components/schemas/ListOfPortSpecification" + required: + - expirationInMinutes + - allowedPorts + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateMicrovmAuthTokenResponse" + /2025-09-09/microvm-images: + post: + operationId: CreateMicrovmImage + description: Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + baseImageVersion: + $ref: "#/components/schemas/Version" + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: + $ref: "#/components/schemas/String" + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + logging: + $ref: "#/components/schemas/Logging" + egressNetworkConnectors: + $ref: "#/components/schemas/CreateMicrovmImageRequestEgressNetworkConnectorsList" + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + resources: + $ref: "#/components/schemas/ResourcesList" + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + $ref: "#/components/schemas/EnvironmentVariableMap" + name: + $ref: "#/components/schemas/ImageName" + tags: + $ref: "#/components/schemas/Tags" + clientToken: + $ref: "#/components/schemas/CreateMicrovmImageRequestClientTokenString" + required: + - baseImageArn + - buildRoleArn + - codeArtifact + - name + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateMicrovmImageResponse" + get: + operationId: ListMicrovmImages + description: Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListMicrovmImagesRequestMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + - name: nameFilter + in: query + required: false + schema: + $ref: "#/components/schemas/NonBlankString" + description: Filters images whose name contains the specified string. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMicrovmImagesResponse" + /2025-09-09/microvms/{microvm_identifier}/shell-auth-token: + post: + operationId: CreateMicrovmShellAuthToken + description: Creates a shell authentication token for interactive shell access to a running MicroVM. The MicroVM must have been run with the SHELL_INGRESS network connector attached. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to create a shell authentication token for. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + expirationInMinutes: + $ref: "#/components/schemas/PositiveInteger" + required: + - expirationInMinutes + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateMicrovmShellAuthTokenResponse" + /2025-09-09/microvm-images/{image_identifier}: + delete: + operationId: DeleteMicrovmImage + description: Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteMicrovmImageOutput" + get: + operationId: GetMicrovmImage + description: Retrieves the details of a MicroVM image, including its state, versions, and configuration. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetMicrovmImageOutput" + put: + operationId: UpdateMicrovmImage + description: Updates the configuration of a MicroVM image and triggers a new version build. This operation uses PUT semantics — all required fields (codeArtifact, baseImageArn, buildRoleArn) must be provided with every request. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + baseImageVersion: + $ref: "#/components/schemas/Version" + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: + $ref: "#/components/schemas/String" + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + logging: + $ref: "#/components/schemas/Logging" + egressNetworkConnectors: + $ref: "#/components/schemas/UpdateMicrovmImageRequestEgressNetworkConnectorsList" + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + resources: + $ref: "#/components/schemas/ResourcesList" + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + $ref: "#/components/schemas/EnvironmentVariableMap" + clientToken: + $ref: "#/components/schemas/UpdateMicrovmImageRequestClientTokenString" + required: + - baseImageArn + - buildRoleArn + - codeArtifact + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateMicrovmImageResponse" + /2025-09-09/microvm-images/{image_identifier}/versions/{image_version}: + delete: + operationId: DeleteMicrovmImageVersion + description: Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image. + - name: image_version + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteMicrovmImageVersionOutput" + get: + operationId: GetMicrovmImageVersion + description: Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image. + - name: image_version + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetMicrovmImageVersionOutput" + patch: + operationId: UpdateMicrovmImageVersion + description: Updates the status of a specific MicroVM image version. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image. + - name: image_version + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + $ref: "#/components/schemas/MicrovmImageVersionStatus" + required: + - status + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateMicrovmImageVersionResponse" + /2025-09-09/microvms/{microvm_identifier}: + get: + operationId: GetMicrovm + description: Retrieves the details of a specific MicroVM, including its state, endpoint, image information, and configuration. The state field is eventually consistent — determine readiness by connecting to the endpoint. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetMicrovmResponse" + delete: + operationId: TerminateMicrovm + description: Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to terminate. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TerminateMicrovmResponse" + /2025-09-09/microvm-images/{image_identifier}/versions/{image_version}/builds/{build_id}: + get: + operationId: GetMicrovmImageBuild + description: Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information. + parameters: + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image. + - name: image_version + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + - name: build_id + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The unique identifier of the build to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetMicrovmImageBuildOutput" + /2025-09-09/managed-microvm-images/{image_identifier}/versions: + get: + operationId: ListManagedMicrovmImageVersions + description: Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListManagedMicrovmImageVersionsInputMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the managed MicroVM image to list versions for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListManagedMicrovmImageVersionsOutput" + /2025-09-09/managed-microvm-images: + get: + operationId: ListManagedMicrovmImages + description: Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListManagedMicrovmImagesInputMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListManagedMicrovmImagesOutput" + /2025-09-09/microvm-images/{image_identifier}/versions/{image_version}/builds: + get: + operationId: ListMicrovmImageBuilds + description: Lists builds for a MicroVM image version with optional filtering by architecture and chipset. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListMicrovmImageBuildsInputMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image. + - name: image_version + in: path + required: true + schema: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image to list builds for. + - name: architecture + in: query + required: false + schema: + $ref: "#/components/schemas/Architecture" + description: Filters builds by target CPU architecture. + - name: chipset + in: query + required: false + schema: + $ref: "#/components/schemas/Chipset" + description: Filters builds by target chipset. + - name: chipsetGeneration + in: query + required: false + schema: + $ref: "#/components/schemas/NonBlankString" + description: Filters builds by target chipset generation. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMicrovmImageBuildsOutput" + /2025-09-09/microvm-images/{image_identifier}/versions: + get: + operationId: ListMicrovmImageVersions + description: Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListMicrovmImageVersionsInputMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + - name: image_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The unique identifier (ARN or ID) of the MicroVM image to list versions for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMicrovmImageVersionsOutput" + /2025-09-09/microvms: + get: + operationId: ListMicrovms + description: Lists MicroVMs in the account with optional filtering by image and version. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListMicrovmsRequestMaxResultsInteger" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call. Use this token to retrieve the next page of results. + - name: imageIdentifier + in: query + required: false + schema: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: Optional filter to list only MicroVMs running the specified image. + - name: imageVersion + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: Optional filter to list only MicroVMs running the specified image version. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMicrovmsResponse" + post: + operationId: RunMicrovm + description: Runs a new MicroVM from the specified image. The MicroVM starts in PENDING state and transitions to RUNNING once provisioning completes. To connect, generate an authentication token using CreateMicrovmAuthToken. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ingressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + egressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + imageIdentifier: + $ref: "#/components/schemas/MicrovmImageIdentifier" + imageVersion: + $ref: "#/components/schemas/Version" + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + idlePolicy: + $ref: "#/components/schemas/IdlePolicy" + logging: + $ref: "#/components/schemas/Logging" + runHookPayload: + $ref: "#/components/schemas/RunMicrovmRequestRunHookPayloadString" + maximumDurationInSeconds: + $ref: "#/components/schemas/RunMicrovmRequestMaximumDurationInSecondsInteger" + clientToken: + $ref: "#/components/schemas/RunMicrovmRequestClientTokenString" + required: + - imageIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RunMicrovmResponse" + /2017-03-31/tags/{resource}: + get: + operationId: ListTags + description: Lists the tags associated with a Lambda MicroVM resource. + parameters: + - name: resource + in: path + required: true + schema: + $ref: "#/components/schemas/TaggableResource" + description: The ARN of the resource to list tags for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsResponse" + post: + operationId: TagResource + description: Adds tags to a Lambda MicroVM resource. + parameters: + - name: resource + in: path + required: true + schema: + $ref: "#/components/schemas/TaggableResource" + description: The ARN of the resource to tag. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Tags: + $ref: "#/components/schemas/Tags" + responses: + "204": + description: Success + delete: + operationId: UntagResource + description: Removes tags from a Lambda MicroVM resource. + parameters: + - name: resource + in: path + required: true + schema: + $ref: "#/components/schemas/TaggableResource" + description: The ARN of the resource to remove tags from. + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeyList" + description: The list of tag keys to remove from the resource. + responses: + "204": + description: Success + /2025-09-09/microvms/{microvm_identifier}/resume: + post: + operationId: ResumeMicrovm + description: Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to resume. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ResumeMicrovmResponse" + /2025-09-09/microvms/{microvm_identifier}/suspend: + post: + operationId: SuspendMicrovm + description: Suspends a running MicroVM, preserving its full memory and disk state. The MicroVM transitions through SUSPENDING to SUSPENDED. To restore, call ResumeMicrovm or send traffic to the endpoint if autoResumeEnabled is true. + parameters: + - name: microvm_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The ID of the MicroVM to suspend. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SuspendMicrovmResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + MicrovmIdentifier: + description: The ARN or ID of the MicroVm + type: string + minLength: 1 + maxLength: 256 + PositiveInteger: + type: integer + minimum: 1 + ListOfPortSpecification: + description: A list of port specifications. + type: array + items: + $ref: "#/components/schemas/PortSpecification" + PortSpecification: + description: Specifies which ports are accessible on a MicroVM. Only one of the port specification options can be set. + type: object + properties: + port: + $ref: "#/components/schemas/PortNumber" + description: A single port number. + range: + $ref: "#/components/schemas/PortRange" + description: A range of ports. + allPorts: + $ref: "#/components/schemas/Unit" + description: Indicates that all ports are accessible. + PortNumber: + description: Represents a single port. + type: integer + minimum: 1 + maximum: 65535 + PortRange: + description: Specifies a range of ports. + type: object + properties: + startPort: + $ref: "#/components/schemas/PortNumber" + description: The starting port number of the range. + endPort: + $ref: "#/components/schemas/PortNumber" + description: The ending port number of the range. + required: + - startPort + - endPort + Unit: + type: object + CreateMicrovmAuthTokenResponse: + type: object + properties: + authToken: + type: object + properties: {} + description: A map containing the authentication token. Use the value at key "X-aws-proxy-auth" as the header value when connecting to the MicroVM endpoint. + required: + - authToken + NonBlankString: + description: A string which is not empty or blank (only whitespace). + type: string + minLength: 1 + maxLength: 2048 + pattern: "[^\\s]+" + Version: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[^\\s]+" + RoleArn: + description: The ARN of an IAM role that the service assumes to perform actions on behalf of the caller. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws[a-z\-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + String: + type: string + CodeArtifact: + description: Contains the location of the code artifact for a MicroVM image. + type: object + properties: + uri: + $ref: "#/components/schemas/NonBlankString" + description: The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI. + Logging: + description: "Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging." + type: object + properties: + disabled: + $ref: "#/components/schemas/LoggingDisabled" + description: Specifies that logging is disabled. + cloudWatch: + $ref: "#/components/schemas/CloudWatchLogging" + description: Configuration for sending logs to Amazon CloudWatch Logs. + LoggingDisabled: + description: Specifies that logging is disabled for the MicroVM. + type: object + CloudWatchLogging: + description: Configuration for Amazon CloudWatch Logs logging. + type: object + properties: + logGroup: + $ref: "#/components/schemas/CloudWatchLoggingLogGroupString" + description: The name of the CloudWatch Logs log group to send logs to. + logStream: + $ref: "#/components/schemas/CloudWatchLoggingLogStreamString" + description: The name of the CloudWatch Logs log stream within the log group. + CloudWatchLoggingLogGroupString: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9_\\-/.#]+" + CloudWatchLoggingLogStreamString: + type: string + minLength: 1 + maxLength: 512 + pattern: "[^:*]*" + CreateMicrovmImageRequestEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + NetworkConnector: + type: string + minLength: 1 + maxLength: 2048 + CpuConfigurationList: + description: List of CPU architectures + type: array + items: + $ref: "#/components/schemas/CpuConfiguration" + CpuConfiguration: + description: Configuration for the CPU architecture of a MicroVM. + type: object + properties: + architecture: + $ref: "#/components/schemas/Architecture" + description: The CPU architecture. + required: + - architecture + Architecture: + type: string + enum: + - ARM_64 + ResourcesList: + description: List of resources + type: array + items: + $ref: "#/components/schemas/Resources" + Resources: + description: Resource requirements for a MicroVM. + type: object + properties: + minimumMemoryInMiB: + $ref: "#/components/schemas/Integer" + description: The minimum amount of memory in MiB to allocate to the MicroVM. + required: + - minimumMemoryInMiB + Integer: + type: integer + CapabilityList: + description: List of capabilities granted to the application when booted + type: array + items: + $ref: "#/components/schemas/Capability" + Capability: + description: Capability granted to the application when booted + type: string + enum: + - ALL + Hooks: + description: Lifecycle hook configuration for MicroVMs and MicroVM images. + type: object + properties: + port: + $ref: "#/components/schemas/HooksPortInteger" + description: The port number on which the hooks listener runs. + microvmHooks: + $ref: "#/components/schemas/MicrovmHooks" + description: The lifecycle hooks for MicroVM events. + microvmImageHooks: + $ref: "#/components/schemas/MicrovmImageHooks" + description: The hooks for MicroVM image build events. + HooksPortInteger: + type: integer + minimum: 1 + maximum: 65535 + MicrovmHooks: + description: Configuration for lifecycle hooks invoked during MicroVM events such as run, resume, suspend, and terminate. + type: object + properties: + run: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked when the MicroVM starts running. + runTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmHooksRunTimeoutInSecondsInteger" + description: The maximum time in seconds for the run hook to complete. + resume: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked when the MicroVM resumes from a suspended state. + resumeTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmHooksResumeTimeoutInSecondsInteger" + description: The maximum time in seconds for the resume hook to complete. + suspend: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked when the MicroVM is suspended. + suspendTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmHooksSuspendTimeoutInSecondsInteger" + description: The maximum time in seconds for the suspend hook to complete. + terminate: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked when the MicroVM is terminated. + terminateTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmHooksTerminateTimeoutInSecondsInteger" + description: The maximum time in seconds for the terminate hook to complete. + HookState: + description: Whether invocation hooks are enabled or disabled on a MicroVm. + type: string + enum: + - DISABLED + - ENABLED + MicrovmHooksRunTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 60 + MicrovmHooksResumeTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 60 + MicrovmHooksSuspendTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 60 + MicrovmHooksTerminateTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 60 + MicrovmImageHooks: + description: Configuration for hooks invoked during MicroVM image build events such as ready and validate. + type: object + properties: + ready: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked when the MicroVM image build is ready. + readyTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmImageHooksReadyTimeoutInSecondsInteger" + description: The maximum time in seconds for the ready hook to complete. + validate: + $ref: "#/components/schemas/HookState" + description: The path of the hook invoked to validate the MicroVM image build. + validateTimeoutInSeconds: + $ref: "#/components/schemas/MicrovmImageHooksValidateTimeoutInSecondsInteger" + description: The maximum time in seconds for the validate hook to complete. + MicrovmImageHooksReadyTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 3600 + MicrovmImageHooksValidateTimeoutInSecondsInteger: + type: integer + minimum: 1 + maximum: 3600 + EnvironmentVariableMap: + type: object + properties: {} + ImageName: + description: Name of a MicroVM image. + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9-_]+" + Tags: + type: object + properties: {} + CreateMicrovmImageRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateMicrovmImageResponse: + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the created MicroVM image. + name: + $ref: "#/components/schemas/ImageName" + description: The name of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageState" + description: The current state of the MicroVM image. + latestActiveImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest active version of the MicroVM image. + latestFailedImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest failed version of the MicroVM image, if any. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was created. + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the base MicroVM image. + baseImageVersion: + $ref: "#/components/schemas/Version" + description: The specific version of the base MicroVM image. + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM build role. + description: + $ref: "#/components/schemas/String" + description: The description of the MicroVM image. + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + description: The code artifact containing the application code and metadata for the MicroVM image. + logging: + $ref: "#/components/schemas/Logging" + description: 'The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.' + egressNetworkConnectors: + $ref: "#/components/schemas/CreateMicrovmImageResponseEgressNetworkConnectorsList" + description: The list of egress network connectors available to the MicroVM at runtime. + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + description: The list of supported CPU configurations for the MicroVM. + resources: + $ref: "#/components/schemas/ResourcesList" + description: The resource requirements for the MicroVM. + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + description: Additional OS capabilities granted to the MicroVM runtime environment. + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + type: object + properties: {} + description: Environment variables set in the MicroVM runtime environment. + tags: + type: object + properties: {} + description: A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was last updated. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + required: + - imageArn + - name + - state + - createdAt + - baseImageArn + - buildRoleArn + - codeArtifact + - imageVersion + MicrovmImageState: + type: string + enum: + - CREATING + - CREATED + - CREATE_FAILED + - UPDATING + - UPDATED + - UPDATE_FAILED + - DELETING + - DELETE_FAILED + - DELETED + Timestamp: + type: string + format: date-time + CreateMicrovmImageResponseEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + CreateMicrovmShellAuthTokenResponse: + type: object + properties: + authToken: + type: object + properties: {} + description: The generated shell authentication token key-value pairs for accessing the MicroVM. + required: + - authToken + MicrovmImageIdentifier: + description: The ARN or ID of the MicroVmImage + type: string + minLength: 1 + maxLength: 256 + DeleteMicrovmImageOutput: + type: object + properties: + imageIdentifier: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The identifier of the deleted MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageState" + description: The current state of the MicroVM image after deletion. + required: + - imageIdentifier + - state + DeleteMicrovmImageVersionOutput: + type: object + properties: + imageIdentifier: + $ref: "#/components/schemas/MicrovmImageIdentifier" + description: The identifier of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version that was deleted. + state: + $ref: "#/components/schemas/MicrovmImageVersionState" + description: The current state of the MicroVM image version after deletion. + required: + - imageIdentifier + - imageVersion + - state + MicrovmImageVersionState: + type: string + enum: + - PENDING + - IN_PROGRESS + - SUCCESSFUL + - FAILED + - DELETING + - DELETED + - DELETE_FAILED + GetMicrovmResponse: + type: object + properties: + microvmId: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The unique identifier of the MicroVM. + state: + $ref: "#/components/schemas/MicrovmState" + description: The current lifecycle state of the MicroVM. + endpoint: + $ref: "#/components/schemas/GetMicrovmResponseEndpointString" + description: The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests. + imageArn: + $ref: "#/components/schemas/MicrovmImageArn" + description: The ARN of the MicroVM image used to run this MicroVM. + imageVersion: + $ref: "#/components/schemas/Version" + description: The version of the MicroVM image used to run this MicroVM. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role assumed by the MicroVM. + idlePolicy: + $ref: "#/components/schemas/IdlePolicy" + description: The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior. + maximumDurationInSeconds: + $ref: "#/components/schemas/Integer" + description: The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM first started. + terminatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM terminated. + stateReason: + $ref: "#/components/schemas/NonBlankString" + description: The reason for why the MicroVM is in the current state. + ingressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + description: The list of ingress network connectors configured for the MicroVM. + egressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + description: The list of egress network connectors configured for the MicroVM. + required: + - microvmId + - state + - endpoint + - imageArn + - imageVersion + - maximumDurationInSeconds + - startedAt + MicrovmState: + description: The lifecycle state of a MicroVm. + type: string + enum: + - PENDING + - RUNNING + - SUSPENDING + - SUSPENDED + - TERMINATING + - TERMINATED + GetMicrovmResponseEndpointString: + type: string + minLength: 1 + maxLength: 2048 + MicrovmImageArn: + description: MicroVm Image Arn + type: string + minLength: 20 + maxLength: 2048 + IdlePolicy: + description: Configuration that controls MicroVM auto-suspend and auto-resume behavior. Idle time is measured by inbound traffic through the MicroVM proxy endpoint — if no requests arrive within the configured duration, the MicroVM is suspended. + type: object + properties: + maxIdleDurationSeconds: + $ref: "#/components/schemas/IdlePolicyMaxIdleDurationSecondsInteger" + description: The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended. + suspendedDurationSeconds: + $ref: "#/components/schemas/IdlePolicySuspendedDurationSecondsInteger" + description: The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated. + autoResumeEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the MicroVM automatically resumes when it receives a request while suspended. + required: + - maxIdleDurationSeconds + - suspendedDurationSeconds + - autoResumeEnabled + IdlePolicyMaxIdleDurationSecondsInteger: + type: integer + minimum: 60 + IdlePolicySuspendedDurationSecondsInteger: + type: integer + minimum: 0 + Boolean: + type: boolean + NetworkConnectorList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + GetMicrovmImageOutput: + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + name: + $ref: "#/components/schemas/ImageName" + description: The name of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageState" + description: The current state of the MicroVM image. + latestActiveImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest active version of the MicroVM image. + latestFailedImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest failed version of the MicroVM image, if any. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was created. + tags: + type: object + properties: {} + description: A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was last updated. + required: + - imageArn + - name + - state + - createdAt + GetMicrovmImageBuildOutput: + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + buildId: + $ref: "#/components/schemas/NonBlankString" + description: The build request ID. + buildState: + $ref: "#/components/schemas/BuildState" + description: The current state of the build. + architecture: + $ref: "#/components/schemas/Architecture" + description: "The target CPU architecture for the build. Supported value: ARM_64." + chipset: + $ref: "#/components/schemas/Chipset" + description: The target chipset for the build. + chipsetGeneration: + $ref: "#/components/schemas/NonBlankString" + description: The target chipset generation for the build. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the build state, if applicable. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the build was created. + snapshotBuild: + $ref: "#/components/schemas/SnapshotBuild" + description: The snapshot build details, including memory and disk snapshot sizes. + required: + - imageArn + - imageVersion + - buildId + - buildState + - architecture + - chipset + - chipsetGeneration + - createdAt + BuildState: + type: string + enum: + - PENDING + - IN_PROGRESS + - SUCCESSFUL + - FAILED + Chipset: + type: string + enum: + - GRAVITON + SnapshotBuild: + description: Contains size information about a MicroVM image snapshot build. + type: object + properties: + memorySnapshotSizeInBytes: + $ref: "#/components/schemas/Long" + description: The size of the memory snapshot in bytes. + codeInstallSizeInBytes: + $ref: "#/components/schemas/Long" + description: The size of the installed code in bytes. + diskSnapshotSizeInBytes: + $ref: "#/components/schemas/Long" + description: The size of the disk snapshot in bytes. + Long: + type: integer + format: int64 + GetMicrovmImageVersionOutput: + type: object + properties: + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the base MicroVM image used. + baseImageVersion: + $ref: "#/components/schemas/Version" + description: The specific version of the base MicroVM image. + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM build role. + description: + $ref: "#/components/schemas/String" + description: The description of the version. + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + description: The code artifact for this version. + logging: + $ref: "#/components/schemas/Logging" + description: The logging configuration for this version. + egressNetworkConnectors: + $ref: "#/components/schemas/GetMicrovmImageVersionOutputEgressNetworkConnectorsList" + description: The list of egress network connectors available to the MicroVM at runtime. + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + description: The list of supported CPU configurations for the MicroVM. + resources: + $ref: "#/components/schemas/ResourcesList" + description: The resource requirements for the MicroVM. + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + description: Additional OS capabilities granted to the MicroVM runtime environment. + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + type: object + properties: {} + description: Environment variables set in the MicroVM runtime environment. + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageVersionState" + description: The current state of the version. + status: + $ref: "#/components/schemas/MicrovmImageVersionStatus" + description: "The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs)." + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was last updated. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the current state. For example, one or more builds failed. + tags: + type: object + properties: {} + description: Key-value pairs associated with the version. + required: + - baseImageArn + - buildRoleArn + - codeArtifact + - imageArn + - imageVersion + - state + - status + - createdAt + GetMicrovmImageVersionOutputEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + MicrovmImageVersionStatus: + type: string + enum: + - ACTIVE + - INACTIVE + ListManagedMicrovmImageVersionsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListManagedMicrovmImageVersionsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/ManagedMicrovmImageVersionList" + description: The list of managed MicroVM image versions. + required: + - items_ + ManagedMicrovmImageVersionList: + type: array + items: + $ref: "#/components/schemas/ManagedMicrovmImageVersion" + ManagedMicrovmImageVersion: + description: Contains version information for a managed MicroVM image. + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the managed MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the managed MicroVM image. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was last updated. + required: + - imageArn + - imageVersion + - createdAt + ListManagedMicrovmImagesInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListManagedMicrovmImagesOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/ManagedMicrovmImageSummaryList" + description: The list of managed MicroVM images. + required: + - items_ + ManagedMicrovmImageSummaryList: + type: array + items: + $ref: "#/components/schemas/ManagedMicrovmImageSummary" + ManagedMicrovmImageSummary: + description: Contains summary information about a managed MicroVM image. + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the managed MicroVM image. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the managed MicroVM image was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the managed MicroVM image was last updated. + required: + - imageArn + - createdAt + ListMicrovmImageBuildsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListMicrovmImageBuildsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/MicrovmImageBuildSummaries" + description: The list of MicroVM image builds. + required: + - items_ + MicrovmImageBuildSummaries: + type: array + items: + $ref: "#/components/schemas/MicrovmImageBuildSummary" + MicrovmImageBuildSummary: + description: Contains summary information about a MicroVM image build. + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + buildId: + $ref: "#/components/schemas/NonBlankString" + description: The build request ID. + buildState: + $ref: "#/components/schemas/BuildState" + description: The current state of the build. + architecture: + $ref: "#/components/schemas/Architecture" + description: "The target CPU architecture for the build. Supported value: ARM_64." + chipset: + $ref: "#/components/schemas/Chipset" + description: The target chipset for the build. + chipsetGeneration: + $ref: "#/components/schemas/NonBlankString" + description: The target chipset generation for the build. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the build state, if applicable. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the build was created. + required: + - imageArn + - imageVersion + - buildId + - buildState + - architecture + - chipset + - chipsetGeneration + - createdAt + ListMicrovmImageVersionsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListMicrovmImageVersionsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/MicrovmImageVersionSummaryList" + description: The list of MicroVM image versions. + required: + - items_ + MicrovmImageVersionSummaryList: + description: List of MicroVM image version summaries + type: array + items: + $ref: "#/components/schemas/MicrovmImageVersionSummary" + MicrovmImageVersionSummary: + description: Contains summary information about a version of a MicroVM image. + type: object + properties: + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the base MicroVM image used. + baseImageVersion: + $ref: "#/components/schemas/Version" + description: The specific version of the base MicroVM image. + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM build role. + description: + $ref: "#/components/schemas/String" + description: The description of the version. + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + description: The code artifact for this version. + logging: + $ref: "#/components/schemas/Logging" + description: The logging configuration for this version. + egressNetworkConnectors: + $ref: "#/components/schemas/MicrovmImageVersionSummaryEgressNetworkConnectorsList" + description: The list of egress network connectors available to the MicroVM at runtime. + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + description: The list of supported CPU configurations for the MicroVM. + resources: + $ref: "#/components/schemas/ResourcesList" + description: The resource requirements for the MicroVM. + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + description: Additional OS capabilities granted to the MicroVM runtime environment. + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + type: object + properties: {} + description: Environment variables set in the MicroVM runtime environment. + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageVersionState" + description: The current state of the version. + status: + $ref: "#/components/schemas/MicrovmImageVersionStatus" + description: "The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs)." + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was last updated. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the current state. For example, one or more builds failed. + tags: + type: object + properties: {} + description: Key-value pairs associated with the version. + required: + - baseImageArn + - buildRoleArn + - codeArtifact + - imageArn + - imageVersion + - state + - status + - createdAt + MicrovmImageVersionSummaryEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + ListMicrovmImagesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListMicrovmImagesResponse: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/MicrovmImageSummaries" + description: The list of MicroVM images. + required: + - items_ + MicrovmImageSummaries: + description: List of MicroVM image summaries + type: array + items: + $ref: "#/components/schemas/MicrovmImageSummary" + MicrovmImageSummary: + description: Contains summary information about a MicroVM image. + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + name: + $ref: "#/components/schemas/ImageName" + description: The name of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageState" + description: The current state of the MicroVM image. + latestActiveImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest active version of the MicroVM image. + latestFailedImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest failed version of the MicroVM image, if any. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was created. + required: + - imageArn + - name + - state + - createdAt + ListMicrovmsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 50 + ListMicrovmsResponse: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return. + items_: + $ref: "#/components/schemas/MicrovmItemList" + description: The list of MicroVMs. + required: + - items_ + MicrovmItemList: + type: array + items: + $ref: "#/components/schemas/MicrovmItem" + MicrovmItem: + description: Contains summary information about a MicroVM instance. + type: object + properties: + microvmId: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The unique identifier of the MicroVM. + state: + $ref: "#/components/schemas/MicrovmState" + description: The current lifecycle state of the MicroVM. + imageArn: + $ref: "#/components/schemas/MicrovmImageArn" + description: The ARN of the MicroVM image used to run this MicroVM. + imageVersion: + $ref: "#/components/schemas/Version" + description: The version of the MicroVM image used to run this MicroVM. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM started. + required: + - microvmId + - state + - imageArn + - imageVersion + - startedAt + TaggableResource: + description: ARN of a taggable Lambda resource. + type: string + minLength: 1 + maxLength: 10000 + pattern: arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:(function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?|layer:([a-zA-Z0-9-_]+)|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|(capacity-provider|network-connector|microvm-image):[a-zA-Z0-9-_]+) + ListTagsResponse: + type: object + properties: + Tags: + type: object + properties: {} + description: The key-value pairs of tags associated with the resource. + ResumeMicrovmResponse: + type: object + RunMicrovmRequestRunHookPayloadString: + type: string + minLength: 0 + maxLength: 4096 + RunMicrovmRequestMaximumDurationInSecondsInteger: + type: integer + minimum: 1 + maximum: 28800 + RunMicrovmRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + RunMicrovmResponse: + type: object + properties: + microvmId: + $ref: "#/components/schemas/MicrovmIdentifier" + description: The unique identifier of the MicroVM. + state: + $ref: "#/components/schemas/MicrovmState" + description: The current lifecycle state of the MicroVM. + endpoint: + $ref: "#/components/schemas/RunMicrovmResponseEndpointString" + description: The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests. + imageArn: + $ref: "#/components/schemas/MicrovmImageArn" + description: The ARN of the MicroVM image used to run this MicroVM. + imageVersion: + $ref: "#/components/schemas/Version" + description: The version of the MicroVM image used to run this MicroVM. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role assumed by the MicroVM. + idlePolicy: + $ref: "#/components/schemas/IdlePolicy" + description: The idle policy configuration of the MicroVM. + maximumDurationInSeconds: + $ref: "#/components/schemas/Integer" + description: The maximum duration in seconds that the MicroVM can exist. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM first started. + terminatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM terminated. + stateReason: + $ref: "#/components/schemas/NonBlankString" + description: The reason for why the MicroVM is in the current state. + ingressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + description: The list of ingress network connectors configured for the MicroVM. + egressNetworkConnectors: + $ref: "#/components/schemas/NetworkConnectorList" + description: The list of egress network connectors configured for the MicroVM. + required: + - microvmId + - state + - endpoint + - imageArn + - imageVersion + - maximumDurationInSeconds + - startedAt + RunMicrovmResponseEndpointString: + type: string + minLength: 1 + maxLength: 2048 + SuspendMicrovmResponse: + type: object + TerminateMicrovmResponse: + type: object + TagKeyList: + type: array + items: + $ref: "#/components/schemas/TagKey" + TagKey: + type: string + minLength: 1 + maxLength: 128 + pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*) + UpdateMicrovmImageRequestEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + UpdateMicrovmImageRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + UpdateMicrovmImageResponse: + type: object + properties: + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + name: + $ref: "#/components/schemas/ImageName" + description: The name of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageState" + description: The current state of the MicroVM image. + latestActiveImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest active version of the MicroVM image. + latestFailedImageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The latest failed version of the MicroVM image, if any. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was created. + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the base MicroVM image. + baseImageVersion: + $ref: "#/components/schemas/Version" + description: The specific version of the base MicroVM image. + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM build role. + description: + $ref: "#/components/schemas/String" + description: The description of the MicroVM image. + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + description: The code artifact containing the application code and metadata for the MicroVM image. + logging: + $ref: "#/components/schemas/Logging" + description: 'The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.' + egressNetworkConnectors: + $ref: "#/components/schemas/UpdateMicrovmImageResponseEgressNetworkConnectorsList" + description: The list of egress network connectors available to the MicroVM at runtime. + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + description: The list of supported CPU configurations for the MicroVM. + resources: + $ref: "#/components/schemas/ResourcesList" + description: The resource requirements for the MicroVM. + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + description: Additional OS capabilities granted to the MicroVM runtime environment. + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + type: object + properties: {} + description: Environment variables set in the MicroVM runtime environment. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the MicroVM image was last updated. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + required: + - imageArn + - name + - state + - createdAt + - baseImageArn + - buildRoleArn + - codeArtifact + - updatedAt + - imageVersion + UpdateMicrovmImageResponseEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + UpdateMicrovmImageVersionResponse: + type: object + properties: + baseImageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the base MicroVM image used. + baseImageVersion: + $ref: "#/components/schemas/Version" + description: The specific version of the base MicroVM image. + buildRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM build role. + description: + $ref: "#/components/schemas/String" + description: The description of the version. + codeArtifact: + $ref: "#/components/schemas/CodeArtifact" + description: The code artifact for this version. + logging: + $ref: "#/components/schemas/Logging" + description: The logging configuration for this version. + egressNetworkConnectors: + $ref: "#/components/schemas/UpdateMicrovmImageVersionResponseEgressNetworkConnectorsList" + description: The list of egress network connectors available to the MicroVM at runtime. + cpuConfigurations: + $ref: "#/components/schemas/CpuConfigurationList" + description: The list of supported CPU configurations for the MicroVM. + resources: + $ref: "#/components/schemas/ResourcesList" + description: The resource requirements for the MicroVM. + additionalOsCapabilities: + $ref: "#/components/schemas/CapabilityList" + description: Additional OS capabilities granted to the MicroVM runtime environment. + hooks: + $ref: "#/components/schemas/Hooks" + environmentVariables: + type: object + properties: {} + description: Environment variables set in the MicroVM runtime environment. + imageArn: + $ref: "#/components/schemas/NonBlankString" + description: The ARN of the MicroVM image. + imageVersion: + $ref: "#/components/schemas/NonBlankString" + description: The version of the MicroVM image. + state: + $ref: "#/components/schemas/MicrovmImageVersionState" + description: The current state of the version. + status: + $ref: "#/components/schemas/MicrovmImageVersionStatus" + description: "The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs)." + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the version was last updated. + stateReason: + $ref: "#/components/schemas/String" + description: The reason for the current state. For example, one or more builds failed. + tags: + type: object + properties: {} + description: Key-value pairs associated with the version. + required: + - baseImageArn + - buildRoleArn + - codeArtifact + - imageArn + - imageVersion + - state + - status + - createdAt + UpdateMicrovmImageVersionResponseEgressNetworkConnectorsList: + type: array + items: + $ref: "#/components/schemas/NetworkConnector" + x-stackQL-resources: + microvms: + id: aws.lambda_microvms.microvms + name: microvms + title: microvms + methods: + create_microvm_auth_token: + operation: + $ref: "#/paths/~12025-09-09~1microvms~1{microvm_identifier}~1auth-token/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_microvm_shell_auth_token: + operation: + $ref: "#/paths/~12025-09-09~1microvms~1{microvm_identifier}~1shell-auth-token/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_microvm: + operation: + $ref: "#/paths/~12025-09-09~1microvms~1{microvm_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + terminate_microvm: + operation: + $ref: "#/paths/~12025-09-09~1microvms~1{microvm_identifier}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + list_microvms: + operation: + $ref: "#/paths/~12025-09-09~1microvms/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + suspend_microvm: + operation: + $ref: "#/paths/~12025-09-09~1microvms~1{microvm_identifier}~1suspend/post" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/microvms/methods/get_microvm" + - $ref: "#/components/x-stackQL-resources/microvms/methods/list_microvms" + insert: + - $ref: "#/components/x-stackQL-resources/microvms/methods/create_microvm_auth_token" + - $ref: "#/components/x-stackQL-resources/microvms/methods/create_microvm_shell_auth_token" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/microvms/methods/terminate_microvm" + microvm_images: + id: aws.lambda_microvms.microvm_images + name: microvm_images + title: microvm_images + methods: + create_microvm_image: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_microvm_images: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_microvm_image: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_microvm_image: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_microvm_image: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/microvm_images/methods/get_microvm_image" + - $ref: "#/components/x-stackQL-resources/microvm_images/methods/list_microvm_images" + insert: + - $ref: "#/components/x-stackQL-resources/microvm_images/methods/create_microvm_image" + update: + - $ref: "#/components/x-stackQL-resources/microvm_images/methods/update_microvm_image" + delete: + - $ref: "#/components/x-stackQL-resources/microvm_images/methods/delete_microvm_image" + microvm_image_versions: + id: aws.lambda_microvms.microvm_image_versions + name: microvm_image_versions + title: microvm_image_versions + methods: + delete_microvm_image_version: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions~1{image_version}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_microvm_image_version: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions~1{image_version}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_microvm_image_version: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions~1{image_version}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_microvm_image_versions: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/microvm_image_versions/methods/get_microvm_image_version" + - $ref: "#/components/x-stackQL-resources/microvm_image_versions/methods/list_microvm_image_versions" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/microvm_image_versions/methods/update_microvm_image_version" + delete: + - $ref: "#/components/x-stackQL-resources/microvm_image_versions/methods/delete_microvm_image_version" + microvm_image_builds: + id: aws.lambda_microvms.microvm_image_builds + name: microvm_image_builds + title: microvm_image_builds + methods: + get_microvm_image_build: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions~1{image_version}~1builds~1{build_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_microvm_image_builds: + operation: + $ref: "#/paths/~12025-09-09~1microvm-images~1{image_identifier}~1versions~1{image_version}~1builds/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/microvm_image_builds/methods/get_microvm_image_build" + - $ref: "#/components/x-stackQL-resources/microvm_image_builds/methods/list_microvm_image_builds" + insert: [] + update: [] + delete: [] + managed_microvm_image_versions: + id: aws.lambda_microvms.managed_microvm_image_versions + name: managed_microvm_image_versions + title: managed_microvm_image_versions + methods: + list_managed_microvm_image_versions: + operation: + $ref: "#/paths/~12025-09-09~1managed-microvm-images~1{image_identifier}~1versions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/managed_microvm_image_versions/methods/list_managed_microvm_image_versions" + insert: [] + update: [] + delete: [] + managed_microvm_images: + id: aws.lambda_microvms.managed_microvm_images + name: managed_microvm_images + title: managed_microvm_images + methods: + list_managed_microvm_images: + operation: + $ref: "#/paths/~12025-09-09~1managed-microvm-images/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/managed_microvm_images/methods/list_managed_microvm_images" + insert: [] + update: [] + delete: [] + tags: + id: aws.lambda_microvms.tags + name: tags + title: tags + methods: + list_tags: + operation: + $ref: "#/paths/~12017-03-31~1tags~1{resource}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~12017-03-31~1tags~1{resource}/post" + response: + openAPIDocKey: "204" + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~12017-03-31~1tags~1{resource}/delete" + response: + openAPIDocKey: "204" + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/license_manager.yaml b/providers/src/aws/v00.00.00000/services/license_manager.yaml index 5dbebdfa..69188fe1 100644 --- a/providers/src/aws/v00.00.00000/services/license_manager.yaml +++ b/providers/src/aws/v00.00.00000/services/license_manager.yaml @@ -693,6 +693,9 @@ paths: SourceVersion: $ref: "#/components/schemas/String" description: Current version of the license. + ResetUsage: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to reset the license usage for the new license version. If you don't specify a value, the license usage is not reset. required: - LicenseArn - LicenseName @@ -3388,6 +3391,8 @@ components: LicenseManagerReportGeneratorArn: $ref: "#/components/schemas/String" description: The Amazon Resource Name (ARN) of the new report generator. + Boolean: + type: boolean CreateLicenseVersionResponse: type: object properties: @@ -3473,8 +3478,6 @@ components: type: object DeleteTokenResponse: type: object - Boolean: - type: boolean ExtendLicenseConsumptionResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/lightsail.yaml b/providers/src/aws/v00.00.00000/services/lightsail.yaml index 9bee75c3..221127fd 100644 --- a/providers/src/aws/v00.00.00000/services/lightsail.yaml +++ b/providers/src/aws/v00.00.00000/services/lightsail.yaml @@ -6274,7 +6274,9 @@ components: - eu-west-3 - eu-central-1 - eu-north-1 + - eu-south-2 - ca-central-1 + - ap-east-1 - ap-south-1 - ap-southeast-1 - ap-southeast-2 @@ -6282,6 +6284,7 @@ components: - ap-northeast-2 - ap-southeast-3 - ap-southeast-5 + - sa-east-1 boolean: type: boolean OperationType: diff --git a/providers/src/aws/v00.00.00000/services/logs.yaml b/providers/src/aws/v00.00.00000/services/logs.yaml index 352f27c6..b2a64fd1 100644 --- a/providers/src/aws/v00.00.00000/services/logs.yaml +++ b/providers/src/aws/v00.00.00000/services/logs.yaml @@ -423,7 +423,7 @@ paths: /CreateLookupTable: post: operationId: CreateLookupTable - description: Creates a lookup table by uploading CSV data. You can use lookup tables to enrich log data in CloudWatch Logs Insights queries with reference data such as user details, application names, or error descriptions. The table name must be unique within your account and Region. The CSV content must include a header row with column names, use UTF-8 encoding, and not exceed 10 MB. + description: Creates a lookup table by uploading CSV data or from CloudWatch Logs query results. You can use lookup tables to enrich log data in CloudWatch Logs queries with reference data such as user details, application names, or error descriptions. The table name must be unique within your account and Region. You must specify either tableBody or queryId, but not both. If you use tableBody, the CSV content must include a header row with column names, use UTF-8 encoding, and not exceed 10 MB. parameters: - name: X-Amz-Target in: header @@ -449,7 +449,10 @@ paths: description: A description of the lookup table. The description can be up to 1024 characters long. tableBody: $ref: "#/components/schemas/TableBody" - description: The CSV content of the lookup table. The first row must be a header row with column names. The content must use UTF-8 encoding and not exceed 10 MB. + description: The CSV content of the lookup table. The first row must be a header row with column names. The content must use UTF-8 encoding and not exceed 10 MB. You must specify either tableBody or queryId, but not both. + queryId: + $ref: "#/components/schemas/QueryId" + description: The ID of a completed or cancelled CloudWatch Logs query whose results populate the lookup table. A cancelled query populates the table with the partial results that were available when the query was stopped. You must specify either tableBody or queryId, but not both. kmsKeyId: $ref: "#/components/schemas/KmsKeyId" description: The ARN of the KMS key to use to encrypt the lookup table data. If you don't specify a key, the data is encrypted with an Amazon Web Services-owned key. @@ -458,7 +461,6 @@ paths: description: A list of key-value pairs to associate with the lookup table. You can associate as many as 50 tags with a lookup table. Tags can help you organize and categorize your resources. required: - lookupTableName - - tableBody responses: "200": description: Success @@ -489,7 +491,7 @@ paths: properties: name: $ref: "#/components/schemas/ScheduledQueryName" - description: The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters. + description: The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters. description: $ref: "#/components/schemas/ScheduledQueryDescription" description: An optional description for the scheduled query to help identify its purpose and functionality. @@ -511,9 +513,12 @@ paths: startTimeOffset: $ref: "#/components/schemas/StartTimeOffset" description: The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time. + endTimeOffset: + $ref: "#/components/schemas/EndTimeOffset" + description: The time offset in seconds that defines the end of the lookback period for the query. Together with startTimeOffset, this determines the time window relative to the execution time over which the query runs. destinationConfiguration: $ref: "#/components/schemas/DestinationConfiguration" - description: Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output. + description: Configuration for where to deliver query results. Supports Amazon S3 destinations for storing query output and lookup table destinations for automatically refreshing lookup tables with query results. You can configure one or both destination types. scheduleStartTime: $ref: "#/components/schemas/Timestamp" description: The start time for the scheduled query in Unix epoch format. The query will not execute before this time. @@ -1132,6 +1137,38 @@ paths: responses: "200": description: Success + /DeleteSyslogConfiguration: + post: + operationId: DeleteSyslogConfiguration + description: Deletes a syslog configuration for a log group. After deletion, syslog data is no longer ingested through the specified VPC endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Logs_20140328.DeleteSyslogConfiguration + default: Logs_20140328.DeleteSyslogConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + logGroupIdentifier: + $ref: "#/components/schemas/LogGroupIdentifier" + description: The name or ARN of the log group to remove the syslog configuration from. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint associated with the syslog configuration to delete. + required: + - logGroupIdentifier + responses: + "200": + description: Success /DeleteTransformer: post: operationId: DeleteTransformer @@ -1427,7 +1464,7 @@ paths: /DescribeFieldIndexes: post: operationId: DescribeFieldIndexes - description: Returns a list of custom and default field indexes which are discovered in log data. For more information about field index policies, see PutIndexPolicy. + description: Returns a list of field indexes discovered in log data. By default, the response includes the DEFAULT, CUSTOM, and INACTIVE index categories. To return indexes from other categories, use the indexCategories parameter. For more information about field index policies, see PutIndexPolicy. parameters: - name: X-Amz-Target in: header @@ -1448,6 +1485,9 @@ paths: logGroupIdentifiers: $ref: "#/components/schemas/DescribeFieldIndexesLogGroupIdentifiers" description: An array containing the names or ARNs of the log groups that you want to retrieve field indexes for. + indexCategories: + $ref: "#/components/schemas/IndexCategories" + description: "The index categories to return. The following values are supported: DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format. CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group. AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy. INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries. If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories. For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields." nextToken: $ref: "#/components/schemas/NextToken" required: @@ -1991,7 +2031,7 @@ paths: /FilterLogEvents: post: operationId: FilterLogEvents - description: "Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following: A filter pattern A time range The log stream name, or a log stream name prefix that matches multiple log streams You must have the logs:FilterLogEvents permission to perform this operation. You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB. Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished. Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior. The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability. If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query." + description: "Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following: A filter pattern A time range The log stream name, or a log stream name prefix that matches multiple log streams You must have the logs:FilterLogEvents permission to perform this operation. You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB. Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished. Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior. The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. By default, the events are returned in ascending timestamp order (oldest first). To return events in descending timestamp order (newest first), set the startFromHead parameter to false. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability. If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query." parameters: - name: X-Amz-Target in: header @@ -2023,7 +2063,7 @@ paths: description: Filters the results to include only events from log streams that have names starting with this prefix. If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error. startTime: $ref: "#/components/schemas/Timestamp" - description: The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. + description: The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. Set startTime explicitly to reduce the chances of empty pages in the response. endTime: $ref: "#/components/schemas/Timestamp" description: The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned. @@ -2036,6 +2076,9 @@ paths: limit: $ref: "#/components/schemas/EventsLimit" description: The maximum number of events to return. The default is 10,000 events. + startFromHead: + $ref: "#/components/schemas/StartFromHead" + description: If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is true. The startFromHead parameter sets the sort direction on the first request. On subsequent requests, the nextToken determines the sort direction. To continue paginating in the same direction, provide the returned nextToken. If you provide both nextToken and startFromHead, the direction of the nextToken is used. Setting startFromHead to false is supported only when startTime is on or after Jan 1, 2024 00:00:00 UTC. A request with startFromHead set to false and a startTime before this date returns an InvalidParameterException. interleaved: $ref: "#/components/schemas/Interleaved" description: If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group. @@ -2312,7 +2355,7 @@ paths: description: The name of the log stream. startTime: $ref: "#/components/schemas/Timestamp" - description: The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included. + description: The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included. Set startTime explicitly to reduce the chances of empty pages in the response. endTime: $ref: "#/components/schemas/Timestamp" description: The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included. @@ -2519,7 +2562,7 @@ paths: /GetQueryResults: post: operationId: GetQueryResults - description: Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas. If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results. This operation is used both for retrieving results from interactive queries and from automated scheduled query executions. Scheduled queries use GetQueryResults internally to retrieve query results for processing and delivery to configured destinations. You can retrieve up to 100,000 log event results from a query, if available, by using pagination. Use the nextToken returned in the response to request additional pages of results, with each page returning up to 10,000 log events. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability. + description: Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas. If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results. This operation is used both for retrieving results from interactive queries and from automated scheduled query executions. Scheduled queries use GetQueryResults internally to retrieve query results for processing and delivery to configured destinations. You can retrieve up to 100,000 log event results from a query, if available, by using pagination. Use the nextToken returned in the response to request additional pages of results, with each page returning up to 10,000 log events. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability. parameters: - name: X-Amz-Target in: header @@ -2637,6 +2680,33 @@ paths: application/json: schema: $ref: "#/components/schemas/GetScheduledQueryHistoryResponse" + /GetStorageTierPolicy: + post: + operationId: GetStorageTierPolicy + description: Returns the storage tier policy for the account. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Logs_20140328.GetStorageTierPolicy + default: Logs_20140328.GetStorageTierPolicy + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetStorageTierPolicyResponse" /GetTransformer: post: operationId: GetTransformer @@ -2956,6 +3026,9 @@ paths: state: $ref: "#/components/schemas/ScheduledQueryState" description: Filter scheduled queries by state. Valid values are ENABLED and DISABLED. If not specified, all scheduled queries are returned. + scheduleType: + $ref: "#/components/schemas/ScheduleType" + description: Filter scheduled queries by schedule type. Valid values are CUSTOMER_MANAGED and AWS_MANAGED. If not specified, scheduled queries of all schedule types are returned. responses: "200": description: Success @@ -3001,6 +3074,46 @@ paths: application/json: schema: $ref: "#/components/schemas/ListSourcesForS3TableIntegrationResponse" + /ListSyslogConfigurations: + post: + operationId: ListSyslogConfigurations + description: Returns a list of syslog configurations. You can optionally filter the results by log group or VPC endpoint. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Logs_20140328.ListSyslogConfigurations + default: Logs_20140328.ListSyslogConfigurations + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + logGroupIdentifier: + $ref: "#/components/schemas/LogGroupIdentifier" + description: The name or ARN of the log group to filter syslog configurations for. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint to filter syslog configurations for. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of items to return. You received this token from a previous call. + maxResults: + $ref: "#/components/schemas/ListSyslogConfigurationsMaxResults" + description: The maximum number of syslog configurations to return in the response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSyslogConfigurationsResponse" /ListTagsForResource: post: operationId: ListTagsForResource @@ -3070,7 +3183,7 @@ paths: /PutAccountPolicy: post: operationId: PutAccountPolicy - description: "Creates an account-level data protection policy, subscription filter policy, field index policy, transformer policy, or metric extraction policy that applies to all log groups, a subset of log groups, or a data source name and type combination in the account. For field index policies, you can configure indexed fields as facets to enable interactive exploration of your logs. Facets provide value distributions and counts for indexed fields in the CloudWatch Logs Insights console without requiring query execution. For more information, see Use facets to group and explore logs. To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating. To create a data protection policy, you must have the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions. To create a subscription filter policy, you must have the logs:PutSubscriptionFilter and logs:PutAccountPolicy permissions. To create a transformer policy, you must have the logs:PutTransformer and logs:PutAccountPolicy permissions. To create a field index policy, you must have the logs:PutIndexPolicy and logs:PutAccountPolicy permissions. To configure facets for field index policies, you must have the logs:PutIndexPolicy and logs:PutAccountPolicy permissions. To create a metric extraction policy, you must have the logs:PutMetricExtractionPolicy and logs:PutAccountPolicy permissions. Data protection policy A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy. Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked. If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking. To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions. The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked. Subscription filter policy A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. The following destinations are supported for subscription filters: An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery. An Firehose data stream in the same account as the subscription policy, for same-account delivery. A Lambda function in the same account as the subscription policy, for same-account delivery. A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations. Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission. Transformer policy Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters. You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region. A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use. Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies. You can create transformers only for the log groups in the Standard log class. You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the selectionCriteria parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another transformer policy filtered to my-logpprod or my-logging. You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with PutTransformer and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer. Field index policy You can use field index policies to create indexes on fields found in log events for a log group or data source name and type combination. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs To find the fields that are in your log group events, use the GetLogGroupFields operation. To find the fields for a data source use the GetLogFields operation. For example, suppose you have created a field index for requestId. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value or requestId in [value, value, ...] will attempt to process only the log events where the indexed field matches the specified value. Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of RequestId won't match a log event containing requestId. You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups using LogGroupNamePrefix with the selectionCriteria parameter. You can have another 20 account-level field index policies using DataSourceName and DataSourceType for the selectionCriteria parameter. If you have multiple account-level index policies with LogGroupNamePrefix selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another field index policy filtered to my-logpprod or my-logging. Similarly, if you have multiple account-level index policies with DataSourceName and DataSourceType selection criteria, no two of them can use the same data source name and type combination. For example, if you have one policy filtered to the data source name amazon_vpc and data source type flow you cannot create another policy with this combination. If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts. CloudWatch Logs provides default field indexes for all log groups in the Standard log class. Default field indexes are automatically available for the following fields: @logStream @aws.region @aws.account @source.log @data_source_name @data_source_type @data_format traceId severityText attributes.session.id CloudWatch Logs provides default field indexes for certain data source name and type combinations as well. Default field indexes are automatically available for the following data source name and type combinations as identified in the following list: amazon_vpc.flow action logStatus region flowDirection type amazon_route53.resolver_query transport rcode aws_waf.access action httpRequest.country aws_cloudtrail.data, aws_cloudtrail.management eventSource eventName awsRegion userAgent errorCode eventType managementEvent readOnly eventCategory requestId Default field indexes are in addition to any custom field indexes you define within your policy. Default field indexes are not counted towards your field index quota. If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log group will use that log-group level policy and any account-level policies that match at the data source level; any account-level policy that matches at the log group level (for example, no selection criteria or log group name prefix selection criteria) will be ignored. Metric extraction policy A metric extraction policy controls whether CloudWatch Metrics can be created through the Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation is enabled for all log groups. You can use metric extraction policies to disable EMF metric creation for your entire account or specific log groups. When a policy disables EMF metric creation for a log group, log events in the EMF format are still ingested, but no CloudWatch Metrics are created from them. Creating a policy disables metrics for Amazon Web Services features that use EMF to create metrics, such as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off those features by accident, we recommend that you exclude the underlying log-groups through a selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\", \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"]. Each account can have either one account-level metric extraction policy that applies to all log groups, or up to 5 policies that are each scoped to a subset of log groups with the selectionCriteria parameter. The selection criteria supports filtering by LogGroupName and LogGroupNamePrefix using the operators IN and NOT IN. You can specify up to 50 values in each IN or NOT IN list. The selection criteria can be specified in these formats: LogGroupName IN [\"log-group-1\", \"log-group-2\"] LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"] If you have multiple account-level metric extraction policies with selection criteria, no two of them can have overlapping criteria. For example, if you have one policy with selection criteria LogGroupNamePrefix IN [\"my-log\"], you can't have another metric extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"] or LogGroupNamePrefix IN [\"/my-logging\"], as the set of log groups matching these prefixes would be a subset of the log groups matching the first policy's prefix, creating an overlap. When using NOT IN, only one policy with this operator is allowed per account. When combining policies with IN and NOT IN operators, the overlap check ensures that policies don't have conflicting effects. Two policies with IN and NOT IN operators do not overlap if and only if every value in the IN policy is completely contained within some value in the NOT IN policy. For example: If you have a NOT IN policy for prefix \"/aws/lambda\", you can create an IN policy for the exact log group name \"/aws/lambda/function1\" because the set of log groups matching \"/aws/lambda/function1\" is a subset of the log groups matching \"/aws/lambda\". If you have a NOT IN policy for prefix \"/aws/lambda\", you cannot create an IN policy for prefix \"/aws\" because the set of log groups matching \"/aws\" is not a subset of the log groups matching \"/aws/lambda\"." + description: "Creates an account-level data protection policy, subscription filter policy, field index policy, transformer policy, or metric extraction policy that applies to all log groups, a subset of log groups, or a data source name and type combination in the account. PutAccountPolicy is an account-wide administrative operation intended for CloudWatch Logs administrators. Because it affects all log groups (or a broad subset) in the account, you should grant logs:PutAccountPolicy permissions only to administrators who manage logging configuration across the account, not to application teams or individual log group owners. Conflict resolution between account-level and log-group-level policies When both an account-level policy and a log-group-level policy of the same type apply to a log group, the resolution depends on the policy type: Data protection — The two policies are cumulative. Any sensitive term specified in either the account-level or the log-group-level policy is masked. Subscription filters — Account-level and log-group-level subscription filters are additive. A log group can have up to 1 account-level and up to 2 log-group-level subscription filters. Transformers — A log-group-level transformer overrides the account-level transformer. If a log group has its own transformer, it ignores the account-level transformer policy. Field index policies — If a log group has its own field index policy (created with PutIndexPolicy), any account-level policy that uses LogGroupNamePrefix selection criteria or has no selection criteria is ignored for that log group. However, account-level policies that use DataSourceName and DataSourceType selection criteria still apply alongside the log-group-level policy. Metric extraction policies — Metric extraction policies are account-level only and have no log-group-level equivalent, so no conflict resolution applies. For field index policies, you can configure indexed fields as facets to enable interactive exploration of your logs. Facets provide value distributions and counts for indexed fields in the CloudWatch Logs Insights console without requiring query execution. For more information, see Use facets to group and explore logs. To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating. To create a data protection policy, you must have the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions. To create a subscription filter policy, you must have the logs:PutSubscriptionFilter and logs:PutAccountPolicy permissions. To create a transformer policy, you must have the logs:PutTransformer and logs:PutAccountPolicy permissions. To create a field index policy, you must have the logs:PutIndexPolicy and logs:PutAccountPolicy permissions. To configure facets for field index policies, you must have the logs:PutIndexPolicy and logs:PutAccountPolicy permissions. To create a metric extraction policy, you must have the logs:PutMetricExtractionPolicy and logs:PutAccountPolicy permissions. Data protection policy A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy. Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked. If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking. To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions. The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked. Subscription filter policy A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. The following destinations are supported for subscription filters: An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery. An Firehose data stream in the same account as the subscription policy, for same-account delivery. A Lambda function in the same account as the subscription policy, for same-account delivery. A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations. Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission. Transformer policy Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters. You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region. A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use. Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies. You can create transformers only for the log groups in the Standard log class. You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the selectionCriteria parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another transformer policy filtered to my-logpprod or my-logging. You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with PutTransformer and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer. Field index policy You can use field index policies to create indexes on fields found in log events for a log group or data source name and type combination. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs To find the fields that are in your log group events, use the GetLogGroupFields operation. To find the fields for a data source use the GetLogFields operation. For example, suppose you have created a field index for requestId. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value or requestId in [value, value, ...] will attempt to process only the log events where the indexed field matches the specified value. Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of RequestId won't match a log event containing requestId. You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups using LogGroupNamePrefix with the selectionCriteria parameter. You can have another 20 account-level field index policies using DataSourceName and DataSourceType for the selectionCriteria parameter. If you have multiple account-level index policies with LogGroupNamePrefix selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log, you can't have another field index policy filtered to my-logpprod or my-logging. Similarly, if you have multiple account-level index policies with DataSourceName and DataSourceType selection criteria, no two of them can use the same data source name and type combination. For example, if you have one policy filtered to the data source name amazon_vpc and data source type flow you cannot create another policy with this combination. If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts. CloudWatch Logs provides default field indexes for all log groups in the Standard log class. Default field indexes are automatically available for the following fields: @logStream @aws.region @aws.account @source.log @data_source_name @data_source_type @data_format traceId severityText attributes.session.id CloudWatch Logs provides default field indexes for certain data source name and type combinations as well. Default field indexes are automatically available for the following data source name and type combinations as identified in the following list: amazon_vpc.flow action logStatus region flowDirection type amazon_route53.resolver_query transport rcode aws_waf.access action httpRequest.country aws_cloudtrail.data, aws_cloudtrail.management eventSource eventName awsRegion userAgent errorCode eventType managementEvent readOnly eventCategory requestId Default field indexes are in addition to any custom field indexes you define within your policy. Default field indexes are not counted towards your field index quota. If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log group will use that log-group level policy and any account-level policies that match at the data source level; any account-level policy that matches at the log group level (for example, no selection criteria or log group name prefix selection criteria) will be ignored. Metric extraction policy A metric extraction policy controls whether CloudWatch Metrics can be created through the Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation is enabled for all log groups. You can use metric extraction policies to disable EMF metric creation for your entire account or specific log groups. When a policy disables EMF metric creation for a log group, log events in the EMF format are still ingested, but no CloudWatch Metrics are created from them. Creating a policy disables metrics for Amazon Web Services features that use EMF to create metrics, such as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off those features by accident, we recommend that you exclude the underlying log-groups through a selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\", \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"]. Each account can have either one account-level metric extraction policy that applies to all log groups, or up to 5 policies that are each scoped to a subset of log groups with the selectionCriteria parameter. The selection criteria supports filtering by LogGroupName and LogGroupNamePrefix using the operators IN and NOT IN. You can specify up to 50 values in each IN or NOT IN list. The selection criteria can be specified in these formats: LogGroupName IN [\"log-group-1\", \"log-group-2\"] LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"] If you have multiple account-level metric extraction policies with selection criteria, no two of them can have overlapping criteria. For example, if you have one policy with selection criteria LogGroupNamePrefix IN [\"my-log\"], you can't have another metric extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"] or LogGroupNamePrefix IN [\"/my-logging\"], as the set of log groups matching these prefixes would be a subset of the log groups matching the first policy's prefix, creating an overlap. When using NOT IN, only one policy with this operator is allowed per account. When combining policies with IN and NOT IN operators, the overlap check ensures that policies don't have conflicting effects. Two policies with IN and NOT IN operators do not overlap if and only if every value in the IN policy is completely contained within some value in the NOT IN policy. For example: If you have a NOT IN policy for prefix \"/aws/lambda\", you can create an IN policy for the exact log group name \"/aws/lambda/function1\" because the set of log groups matching \"/aws/lambda/function1\" is a subset of the log groups matching \"/aws/lambda\". If you have a NOT IN policy for prefix \"/aws/lambda\", you cannot create an IN policy for prefix \"/aws\" because the set of log groups matching \"/aws\" is not a subset of the log groups matching \"/aws/lambda\"." parameters: - name: X-Amz-Target in: header @@ -3295,7 +3408,7 @@ paths: description: The ARN of the Amazon Web Services resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234 For the SECURITY_FINDING_LOGS logType, use a wildcard ARN for the hub resource. For Amazon Web Services Security Hub CSPM, use arn:aws:securityhub:us-east-1:111122223333:hub/* and for Amazon Web Services Security Hub, use arn:aws:securityhub:us-east-1:111122223333:hubv2/* logType: $ref: "#/components/schemas/LogType" - description: Defines the type of log that the source is sending. For Amazon Bedrock Agents, the valid values are APPLICATION_LOGS and EVENT_LOGS. For Amazon Bedrock Knowledge Bases, the valid value is APPLICATION_LOGS. For Amazon Bedrock AgentCore Runtime, the valid values are APPLICATION_LOGS, USAGE_LOGS and TRACES. For Amazon Bedrock AgentCore Tools, the valid values are APPLICATION_LOGS, USAGE_LOGS and TRACES. For Amazon Bedrock AgentCore Identity, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Memory, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Gateway, the valid values are APPLICATION_LOGS and TRACES. For CloudFront, the valid value is ACCESS_LOGS. For DevOps Agent, the valid value is APPLICATION_LOGS. For Amazon CodeWhisperer, the valid value is EVENT_LOGS. For Elemental MediaPackage, the valid values are EGRESS_ACCESS_LOGS and INGRESS_ACCESS_LOGS. For Elemental MediaTailor, the valid values are AD_DECISION_SERVER_LOGS, MANIFEST_SERVICE_LOGS, and TRANSCODE_LOGS. For Amazon EKS Auto Mode, the valid values are AUTO_MODE_BLOCK_STORAGE_LOGS, AUTO_MODE_COMPUTE_LOGS, AUTO_MODE_IPAM_LOGS, and AUTO_MODE_LOAD_BALANCING_LOGS. For Entity Resolution, the valid value is WORKFLOW_LOGS. For IAM Identity Center, the valid value is ERROR_LOGS. For Network Firewall Proxy, the valid values are ALERT_LOGS, ALLOW_LOGS, and DENY_LOGS. For Network Load Balancer, the valid value is NLB_ACCESS_LOGS. For PCS, the valid values are PCS_SCHEDULER_LOGS, PCS_JOBCOMP_LOGS, and PCS_SCHEDULER_AUDIT_LOGS. For Quick, the valid values are CHAT_LOGS and FEEDBACK_LOGS. For Amazon Web Services RTB Fabric, the valid values is APPLICATION_LOGS. For Amazon Q, the valid values are EVENT_LOGS and SYNC_JOB_LOGS. For Amazon Web Services Security Hub CSPM, the valid value is SECURITY_FINDING_LOGS. For Amazon Web Services Security Hub, the valid value is SECURITY_FINDING_LOGS. For Amazon SES mail manager, the valid values are APPLICATION_LOGS and TRAFFIC_POLICY_DEBUG_LOGS. For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, WORKMAIL_MAILBOX_ACCESS_LOGS, and WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS. For Amazon VPC Route Server, the valid value is EVENT_LOGS. + description: Defines the type of log that the source is sending. For Application Load Balancer, the valid values are ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS, and ALB_HEALTH_CHECK_LOGS. For Amazon Bedrock Agents, the valid values are APPLICATION_LOGS and EVENT_LOGS. For Amazon Bedrock Knowledge Bases, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Runtime, the valid values are APPLICATION_LOGS, USAGE_LOGS and TRACES. For Amazon Bedrock AgentCore Tools, the valid values are APPLICATION_LOGS, USAGE_LOGS and TRACES. For Amazon Bedrock AgentCore Identity, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Memory, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Gateway, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Payments, the valid values are APPLICATION_LOGS and TRACES. For CloudFront, the valid value is ACCESS_LOGS. For DevOps Agent, the valid value is APPLICATION_LOGS. For Amazon CodeWhisperer, the valid value is EVENT_LOGS. For Elemental MediaPackage, the valid values are EGRESS_ACCESS_LOGS and INGRESS_ACCESS_LOGS. For Elemental MediaTailor, the valid values are AD_DECISION_SERVER_LOGS, MANIFEST_SERVICE_LOGS, and TRANSCODE_LOGS. For Amazon EKS Auto Mode, the valid values are AUTO_MODE_BLOCK_STORAGE_LOGS, AUTO_MODE_COMPUTE_LOGS, AUTO_MODE_IPAM_LOGS, and AUTO_MODE_LOAD_BALANCING_LOGS. For Amazon EKS Capability Logs, the valid values are EKS_CAPABILITY_ACK_LOGS, EKS_CAPABILITY_ARGOCD_APPLICATION_LOGS, EKS_CAPABILITY_ARGOCD_APPLICATIONSET_LOGS, EKS_CAPABILITY_ARGOCD_COMMITSERVER_LOGS, EKS_CAPABILITY_ARGOCD_REPOSERVER_LOGS, EKS_CAPABILITY_ARGOCD_SERVER_LOGS, and EKS_CAPABILITY_KRO_LOGS. For Entity Resolution, the valid value is WORKFLOW_LOGS. For IAM Identity Center, the valid value is ERROR_LOGS. For Network Firewall Proxy, the valid values are ALERT_LOGS, ALLOW_LOGS, and DENY_LOGS. For Network Load Balancer, the valid value is NLB_ACCESS_LOGS. For PCS, the valid values are PCS_SCHEDULER_LOGS, PCS_JOBCOMP_LOGS, and PCS_SCHEDULER_AUDIT_LOGS. For Quick, the valid values are AGENT_HOURS_LOGS, CHAT_LOGS, FEEDBACK_LOGS, and INDEX_USAGE_LOGS. For Amazon Web Services RTB Fabric, the valid values is APPLICATION_LOGS. For Amazon Q, the valid values are EVENT_LOGS and SYNC_JOB_LOGS. For Amazon S3, the valid value is S3_SERVER_ACCESS_LOGS. For Amazon Web Services Security Hub CSPM, the valid value is SECURITY_FINDING_LOGS. For Amazon Web Services Security Hub, the valid value is SECURITY_FINDING_LOGS. For Amazon SES mail manager, the valid values are APPLICATION_LOGS and TRAFFIC_POLICY_DEBUG_LOGS. For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, WORKMAIL_MAILBOX_ACCESS_LOGS, and WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS. For Amazon VPC Route Server, the valid value is EVENT_LOGS. tags: $ref: "#/components/schemas/Tags" description: An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources @@ -3725,6 +3838,39 @@ paths: responses: "200": description: Success + /PutStorageTierPolicy: + post: + operationId: PutStorageTierPolicy + description: Sets the storage tier policy for the account. When you set the storage tier to INTELLIGENT_TIERING, the service automatically moves log data to the most cost-effective storage tier based on access frequency. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Logs_20140328.PutStorageTierPolicy + default: Logs_20140328.PutStorageTierPolicy + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + storageTier: + $ref: "#/components/schemas/StorageTier" + description: The storage tier to set for the account. Use INTELLIGENT_TIERING to automatically optimize storage costs by moving log data to the appropriate tier based on access frequency. + required: + - storageTier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutStorageTierPolicyResponse" /PutSubscriptionFilter: post: operationId: PutSubscriptionFilter @@ -3772,7 +3918,7 @@ paths: description: 'A filter expression that specifies which log events should be processed by this subscription filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region NOT IN ["cn-north-1"] or @aws.account = "123456789012" AND @aws.region = "us-east-1". Maximum length: 2000 characters.' emitSystemFields: $ref: "#/components/schemas/EmitSystemFields" - description: A list of system fields to include in the log events sent to the subscription destination. Valid values are @aws.account and @aws.region. These fields provide source information for centralized log data in the forwarded payload. + description: A list of system fields to include in the log events sent to the subscription destination. Valid values are @aws.account, @aws.region, and @source.log. These fields provide source information for centralized log data in the forwarded payload. required: - logGroupName - filterName @@ -3781,6 +3927,38 @@ paths: responses: "200": description: Success + /PutSyslogConfiguration: + post: + operationId: PutSyslogConfiguration + description: Creates or updates a syslog configuration for a log group. This enables ingestion of syslog data through the specified VPC endpoint into the log group. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Logs_20140328.PutSyslogConfiguration + default: Logs_20140328.PutSyslogConfiguration + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + logGroupIdentifier: + $ref: "#/components/schemas/LogGroupIdentifier" + description: The name or ARN of the log group to associate with the syslog configuration. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint to use for syslog ingestion. + required: + - logGroupIdentifier + responses: + "200": + description: Success /PutTransformer: post: operationId: PutTransformer @@ -3900,7 +4078,7 @@ paths: description: The query string to use. For more information, see CloudWatch Logs Insights Query Syntax. limit: $ref: "#/components/schemas/EventsLimitStartQuery" - description: The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 10,000. The maximum value is 100,000. + description: The maximum number of log events to return from the query. The maximum limit is 100,000. The maximum events returned in a single GetQueryResults API call is 10,000 log events per request. You can retrieve up to 100,000 log event results from a query by paginating with the nextToken. 100,000 limit is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages. required: - startTime - endTime @@ -4280,7 +4458,7 @@ paths: /UpdateLookupTable: post: operationId: UpdateLookupTable - description: Updates an existing lookup table by replacing all of its CSV content. After the update completes, queries that use this table will use the new data. This is a full replacement operation. All existing content is replaced with the new CSV data. + description: Updates an existing lookup table by replacing all of its content with new CSV data or CloudWatch Logs query results. After the update completes, queries that use this table use the new data. This is a full replacement operation. All existing content is replaced. You must specify either tableBody or queryId, but not both. parameters: - name: X-Amz-Target in: header @@ -4306,13 +4484,15 @@ paths: description: An updated description of the lookup table. tableBody: $ref: "#/components/schemas/TableBody" - description: The new CSV content to replace the existing data. The first row must be a header row with column names. The content must use UTF-8 encoding and not exceed 10 MB. + description: The new CSV content to replace the existing data. The first row must be a header row with column names. The content must use UTF-8 encoding and not exceed 10 MB. You must specify either tableBody or queryId, but not both. + queryId: + $ref: "#/components/schemas/QueryId" + description: The ID of a completed or cancelled CloudWatch Logs query whose results replace the lookup table content. A cancelled query replaces the content with the partial results that were available when the query was stopped. You must specify either tableBody or queryId, but not both. kmsKeyId: $ref: "#/components/schemas/KmsKeyId" description: The ARN of the KMS key to use to encrypt the lookup table data. You can use this parameter to add, update, or remove the KMS key. To remove the KMS key and use an Amazon Web Services-owned key instead, specify an empty string. required: - lookupTableArn - - tableBody responses: "200": description: Success @@ -4365,6 +4545,9 @@ paths: startTimeOffset: $ref: "#/components/schemas/StartTimeOffset" description: The updated time offset in seconds that defines the lookback period for the query. + endTimeOffset: + $ref: "#/components/schemas/EndTimeOffset" + description: The updated time offset in seconds that defines the end of the lookback period for the query. destinationConfiguration: $ref: "#/components/schemas/DestinationConfiguration" description: The updated configuration for where to deliver query results. @@ -4726,6 +4909,10 @@ components: type: string minLength: 1 maxLength: 10485760 + QueryId: + type: string + minLength: 1 + maxLength: 256 CreateLookupTableResponse: type: object properties: @@ -4738,8 +4925,7 @@ components: ScheduledQueryName: type: string minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9_\-/.#]+$ + maxLength: 300 ScheduledQueryDescription: type: string maxLength: 1024 @@ -4771,6 +4957,9 @@ components: StartTimeOffset: type: integer format: int64 + EndTimeOffset: + type: integer + format: int64 DestinationConfiguration: description: Configuration for where to deliver scheduled query results. Specifies the destination type and associated settings for result delivery. type: object @@ -4778,8 +4967,9 @@ components: s3Configuration: $ref: "#/components/schemas/S3Configuration" description: Configuration for delivering query results to Amazon S3. - required: - - s3Configuration + lookupTableConfiguration: + $ref: "#/components/schemas/LookupTableConfiguration" + description: Configuration for delivering query results to a lookup table. The query results automatically populate or refresh the specified lookup table on each scheduled execution. S3Configuration: description: Configuration for Amazon S3 destination where scheduled query results are delivered. type: object @@ -4808,6 +4998,29 @@ components: minLength: 12 maxLength: 12 pattern: ^\d{12}$ + LookupTableConfiguration: + description: Configuration for a lookup table destination. Use it to automatically refresh a lookup table with query results on a schedule. + type: object + properties: + tableName: + $ref: "#/components/schemas/LookupTableName" + description: The name of the lookup table to create or update with query results. The name can contain only alphanumeric characters and underscores. + roleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role that grants permissions to create or update the lookup table with query results. + description: + $ref: "#/components/schemas/LookupTableDescription" + description: A description of the lookup table. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The ARN of the KMS key to use to encrypt the lookup table data. If you don't specify a key, the data is encrypted with an Amazon Web Services-owned key. + tags: + type: object + properties: {} + description: Key-value pairs to associate with the lookup table for resource management and cost allocation. The service applies tags only during initial table creation. + required: + - tableName + - roleArn ScheduledQueryState: type: string enum: @@ -4858,10 +5071,6 @@ components: minLength: 1 maxLength: 512 pattern: "[^:*]*" - QueryId: - type: string - minLength: 1 - maxLength: 256 DeleteQueryDefinitionResponse: type: object properties: @@ -4875,9 +5084,13 @@ components: minLength: 1 ScheduledQueryIdentifier: type: string - pattern: "[\\w#+=/:,.@-]*" + minLength: 1 + maxLength: 300 DeleteScheduledQueryResponse: type: object + VpcEndpointId: + type: string + pattern: ^vpce-[0-9a-f]{1,64}$ AccountIds: type: array items: @@ -5360,6 +5573,17 @@ components: type: array items: $ref: "#/components/schemas/LogGroupIdentifier" + IndexCategories: + type: array + items: + $ref: "#/components/schemas/IndexCategory" + IndexCategory: + type: string + enum: + - DEFAULT + - CUSTOM + - AUTO + - INACTIVE DescribeFieldIndexesResponse: type: object properties: @@ -5394,6 +5618,9 @@ components: type_: $ref: "#/components/schemas/IndexType" description: The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried. + indexCategory: + $ref: "#/components/schemas/IndexCategory" + description: "The category of the field index: DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format. CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group. AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy. INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries. For more information about automatically indexed fields, see Automatically indexed fields." FieldIndexName: type: string minLength: 1 @@ -6111,6 +6338,8 @@ components: type: integer minimum: 1 maximum: 10000 + StartFromHead: + type: boolean Interleaved: type: boolean Unmask: @@ -6126,7 +6355,7 @@ components: description: Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list. Indicates which log streams have been searched and whether each has been searched completely. nextToken: $ref: "#/components/schemas/NextToken" - description: The token to use when requesting the next set of items. The token expires after 24 hours. If the results don't include a nextToken, then pagination is finished. + description: The token for the next set of items in the sorting direction specified by the startFromHead parameter in the first request. The token expires after 24 hours. If the results don't include a nextToken, then pagination is finished. FilteredLogEvents: type: array items: @@ -6460,8 +6689,6 @@ components: type: integer format: int64 minimum: 0 - StartFromHead: - type: boolean GetLogEventsResponse: type: object properties: @@ -6654,7 +6881,7 @@ components: description: If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them. nextToken: $ref: "#/components/schemas/GetQueryResultsNextToken" - description: If there are more log events remaining in the results, the response includes a nextToken. You can use this token in a subsequent GetQueryResults request to get the next set of results. You can retrieve up to 100,000 log event results from a query by paginating with this token. + description: If there are more log events remaining in the results, the response includes a nextToken. You can use this token in a subsequent GetQueryResults request to get the next set of results. You can retrieve up to 100,000 log event results from a query by paginating with this token. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages. QueryResults: type: array items: @@ -6733,12 +6960,18 @@ components: startTimeOffset: $ref: "#/components/schemas/StartTimeOffset" description: The time offset in seconds that defines the lookback period for the query. + endTimeOffset: + $ref: "#/components/schemas/EndTimeOffset" + description: The time offset in seconds that defines the end of the lookback period for the query. destinationConfiguration: $ref: "#/components/schemas/DestinationConfiguration" description: Configuration for where query results are delivered. state: $ref: "#/components/schemas/ScheduledQueryState" description: The current state of the scheduled query. + scheduleType: + $ref: "#/components/schemas/ScheduleType" + description: The schedule type of the scheduled query. Valid values are CUSTOMER_MANAGED and AWS_MANAGED. lastTriggeredTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the scheduled query was last executed. @@ -6760,6 +6993,11 @@ components: lastUpdatedTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the scheduled query was last updated. + ScheduleType: + type: string + enum: + - CUSTOMER_MANAGED + - AWS_MANAGED ExecutionStatus: type: string enum: @@ -6840,6 +7078,7 @@ components: type: string enum: - S3 + - LOOKUP_TABLE ActionStatus: type: string enum: @@ -6847,6 +7086,20 @@ components: - CLIENT_ERROR - FAILED - COMPLETE + GetStorageTierPolicyResponse: + type: object + properties: + storageTier: + $ref: "#/components/schemas/StorageTier" + description: The current storage tier for the account. + lastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time when the storage tier policy was last updated, expressed as the number of milliseconds after January 1, 1970 00:00:00 UTC. + StorageTier: + type: string + enum: + - STANDARD + - INTELLIGENT_TIERING GetTransformerResponse: type: object properties: @@ -7923,6 +8176,9 @@ components: state: $ref: "#/components/schemas/ScheduledQueryState" description: The current state of the scheduled query. + scheduleType: + $ref: "#/components/schemas/ScheduleType" + description: The schedule type of the scheduled query. Valid values are CUSTOMER_MANAGED and AWS_MANAGED. lastTriggeredTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the scheduled query was last executed. @@ -7992,6 +8248,43 @@ components: S3TableIntegrationSourceStatusReason: type: string minLength: 1 + ListSyslogConfigurationsMaxResults: + type: integer + minimum: 0 + maximum: 50 + ListSyslogConfigurationsResponse: + type: object + properties: + syslogConfigurations: + $ref: "#/components/schemas/SyslogConfigurations" + description: The list of syslog configurations. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of items to return. The token expires after 24 hours. + SyslogConfigurations: + type: array + items: + $ref: "#/components/schemas/SyslogConfiguration" + SyslogConfiguration: + description: Contains information about a syslog configuration associated with a log group. + type: object + properties: + logGroupArn: + $ref: "#/components/schemas/LogGroupArn" + description: The ARN of the log group associated with this syslog configuration. + sourceType: + $ref: "#/components/schemas/SyslogSourceType" + description: The source type for the syslog configuration. + vpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the VPC endpoint used for syslog ingestion. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The time when the syslog configuration was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + SyslogSourceType: + type: string + enum: + - VPCE AmazonResourceName: type: string minLength: 1 @@ -8206,6 +8499,15 @@ components: revisionId: $ref: "#/components/schemas/ExpectedRevisionId" description: The revision ID of the created or updated resource policy. Only returned for resource-scoped policies. + PutStorageTierPolicyResponse: + type: object + properties: + storageTier: + $ref: "#/components/schemas/StorageTier" + description: The storage tier for the account. + lastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time when the storage tier policy was last updated, expressed as the number of milliseconds after January 1, 1970 00:00:00 UTC. StartLiveTailLogGroupIdentifiers: type: array items: @@ -8472,12 +8774,18 @@ components: startTimeOffset: $ref: "#/components/schemas/StartTimeOffset" description: The time offset of the updated scheduled query. + endTimeOffset: + $ref: "#/components/schemas/EndTimeOffset" + description: The end time offset in seconds of the updated scheduled query. destinationConfiguration: $ref: "#/components/schemas/DestinationConfiguration" description: The destination configuration of the updated scheduled query. state: $ref: "#/components/schemas/ScheduledQueryState" description: The state of the updated scheduled query. + scheduleType: + $ref: "#/components/schemas/ScheduleType" + description: The schedule type of the updated scheduled query. lastTriggeredTime: $ref: "#/components/schemas/Timestamp" description: The timestamp when the updated scheduled query was last executed. @@ -9901,6 +10209,57 @@ components: - $ref: "#/components/x-stackQL-resources/subscription_filters/methods/put_subscription_filter" delete: - $ref: "#/components/x-stackQL-resources/subscription_filters/methods/delete_subscription_filter" + syslog_configurations: + id: aws.logs.syslog_configurations + name: syslog_configurations + title: syslog_configurations + methods: + delete_syslog_configuration: + operation: + $ref: "#/paths/~1DeleteSyslogConfiguration/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_syslog_configurations: + operation: + $ref: "#/paths/~1ListSyslogConfigurations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + put_syslog_configuration: + operation: + $ref: "#/paths/~1PutSyslogConfiguration/post" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/syslog_configurations/methods/list_syslog_configurations" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/syslog_configurations/methods/put_syslog_configuration" + delete: + - $ref: "#/components/x-stackQL-resources/syslog_configurations/methods/delete_syslog_configuration" transformers: id: aws.logs.transformers name: transformers @@ -10276,6 +10635,45 @@ components: insert: [] update: [] delete: [] + storage_tier_policies: + id: aws.logs.storage_tier_policies + name: storage_tier_policies + title: storage_tier_policies + methods: + get_storage_tier_policy: + operation: + $ref: "#/paths/~1GetStorageTierPolicy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + put_storage_tier_policy: + operation: + $ref: "#/paths/~1PutStorageTierPolicy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/storage_tier_policies/methods/get_storage_tier_policy" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/storage_tier_policies/methods/put_storage_tier_policy" + delete: [] aggregate_log_group_summaries: id: aws.logs.aggregate_log_group_summaries name: aggregate_log_group_summaries diff --git a/providers/src/aws/v00.00.00000/services/marketplace_agreement.yaml b/providers/src/aws/v00.00.00000/services/marketplace_agreement.yaml index cce46a22..352ed908 100644 --- a/providers/src/aws/v00.00.00000/services/marketplace_agreement.yaml +++ b/providers/src/aws/v00.00.00000/services/marketplace_agreement.yaml @@ -2025,6 +2025,9 @@ components: variablePaymentTerm: $ref: "#/components/schemas/VariablePaymentTerm" description: Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines. + netPaymentTerm: + $ref: "#/components/schemas/NetPaymentTerm" + description: Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued. LegalTerm: description: Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA). type: object @@ -2335,6 +2338,19 @@ components: configuration: $ref: "#/components/schemas/VariablePaymentTermConfiguration" description: Additional parameters specified by the acceptor while accepting the term. + NetPaymentTerm: + description: Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued. + type: object + properties: + type_: + $ref: "#/components/schemas/UnversionedTermType" + description: Type of the term being updated. + id: + $ref: "#/components/schemas/TermId" + description: The unique identifier for the term. + paymentDuePeriod: + $ref: "#/components/schemas/BoundedString" + description: The duration after an invoice is issued within which the payment is due. The duration is represented in the ISO 8601 format (for example, P30D for 30 days or P60D for 60 days). GetBillingAdjustmentRequestOutput: type: object properties: @@ -2830,6 +2846,20 @@ components: status: $ref: "#/components/schemas/AgreementStatus" description: The current status of the agreement. + entitlements: + $ref: "#/components/schemas/EntitlementList" + description: A list of entitlements associated with the agreement. + EntitlementList: + type: array + items: + $ref: "#/components/schemas/Entitlement" + Entitlement: + description: Represents an entitlement associated with an agreement. + type: object + properties: + licenseArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement. SendAgreementCancellationRequestOutput: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/marketplace_catalog.yaml b/providers/src/aws/v00.00.00000/services/marketplace_catalog.yaml index 04661bee..acc5359a 100644 --- a/providers/src/aws/v00.00.00000/services/marketplace_catalog.yaml +++ b/providers/src/aws/v00.00.00000/services/marketplace_catalog.yaml @@ -82,6 +82,36 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteResourcePolicyResponse" + /DescribeAssessment: + post: + operationId: DescribeAssessment + description: Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results. To list available assessments before describing one, use the ListAssessments action. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + AssessmentIdentifier: + $ref: "#/components/schemas/AssessmentIdentifier" + MaxResults: + $ref: "#/components/schemas/DescribeAssessmentMaxResultInteger" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - Catalog + - AssessmentIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAssessmentResponse" /DescribeChangeSet: get: operationId: DescribeChangeSet @@ -148,6 +178,39 @@ paths: application/json: schema: $ref: "#/components/schemas/GetResourcePolicyResponse" + /ListAssessments: + post: + operationId: ListAssessments + description: Returns a paginated list of assessments associated with an entity or change set in AWS Marketplace. An assessment is the result of evaluating a product or change set against a framework, such as AMI Security or Container Security. Use the AssessmentTargetFilter to scope results to a specific entity or change set, and use FrameworkFilters to scope results to a single framework. To retrieve detailed control-level results for an individual assessment, use the DescribeAssessment action. Results are sorted by assessment creation time in descending order. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + FrameworkId: + $ref: "#/components/schemas/FrameworkId" + AssessmentTargetFilter: + $ref: "#/components/schemas/AssessmentTargetFilter" + FrameworkFilters: + $ref: "#/components/schemas/FrameworkFilters" + MaxResults: + $ref: "#/components/schemas/ListAssessmentsMaxResultInteger" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - Catalog + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssessmentsResponse" /ListChangeSets: post: operationId: ListChangeSets @@ -457,6 +520,174 @@ components: pattern: ^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$ DeleteResourcePolicyResponse: type: object + AssessmentIdentifier: + type: string + minLength: 1 + maxLength: 2048 + pattern: ^(assessment-[a-zA-Z0-9]+|arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[0-9]*:[a-zA-Z0-9-]+/Assessment/assessment-[a-zA-Z0-9]+)$ + DescribeAssessmentMaxResultInteger: + type: integer + minimum: 1 + maximum: 100 + NextToken: + type: string + minLength: 1 + maxLength: 4096 + pattern: ^[\w+=.:@\-\/]+$ + DescribeAssessmentResponse: + type: object + properties: + AssessmentArn: + $ref: "#/components/schemas/ARN" + description: The ARN associated with the assessment. + AssessmentId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the assessment. + FrameworkId: + $ref: "#/components/schemas/VersionedFrameworkId" + description: The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0). + AssessmentTargetSummary: + $ref: "#/components/schemas/AssessmentTargetSummary" + description: Identifies the entity or change set that was assessed. + FrameworkSummary: + $ref: "#/components/schemas/FrameworkSummary" + description: The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId. + AssessmentResult: + $ref: "#/components/schemas/AssessmentResult" + description: The overall result of the assessment. + CreatedAt: + $ref: "#/components/schemas/DateTimeISO8601" + description: The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z). + ExpiresAt: + $ref: "#/components/schemas/DateTimeISO8601" + description: The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z). + ControlAssessments: + $ref: "#/components/schemas/ControlAssessmentList" + description: An array of ControlAssessment objects, each containing the result of an individual control evaluated as part of the assessment. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The value of the next token, if it exists. null if there are no more results. + VersionedFrameworkId: + type: string + minLength: 1 + maxLength: 255 + pattern: ^[\w\-@.]+$ + AssessmentTargetSummary: + description: Identifies the entity or change set that was assessed. + type: object + properties: + EntityId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the entity that was assessed. + ChangeSetId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the change set that was assessed. + FrameworkSummary: + description: The framework-specific details of the assessed resource. Exactly one member is set, corresponding to the framework that was assessed. + type: object + properties: + AMISecuritySummary: + $ref: "#/components/schemas/AMISecuritySummary" + description: The details of the resource assessed under the AMI Security framework. + ContainerSecuritySummary: + $ref: "#/components/schemas/ContainerSecuritySummary" + description: The details of the resource assessed under the Container Security framework. + AMISecuritySummary: + description: The details of the resource assessed under the AMI Security framework. + type: object + properties: + DeliveryOptionId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the delivery option that was evaluated. + ContainerSecuritySummary: + description: The details of the resource assessed under the Container Security framework. + type: object + properties: + DeliveryOptionId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the delivery option that was evaluated. + AssessmentResult: + type: string + enum: + - PASS + - FAIL + DateTimeISO8601: + type: string + minLength: 20 + maxLength: 20 + pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$ + ControlAssessmentList: + type: array + items: + $ref: "#/components/schemas/ControlAssessment" + ControlAssessment: + description: The result of evaluating a single control as part of an assessment. + type: object + properties: + ControlId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the control that was evaluated. + ControlAssessmentResult: + $ref: "#/components/schemas/ControlAssessmentResult" + description: The result of the control evaluation. + Errors: + $ref: "#/components/schemas/ControlErrorList" + description: An array of ControlError objects associated with the control evaluation. + ControlAssessmentResult: + type: string + enum: + - PASS + - FAIL + - NOT_EXECUTED + - EXEMPTION_PASS + ControlErrorList: + type: array + items: + $ref: "#/components/schemas/ControlError" + ControlError: + description: An error reported during the evaluation of a single control. + type: object + properties: + Code: + $ref: "#/components/schemas/ErrorCode" + description: The error code that identifies the type of error. + Message: + $ref: "#/components/schemas/ErrorMessage" + description: The message for the error. + Scope: + $ref: "#/components/schemas/ErrorScopeList" + description: The list of name-value pairs that identify the resource or attribute that the error applies to. + ErrorCode: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[A-Z_]+$ + ErrorMessage: + type: string + minLength: 1 + maxLength: 2048 + ErrorScopeList: + type: array + items: + $ref: "#/components/schemas/ErrorScope" + ErrorScope: + description: A name-value pair that identifies the resource or attribute that a ControlError applies to. + type: object + properties: + Name: + $ref: "#/components/schemas/ScopeName" + description: The name of the resource field the error applies to (for example, AMI_ID, FILE_PATH, or PACKAGE_NAME). + Value: + $ref: "#/components/schemas/ScopeValue" + description: The value of the resource field the error applies to. + ScopeName: + type: string + minLength: 1 + maxLength: 50 + ScopeValue: + type: string + minLength: 1 + maxLength: 1024 DescribeChangeSetResponse: type: object properties: @@ -500,11 +731,6 @@ components: enum: - VALIDATE - APPLY - DateTimeISO8601: - type: string - minLength: 20 - maxLength: 20 - pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$ ChangeStatus: type: string enum: @@ -639,6 +865,90 @@ components: minLength: 1 maxLength: 10240 pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]+$ + FrameworkId: + type: string + minLength: 1 + maxLength: 255 + pattern: ^[\w\-@]+$ + AssessmentTargetFilter: + description: Filters assessment list results by the resource that was assessed. Provide an entity identifier, a change set identifier, or both. + type: object + properties: + EntityId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the entity whose assessments you want to list. + ChangeSetId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the change set that triggered the assessments you want to list. + FrameworkFilters: + description: Framework-specific filters used to scope ListAssessments results. Set exactly one member, corresponding to the framework you want to filter by. + type: object + properties: + AMISecurityFilters: + $ref: "#/components/schemas/AMISecurityFilters" + description: Filters that apply to assessments performed against the AMI Security framework. + ContainerSecurityFilters: + $ref: "#/components/schemas/ContainerSecurityFilters" + description: Filters that apply to assessments performed against the Container Security framework. + AMISecurityFilters: + description: Filters that apply to assessments performed against the AMI Security framework. + type: object + properties: + DeliveryOptionId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the delivery option whose AMI Security assessments you want to list. + ContainerSecurityFilters: + description: Filters that apply to assessments performed against the Container Security framework. + type: object + properties: + DeliveryOptionId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the delivery option whose Container Security assessments you want to list. + ListAssessmentsMaxResultInteger: + type: integer + minimum: 1 + maximum: 100 + ListAssessmentsResponse: + type: object + properties: + AssessmentSummaryList: + $ref: "#/components/schemas/AssessmentSummaryList" + description: An array of AssessmentSummary objects. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The value of the next token, if it exists. null if there are no more results. + AssessmentSummaryList: + type: array + items: + $ref: "#/components/schemas/AssessmentSummary" + AssessmentSummary: + description: Summarized information about an assessment. + type: object + properties: + AssessmentArn: + $ref: "#/components/schemas/ARN" + description: The ARN associated with the assessment. + AssessmentId: + $ref: "#/components/schemas/ResourceId" + description: The unique ID of the assessment. + FrameworkId: + $ref: "#/components/schemas/VersionedFrameworkId" + description: The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0). + AssessmentTargetSummary: + $ref: "#/components/schemas/AssessmentTargetSummary" + description: Identifies the entity or change set that was assessed. + FrameworkSummary: + $ref: "#/components/schemas/FrameworkSummary" + description: The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId. + AssessmentResult: + $ref: "#/components/schemas/AssessmentResult" + description: The overall result of the assessment. + CreatedAt: + $ref: "#/components/schemas/DateTimeISO8601" + description: The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z). + ExpiresAt: + $ref: "#/components/schemas/DateTimeISO8601" + description: The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z). FilterList: type: array items: @@ -691,11 +1001,6 @@ components: type: integer minimum: 1 maximum: 20 - NextToken: - type: string - minLength: 1 - maxLength: 2048 - pattern: ^[\w+=.:@\-\/]$ ListChangeSetsResponse: type: object properties: @@ -1073,6 +1378,15 @@ components: OfferSetId: $ref: "#/components/schemas/OfferSetIdFilter" description: Allows filtering on the OfferSetId of an offer. + TargetAgreementId: + $ref: "#/components/schemas/OfferTargetAgreementIdFilter" + description: Allows filtering on the TargetAgreementId of an offer. + TargetAgreementIntent: + $ref: "#/components/schemas/OfferTargetAgreementIntentFilter" + description: Allows filtering on the TargetAgreementIntent of an offer. + CreatedBySource: + $ref: "#/components/schemas/OfferCreatedBySourceFilter" + description: Allows filtering on the CreatedBySource of an offer. OfferEntityIdFilter: description: Allows filtering on the entity id of an offer. type: object @@ -1253,6 +1567,53 @@ components: minLength: 1 maxLength: 50 pattern: ^offerset-[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$ + OfferTargetAgreementIdFilter: + description: Allows filtering on the TargetAgreementId of an offer. + type: object + properties: + ValueList: + $ref: "#/components/schemas/OfferTargetAgreementIdFilterValueList" + description: Allows filtering on the TargetAgreementId of an offer with list input. + OfferTargetAgreementIdFilterValueList: + type: array + items: + $ref: "#/components/schemas/OfferTargetAgreementIdString" + OfferTargetAgreementIdString: + type: string + minLength: 1 + maxLength: 64 + pattern: ^(.)+$ + OfferTargetAgreementIntentFilter: + description: Allows filtering on the TargetAgreementIntent of an offer. + type: object + properties: + ValueList: + $ref: "#/components/schemas/OfferTargetAgreementIntentFilterValueList" + description: Allows filtering on the TargetAgreementIntent of an offer with list input. + OfferTargetAgreementIntentFilterValueList: + type: array + items: + $ref: "#/components/schemas/OfferTargetAgreementIntentString" + OfferTargetAgreementIntentString: + type: string + enum: + - Renew + OfferCreatedBySourceFilter: + description: Allows filtering on the CreatedBySource of an offer. + type: object + properties: + ValueList: + $ref: "#/components/schemas/OfferCreatedBySourceFilterValueList" + description: Allows filtering on the CreatedBySource of an offer with list input. + OfferCreatedBySourceFilterValueList: + type: array + items: + $ref: "#/components/schemas/OfferCreatedBySourceString" + OfferCreatedBySourceString: + type: string + enum: + - Seller + - AwsMarketplace ContainerProductFilters: description: Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request. type: object @@ -1382,6 +1743,9 @@ components: LastModifiedDate: $ref: "#/components/schemas/ResaleAuthorizationLastModifiedDateFilter" description: Allows filtering on the LastModifiedDate of a ResaleAuthorization. + ResellerRole: + $ref: "#/components/schemas/ResaleAuthorizationResellerRoleFilter" + description: Allows filtering on the ResellerRole of a ResaleAuthorization. ResaleAuthorizationEntityIdFilter: description: Allows filtering on EntityId of a ResaleAuthorization. type: object @@ -1664,6 +2028,22 @@ components: BeforeValue: $ref: "#/components/schemas/DateTimeISO8601" description: Allows filtering on the LastModifiedDate of a ResaleAuthorization before a date. + ResaleAuthorizationResellerRoleFilter: + description: Allows filtering on the ResellerRole of a ResaleAuthorization. + type: object + properties: + ValueList: + $ref: "#/components/schemas/ResaleAuthorizationResellerRoleFilterValueList" + description: Allows filtering on the ResellerRole of a ResaleAuthorization with list input. + ResaleAuthorizationResellerRoleFilterValueList: + type: array + items: + $ref: "#/components/schemas/ResaleAuthorizationResellerRoleString" + ResaleAuthorizationResellerRoleString: + type: string + enum: + - ChannelPartner + - Distributor MachineLearningProductFilters: description: The filters that you can use with the ListEntities operation to filter machine learning products. You can filter by EntityId, astModifiedDate, ProductTitle, and Visibility. type: object @@ -1998,6 +2378,9 @@ components: - Targeting - LastModifiedDate - OfferSetId + - TargetAgreementId + - TargetAgreementIntent + - CreatedBySource ContainerProductSort: description: Objects that allows sorting on container products based on certain fields and sorting order. type: object @@ -2218,6 +2601,15 @@ components: OfferSetId: $ref: "#/components/schemas/OfferSetIdString" description: The offer set ID of the offer. + TargetAgreementId: + $ref: "#/components/schemas/OfferTargetAgreementIdString" + description: The target agreement ID of the offer. + TargetAgreementIntent: + $ref: "#/components/schemas/OfferTargetAgreementIntentString" + description: The target agreement intent of the offer. + CreatedBySource: + $ref: "#/components/schemas/OfferCreatedBySourceString" + description: The creation source of the offer. OfferBuyerAccountsList: type: array items: @@ -2268,6 +2660,9 @@ components: AvailabilityEndDate: $ref: "#/components/schemas/DateTimeISO8601" description: The availability end date of the ResaleAuthorization. + ResellerRole: + $ref: "#/components/schemas/ResaleAuthorizationResellerRoleString" + description: The reseller role of the ResaleAuthorization. MachineLearningProductSummary: description: A summary of a machine learning product. type: object @@ -2482,6 +2877,56 @@ components: - $ref: "#/components/x-stackQL-resources/resource_policies/methods/put_resource_policy" delete: - $ref: "#/components/x-stackQL-resources/resource_policies/methods/delete_resource_policy" + assessments: + id: aws.marketplace_catalog.assessments + name: assessments + title: assessments + methods: + describe_assessment: + operation: + $ref: "#/paths/~1DescribeAssessment/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ControlAssessments + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + list_assessments: + operation: + $ref: "#/paths/~1ListAssessments/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AssessmentSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/assessments/methods/describe_assessment" + - $ref: "#/components/x-stackQL-resources/assessments/methods/list_assessments" + insert: [] + update: [] + delete: [] change_sets: id: aws.marketplace_catalog.change_sets name: change_sets diff --git a/providers/src/aws/v00.00.00000/services/marketplace_discovery.yaml b/providers/src/aws/v00.00.00000/services/marketplace_discovery.yaml index 57a07cf0..3c793636 100644 --- a/providers/src/aws/v00.00.00000/services/marketplace_discovery.yaml +++ b/providers/src/aws/v00.00.00000/services/marketplace_discovery.yaml @@ -810,9 +810,6 @@ components: offerName: $ref: "#/components/schemas/NullableString" description: The display name of the offer. This is free-form text provided by the seller. - agreementProposalId: - $ref: "#/components/schemas/AgreementResourceId" - description: An encoded string to be passed by the acceptor of the terms when creating an agreement. expirationTime: $ref: "#/components/schemas/Timestamp" description: The date and time until when the offer can be procured. This value is null for offers that never expire. @@ -822,6 +819,12 @@ components: sellerOfRecord: $ref: "#/components/schemas/SellerInformation" description: The entity responsible for selling the product under this offer. + associatedEntities: + $ref: "#/components/schemas/OfferAssociatedEntityList" + description: The products and offer sets associated with this offer. + agreementProposalId: + $ref: "#/components/schemas/AgreementResourceId" + description: An encoded string to be passed by the acceptor of the terms when creating an agreement. replacementAgreementId: $ref: "#/components/schemas/AgreementResourceId" description: The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality. @@ -831,48 +834,17 @@ components: badges: $ref: "#/components/schemas/PurchaseOptionBadgeList" description: Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer. - associatedEntities: - $ref: "#/components/schemas/OfferAssociatedEntityList" - description: The products and offer sets associated with this offer. required: - offerId - catalog - - agreementProposalId - sellerOfRecord + - associatedEntities + - agreementProposalId - pricingModel - badges - - associatedEntities - AgreementResourceId: - type: string - minLength: 1 - maxLength: 64 - pattern: "[A-Za-z0-9_/-]+" Timestamp: type: string format: date-time - PurchaseOptionBadgeList: - type: array - items: - $ref: "#/components/schemas/PurchaseOptionBadge" - PurchaseOptionBadge: - description: A badge indicating a special attribute of a purchase option, such as private pricing or future dated. - type: object - properties: - displayName: - $ref: "#/components/schemas/NonEmptyString" - description: The human-readable name of the badge. - badgeType: - $ref: "#/components/schemas/PurchaseOptionBadgeType" - description: The machine-readable type of the badge. - required: - - displayName - - badgeType - PurchaseOptionBadgeType: - type: string - enum: - - PRIVATE_PRICING - - FUTURE_DATED - - REPLACEMENT_OFFER OfferAssociatedEntityList: type: array items: @@ -907,6 +879,34 @@ components: minLength: 1 maxLength: 255 pattern: "[\\w\\-]+" + AgreementResourceId: + type: string + minLength: 1 + maxLength: 64 + pattern: "[A-Za-z0-9_/-]+" + PurchaseOptionBadgeList: + type: array + items: + $ref: "#/components/schemas/PurchaseOptionBadge" + PurchaseOptionBadge: + description: A badge indicating a special attribute of a purchase option, such as private pricing or future dated. + type: object + properties: + displayName: + $ref: "#/components/schemas/NonEmptyString" + description: The human-readable name of the badge. + badgeType: + $ref: "#/components/schemas/PurchaseOptionBadgeType" + description: The machine-readable type of the badge. + required: + - displayName + - badgeType + PurchaseOptionBadgeType: + type: string + enum: + - PRIVATE_PRICING + - FUTURE_DATED + - REPLACEMENT_OFFER GetOfferSetOutput: type: object properties: @@ -1012,6 +1012,9 @@ components: $ref: "#/components/schemas/ValidityTerm" variablePaymentTerm: $ref: "#/components/schemas/VariablePaymentTerm" + netPaymentTerm: + $ref: "#/components/schemas/NetPaymentTerm" + description: A net payment term. ByolPricingTerm: description: Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product. type: object @@ -1045,6 +1048,7 @@ components: - SupportTerm - ValidityTerm - VariablePaymentTerm + - NetPaymentTerm ConfigurableUpfrontPricingTerm: description: Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations. type: object @@ -1488,6 +1492,23 @@ components: - type_ - currencyCode - maxTotalChargeAmount + NetPaymentTerm: + description: Defines a net payment term that sets how many days after the invoice date the payment is due. + type: object + properties: + id: + $ref: "#/components/schemas/TermId" + description: The unique identifier of the term. + type_: + $ref: "#/components/schemas/TermType" + description: The category of the term. + paymentDuePeriod: + $ref: "#/components/schemas/BoundedString" + description: The duration after invoice date by which payment is due. + required: + - id + - type_ + - paymentDuePeriod GetProductOutput: type: object properties: @@ -1500,6 +1521,9 @@ components: productName: $ref: "#/components/schemas/NonEmptyString" description: The human-readable display name of the product. + manufacturer: + $ref: "#/components/schemas/SellerInformation" + description: The entity who manufactured the product. deployedOnAws: $ref: "#/components/schemas/DeployedOnAwsStatus" description: Indicates whether the product is deployed on AWS infrastructure. @@ -1509,9 +1533,6 @@ components: longDescription: $ref: "#/components/schemas/GetProductOutputLongDescriptionString" description: A detailed description of what the product does, in paragraph format. - manufacturer: - $ref: "#/components/schemas/SellerInformation" - description: The entity who manufactured the product. logoThumbnailUrl: $ref: "#/components/schemas/URL" description: The URL of the logo thumbnail image for the product. @@ -1537,10 +1558,10 @@ components: - productId - catalog - productName + - manufacturer - deployedOnAws - shortDescription - longDescription - - manufacturer - logoThumbnailUrl - fulfillmentOptionSummaries - categories @@ -2356,6 +2377,9 @@ components: publisher: $ref: "#/components/schemas/SellerInformation" description: The entity who created and published the listing. + fulfillmentOptionSummaries: + $ref: "#/components/schemas/FulfillmentOptionSummaryList" + description: A summary of fulfillment options available for the listing. catalog: $ref: "#/components/schemas/Catalog" description: The name of the catalog that the listing belongs to. @@ -2368,9 +2392,6 @@ components: categories: $ref: "#/components/schemas/CategoryList" description: The categories used to classify this listing into logical groups. - fulfillmentOptionSummaries: - $ref: "#/components/schemas/FulfillmentOptionSummaryList" - description: A summary of fulfillment options available for the listing. badges: $ref: "#/components/schemas/ListingBadgeList" description: Badges indicating special attributes of the listing. @@ -2390,11 +2411,11 @@ components: - listingId - listingName - publisher + - fulfillmentOptionSummaries - catalog - shortDescription - logoThumbnailUrl - categories - - fulfillmentOptionSummaries - badges - reviewSummary - pricingModels diff --git a/providers/src/aws/v00.00.00000/services/mediaconnect.yaml b/providers/src/aws/v00.00.00000/services/mediaconnect.yaml index 02bc262b..016bf965 100644 --- a/providers/src/aws/v00.00.00000/services/mediaconnect.yaml +++ b/providers/src/aws/v00.00.00000/services/mediaconnect.yaml @@ -552,7 +552,9 @@ paths: Tags: $ref: "#/components/schemas/__mapOfString" ClientToken: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/ClientToken" + ContentQualityAnalysisConfiguration: + $ref: "#/components/schemas/RouterContentQualityAnalysisConfiguration" required: - Configuration - MaximumBitrate @@ -586,7 +588,7 @@ paths: Tags: $ref: "#/components/schemas/__mapOfString" ClientToken: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/ClientToken" required: - Configuration responses: @@ -626,8 +628,10 @@ paths: $ref: "#/components/schemas/MaintenanceConfiguration" Tags: $ref: "#/components/schemas/__mapOfString" + FabricConfiguration: + $ref: "#/components/schemas/FabricConfiguration" ClientToken: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/ClientToken" required: - Configuration - MaximumBitrate @@ -877,6 +881,8 @@ paths: $ref: "#/components/schemas/RouterInputTransitEncryption" MaintenanceConfiguration: $ref: "#/components/schemas/MaintenanceConfiguration" + ContentQualityAnalysisConfiguration: + $ref: "#/components/schemas/RouterContentQualityAnalysisConfiguration" responses: "202": description: Success @@ -1011,6 +1017,8 @@ paths: $ref: "#/components/schemas/RouterOutputTier" MaintenanceConfiguration: $ref: "#/components/schemas/MaintenanceConfiguration" + FabricConfiguration: + $ref: "#/components/schemas/FabricConfiguration" responses: "202": description: Success @@ -1735,6 +1743,8 @@ paths: $ref: "#/components/schemas/State" RouterIntegrationTransitEncryption: $ref: "#/components/schemas/FlowTransitEncryption" + NdiOutputTimecodeSource: + $ref: "#/components/schemas/NdiOutputTimecodeSource" responses: "202": description: Success @@ -2719,6 +2729,9 @@ components: description: Indicates whether to enable or disable router integration when creating a new flow output. RouterIntegrationTransitEncryption: $ref: "#/components/schemas/FlowTransitEncryption" + NdiOutputTimecodeSource: + $ref: "#/components/schemas/NdiOutputTimecodeSource" + description: Controls how MediaConnect generates timecodes for NDI output frames. If you don't specify this field, MediaConnect uses EMBEDDED_TIMECODE. EMBEDDED_TIMECODE (default) - Preserves timecodes from the input transport stream. The timecodes must be embedded in the video stream as SEI timing messages. If no embedded timecode is detected, MediaConnect uses the UTC system time instead. UTC_SYSTEM_TIME - Generates timecodes based on the system clock time when each frame is sent. __listOfString: type: array items: @@ -2906,6 +2919,11 @@ components: AutomaticEncryptionKeyConfiguration: description: Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation. type: object + NdiOutputTimecodeSource: + type: string + enum: + - EMBEDDED_TIMECODE + - UTC_SYSTEM_TIME AddFlowOutputsResponse: type: object properties: @@ -3108,6 +3126,9 @@ components: NdiSourceSettings: $ref: "#/components/schemas/NdiSourceSettings" description: The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. + NdiOutputTimecodeSource: + $ref: "#/components/schemas/NdiOutputTimecodeSource" + description: The timecode source for NDI output frames. For NDI outputs, this field is always present and defaults to EMBEDDED_TIMECODE. EMBEDDED_TIMECODE - Preserves timecodes from the input transport stream. The timecodes must be embedded in the video stream as SEI timing messages. If no embedded timecode is detected, MediaConnect uses the UTC system time instead. UTC_SYSTEM_TIME - Generates timecodes based on the system clock time when each frame is sent. required: - Protocol NdiSourceSettings: @@ -3300,10 +3321,10 @@ components: description: The name of the source. SenderControlPort: $ref: "#/components/schemas/Integer" - description: The IP address that the flow communicates with to initiate connection with the sender. + description: The port that the flow uses to send outbound requests to initiate connection with the sender. SenderIpAddress: $ref: "#/components/schemas/String" - description: The port that the flow uses to send outbound requests to initiate connection with the sender. + description: The IP address that the flow communicates with to initiate connection with the sender. SourceArn: $ref: "#/components/schemas/String" description: The ARN of the source. @@ -3566,6 +3587,12 @@ components: MaintenanceSchedule: $ref: "#/components/schemas/MaintenanceSchedule" description: The current maintenance schedule details for this router input. + ContentQualityAnalysisType: + $ref: "#/components/schemas/RouterContentQualityAnalysisType" + description: The type of content quality analysis applied to the router input. + ContentQualityAnalysisConfiguration: + $ref: "#/components/schemas/RouterContentQualityAnalysisConfiguration" + description: The content quality analysis configuration for the router input. required: - Name - Arn @@ -3587,6 +3614,8 @@ components: - StreamDetails - MaintenanceType - MaintenanceConfiguration + - ContentQualityAnalysisType + - ContentQualityAnalysisConfiguration RouterInputState: type: string enum: @@ -4118,6 +4147,78 @@ components: - Start - End - ScheduledTime + RouterContentQualityAnalysisType: + type: string + enum: + - CONTENT_LEVEL + RouterContentQualityAnalysisConfiguration: + description: The content quality analysis configuration for the router input. The content quality analysis feature only monitors the first video stream and the first audio stream it encounters within the router input source. + type: object + properties: + ContentLevel: + $ref: "#/components/schemas/ContentQualityAnalysisFeatureConfiguration" + description: The content quality analysis configuration. + ContentQualityAnalysisFeatureConfiguration: + description: Configures the content quality analysis features for the router input. + type: object + properties: + BlackFrames: + $ref: "#/components/schemas/BlackFramesConfiguration" + description: Settings for black frames detection. + FrozenFrames: + $ref: "#/components/schemas/FrozenFramesConfiguration" + description: Settings for frozen frames detection. + SilentAudio: + $ref: "#/components/schemas/SilentAudioConfiguration" + description: Settings for silent audio detection. + BlackFramesConfiguration: + description: Detects black frames in the router input's source content and reports them through a CloudWatch metric, an EventBridge event, and a router input message. + type: object + properties: + State: + $ref: "#/components/schemas/ContentQualityAnalysisState" + description: Indicates whether black frames detection is enabled or disabled. + ThresholdSeconds: + $ref: "#/components/schemas/RouterCqaThresholdSeconds" + description: The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue. + required: + - State + - ThresholdSeconds + ContentQualityAnalysisState: + type: string + enum: + - ENABLED + - DISABLED + RouterCqaThresholdSeconds: + type: integer + minimum: 10 + maximum: 60 + FrozenFramesConfiguration: + description: Detects frozen video frames in the router input's source content and reports them through a CloudWatch metric, an EventBridge event, and a router input message. + type: object + properties: + State: + $ref: "#/components/schemas/ContentQualityAnalysisState" + description: Indicates whether frozen frames detection is enabled or disabled. + ThresholdSeconds: + $ref: "#/components/schemas/RouterCqaThresholdSeconds" + description: The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue. + required: + - State + - ThresholdSeconds + SilentAudioConfiguration: + description: Detects silent audio in the router input's source content and reports it through a CloudWatch metric, an EventBridge event, and a router input message. + type: object + properties: + State: + $ref: "#/components/schemas/ContentQualityAnalysisState" + description: Indicates whether silent audio detection is enabled or disabled. + ThresholdSeconds: + $ref: "#/components/schemas/RouterCqaThresholdSeconds" + description: The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue. + required: + - State + - ThresholdSeconds BatchGetRouterInputErrorList: type: array items: @@ -4252,10 +4353,13 @@ components: type: object properties: Cidr: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/PublicRouterNetworkInterfaceRuleCidrString" description: The CIDR block that is allowed to access the public router network interface. required: - Cidr + PublicRouterNetworkInterfaceRuleCidrString: + type: string + pattern: (?:[0-9]{1,3}\.){3}[0-9]{1,3}/([0-9]|[12][0-9]|3[0-2]) VpcRouterNetworkInterfaceConfiguration: description: The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID. type: object @@ -4389,6 +4493,9 @@ components: MaintenanceSchedule: $ref: "#/components/schemas/MaintenanceSchedule" description: The current maintenance schedule details for this router output. + FabricConfiguration: + $ref: "#/components/schemas/FabricConfiguration" + description: The fabric configuration settings for the router output. required: - Name - Arn @@ -4409,6 +4516,7 @@ components: - StreamDetails - MaintenanceType - MaintenanceConfiguration + - FabricConfiguration RouterOutputState: type: string enum: @@ -4669,6 +4777,20 @@ components: MediaLiveInputRouterOutputStreamDetails: description: Configuration details for a MediaLive input when used as a router output destination. type: object + FabricConfiguration: + description: The fabric configuration settings for the router output. + type: object + properties: + RecoveryLatencyMode: + $ref: "#/components/schemas/FabricLatencyMode" + description: "The recovery latency mode for the router fabric connection. Valid values include the following: BALANCED (default) – Optimizes for stream quality. LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions." + required: + - RecoveryLatencyMode + FabricLatencyMode: + type: string + enum: + - BALANCED + - LOW_LATENCY BatchGetRouterOutputErrorList: type: array items: @@ -4950,11 +5072,6 @@ components: ThresholdSeconds: $ref: "#/components/schemas/Integer" description: Specifies the number of consecutive seconds of silence that triggers an event or alert. - ContentQualityAnalysisState: - type: string - enum: - - ENABLED - - DISABLED __listOfVideoMonitoringSetting: type: array items: @@ -4975,7 +5092,7 @@ components: properties: State: $ref: "#/components/schemas/State" - description: Indicates whether the BlackFrames metric is enabled or disabled.. + description: Indicates whether the BlackFrames metric is enabled or disabled. ThresholdSeconds: $ref: "#/components/schemas/Integer" description: Specifies the number of consecutive seconds of black frames that triggers an event or alert. @@ -5245,6 +5362,11 @@ components: type: string minLength: 1 maxLength: 128 + ClientToken: + type: string + minLength: 0 + maxLength: 256 + pattern: "[!-~]+" CreateRouterInputResponse: type: object properties: @@ -5257,6 +5379,7 @@ components: type: string minLength: 1 maxLength: 128 + pattern: "[a-zA-Z0-9]([a-zA-Z0-9\\-_]*[a-zA-Z0-9])?" CreateRouterNetworkInterfaceResponse: type: object properties: @@ -7037,6 +7160,7 @@ components: type: string minLength: 1 maxLength: 128 + pattern: "[a-zA-Z0-9]([a-zA-Z0-9\\-_]*[a-zA-Z0-9])?" UpdateRouterNetworkInterfaceResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/mediaconvert.yaml b/providers/src/aws/v00.00.00000/services/mediaconvert.yaml index ecdcd1b6..c5f215d7 100644 --- a/providers/src/aws/v00.00.00000/services/mediaconvert.yaml +++ b/providers/src/aws/v00.00.00000/services/mediaconvert.yaml @@ -740,7 +740,7 @@ paths: $ref: "#/components/schemas/ListTagsForResourceResponse" put: operationId: UntagResource - description: Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + description: Remove tags from a MediaConvert queue, preset, job, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-mediaconvert-resources.html. parameters: - name: arn in: path @@ -887,7 +887,7 @@ paths: /2017-08-29/tags: post: operationId: TagResource - description: Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + description: Add tags to a MediaConvert queue, preset, job, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-mediaconvert-resources.html. parameters: [] requestBody: required: true @@ -1917,7 +1917,7 @@ components: $ref: "#/components/schemas/__integerMin0Max2147483647" description: Provide your Kantar license ID number. You should get this number from Kantar. KantarServerUrl: - $ref: "#/components/schemas/__stringPatternHttpsKantarmedia" + $ref: "#/components/schemas/__stringPatternHttpsKantarmedia55Prod" description: Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar. LogDestination: $ref: "#/components/schemas/__stringPatternS3" @@ -1957,9 +1957,9 @@ components: __doubleMin0: type: number format: double - __stringPatternHttpsKantarmedia: + __stringPatternHttpsKantarmedia55Prod: type: string - pattern: ^https:\/\/.*.kantarmedia.*$ + pattern: ^https:\/\/.*.(kantarmedia|55-prod).*$ __stringPatternS3: type: string pattern: ^s3:\/\/.*$ @@ -2325,10 +2325,13 @@ components: description: "Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control to specify whether the encoder enforces this value strictly." ImageBasedTrickPlay: $ref: "#/components/schemas/CmafImageBasedTrickPlay" - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" ImageBasedTrickPlaySettings: $ref: "#/components/schemas/CmafImageBasedTrickPlaySettings" description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED + ImageBasedTrickPlayVariants: + $ref: "#/components/schemas/__listOfCmafImageBasedTrickPlayVariant" + description: Specify multiple image-based trick play variants. Each entry creates a separate set of JPEG tile images with its own resolution, tile layout, and cadence settings. Set imageBasedTrickPlay to VARIANTS when using this setting. ManifestCompression: $ref: "#/components/schemas/CmafManifestCompression" description: When set to GZIP, compresses HLS playlist. @@ -2493,13 +2496,14 @@ components: - INTELLIGENT_TIERING - GLACIER - DEEP_ARCHIVE + - GLACIER_IR CmafEncryptionSettings: description: Settings for CMAF encryption type: object properties: - ClearLead: - $ref: "#/components/schemas/HlsClearLead" - description: "Enable Clear Lead DRM to reduce video startup latency by leaving the first segment unencrypted while DRM license retrieval occurs in parallel. This optimization allows immediate playback startup while maintaining content protection for the remainder of the stream. When enabled, the first output segment remains fully unencrypted, and encryption begins at the start of the second segment. The HLS manifest will omit #EXT-X-KEY tags during the clear segment and insert the first #EXT-X-KEY immediately before the first encrypted fragment. This feature is supported exclusively for CMAF HLS (fMP4) outputs and is compatible with all existing key provider integrations (SPEKE v1, SPEKE v2, and Static Key encryption). Supported codecs: H.264, H.265, and AV1 video codecs, and AAC audio codec. Choose Enabled to activate Clear Lead DRM optimization. Choose Disabled to use standard encryption where all segments are encrypted from the beginning." + ClearLeadSegments: + $ref: "#/components/schemas/__integerMin1Max9999" + description: "Reduce video startup latency by leaving initial segments unencrypted while DRM license retrieval occurs in parallel. This optimization allows immediate playback startup while maintaining content protection for the remainder of the stream. Specify the number of initial segments to leave unencrypted. Omit this field to disable Clear Lead. The HLS manifest will omit #EXT-X-KEY tags during clear segments and insert the first #EXT-X-KEY immediately before the first encrypted segment. Because encryption is applied at the fragment level, the actual duration of unencrypted content may be slightly longer than expected if the segment length is not evenly divisible by the fragment length. In such cases, encryption begins at the next fragment boundary after the specified clear lead segments, rather than at the exact segment boundary. This feature is supported exclusively for CMAF HLS (fMP4) outputs and is compatible with all existing key provider integrations (SPEKE v1, SPEKE v2, and Static Key encryption). Supported codecs: H.264, H.265, and AV1 video codecs, and AAC audio codec." ConstantInitializationVector: $ref: "#/components/schemas/__stringMin32Max32Pattern09aFAF32" description: This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default. @@ -2518,12 +2522,10 @@ components: Type: $ref: "#/components/schemas/CmafKeyProviderType" description: Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. - HlsClearLead: - description: "Enable Clear Lead DRM to reduce video startup latency by leaving the first segment unencrypted while DRM license retrieval occurs in parallel. This optimization allows immediate playback startup while maintaining content protection for the remainder of the stream. When enabled, the first output segment remains fully unencrypted, and encryption begins at the start of the second segment. The HLS manifest will omit #EXT-X-KEY tags during the clear segment and insert the first #EXT-X-KEY immediately before the first encrypted fragment. This feature is supported exclusively for CMAF HLS (fMP4) outputs and is compatible with all existing key provider integrations (SPEKE v1, SPEKE v2, and Static Key encryption). Supported codecs: H.264, H.265, and AV1 video codecs, and AAC audio codec. Choose Enabled to activate Clear Lead DRM optimization. Choose Disabled to use standard encryption where all segments are encrypted from the beginning." - type: string - enum: - - ENABLED - - DISABLED + __integerMin1Max9999: + type: integer + minimum: 1 + maximum: 9999 __stringMin32Max32Pattern09aFAF32: type: string minLength: 32 @@ -2646,13 +2648,14 @@ components: - SPEKE - STATIC_KEY CmafImageBasedTrickPlay: - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" type: string enum: - NONE - THUMBNAIL - THUMBNAIL_AND_FULLFRAME - ADVANCED + - VARIANTS CmafImageBasedTrickPlaySettings: description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED type: object @@ -2671,7 +2674,7 @@ components: description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. TileHeight: $ref: "#/components/schemas/__integerMin1Max2048" - description: Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. TileWidth: $ref: "#/components/schemas/__integerMin1Max512" description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. @@ -2701,6 +2704,32 @@ components: type: integer minimum: 1 maximum: 512 + __listOfCmafImageBasedTrickPlayVariant: + type: array + items: + $ref: "#/components/schemas/CmafImageBasedTrickPlayVariant" + CmafImageBasedTrickPlayVariant: + description: Settings for one image-based trick play variant. Each variant produces its own set of JPEG tile images and corresponding manifest entries. + type: object + properties: + IntervalCadence: + $ref: "#/components/schemas/CmafIntervalCadence" + description: The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. If set to FOLLOW_SEGMENTATION, MediaConvert generates thumbnail playlist entries that align exactly with video segment boundaries. FOLLOW_SEGMENTATION requires 1x1 tiling. + ThumbnailHeight: + $ref: "#/components/schemas/__integerMin2Max4096" + description: Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. + ThumbnailInterval: + $ref: "#/components/schemas/__doubleMin0Max2147483647" + description: Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. + ThumbnailWidth: + $ref: "#/components/schemas/__integerMin8Max4096" + description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + TileHeight: + $ref: "#/components/schemas/__integerMin1Max2048" + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. + TileWidth: + $ref: "#/components/schemas/__integerMin1Max512" + description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. CmafManifestCompression: description: When set to GZIP, compresses HLS playlist. type: string @@ -2816,10 +2845,13 @@ components: description: Supports HbbTV specification as indicated ImageBasedTrickPlay: $ref: "#/components/schemas/DashIsoImageBasedTrickPlay" - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" ImageBasedTrickPlaySettings: $ref: "#/components/schemas/DashIsoImageBasedTrickPlaySettings" description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED + ImageBasedTrickPlayVariants: + $ref: "#/components/schemas/__listOfDashIsoImageBasedTrickPlayVariant" + description: Specify multiple image-based trick play variants. Each entry creates a separate set of JPEG tile images with its own resolution, tile layout, and cadence settings. Set imageBasedTrickPlay to VARIANTS when using this setting. MinBufferTime: $ref: "#/components/schemas/__integerMin0Max2147483647" description: Minimum time of initially buffered media that is needed to ensure smooth playout. @@ -2919,13 +2951,14 @@ components: - HBBTV_1_5 - NONE DashIsoImageBasedTrickPlay: - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" type: string enum: - NONE - THUMBNAIL - THUMBNAIL_AND_FULLFRAME - ADVANCED + - VARIANTS DashIsoImageBasedTrickPlaySettings: description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED type: object @@ -2944,7 +2977,7 @@ components: description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. TileHeight: $ref: "#/components/schemas/__integerMin1Max2048" - description: Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. TileWidth: $ref: "#/components/schemas/__integerMin1Max512" description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. @@ -2959,6 +2992,32 @@ components: type: integer minimum: 1 maximum: 4096 + __listOfDashIsoImageBasedTrickPlayVariant: + type: array + items: + $ref: "#/components/schemas/DashIsoImageBasedTrickPlayVariant" + DashIsoImageBasedTrickPlayVariant: + description: Settings for one image-based trick play variant. Each variant produces its own set of JPEG tile images and corresponding manifest entries. + type: object + properties: + IntervalCadence: + $ref: "#/components/schemas/DashIsoIntervalCadence" + description: The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. If set to FOLLOW_SEGMENTATION, MediaConvert generates thumbnail playlist entries that align exactly with video segment boundaries. FOLLOW_SEGMENTATION requires 1x1 tiling. + ThumbnailHeight: + $ref: "#/components/schemas/__integerMin2Max4096" + description: Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. + ThumbnailInterval: + $ref: "#/components/schemas/__doubleMin0Max2147483647" + description: Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. + ThumbnailWidth: + $ref: "#/components/schemas/__integerMin8Max4096" + description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + TileHeight: + $ref: "#/components/schemas/__integerMin1Max2048" + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. + TileWidth: + $ref: "#/components/schemas/__integerMin1Max512" + description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. DashIsoMpdManifestBandwidthType: description: "Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second." type: string @@ -3057,10 +3116,13 @@ components: description: DRM settings. ImageBasedTrickPlay: $ref: "#/components/schemas/HlsImageBasedTrickPlay" - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" ImageBasedTrickPlaySettings: $ref: "#/components/schemas/HlsImageBasedTrickPlaySettings" description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED + ImageBasedTrickPlayVariants: + $ref: "#/components/schemas/__listOfHlsImageBasedTrickPlayVariant" + description: Specify multiple image-based trick play variants. Each entry creates a separate set of JPEG tile images with its own resolution, tile layout, and cadence settings. Set imageBasedTrickPlay to VARIANTS when using this setting. ManifestCompression: $ref: "#/components/schemas/HlsManifestCompression" description: When set to GZIP, compresses HLS playlist. @@ -3444,13 +3506,14 @@ components: - SPEKE - STATIC_KEY HlsImageBasedTrickPlay: - description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" + description: "Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. Choose Advanced to customize thumbnail and tile settings for a single trick play variant. Choose Variants to specify multiple trick play variants, each with its own thumbnail and tile settings. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md" type: string enum: - NONE - THUMBNAIL - THUMBNAIL_AND_FULLFRAME - ADVANCED + - VARIANTS HlsImageBasedTrickPlaySettings: description: Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED type: object @@ -3469,7 +3532,7 @@ components: description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. TileHeight: $ref: "#/components/schemas/__integerMin1Max2048" - description: Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. TileWidth: $ref: "#/components/schemas/__integerMin1Max512" description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. @@ -3480,6 +3543,32 @@ components: - FOLLOW_IFRAME - FOLLOW_CUSTOM - FOLLOW_SEGMENTATION + __listOfHlsImageBasedTrickPlayVariant: + type: array + items: + $ref: "#/components/schemas/HlsImageBasedTrickPlayVariant" + HlsImageBasedTrickPlayVariant: + description: Settings for one image-based trick play variant. Each variant produces its own set of JPEG tile images and corresponding manifest entries. + type: object + properties: + IntervalCadence: + $ref: "#/components/schemas/HlsIntervalCadence" + description: The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. If set to FOLLOW_SEGMENTATION, MediaConvert generates thumbnail playlist entries that align exactly with video segment boundaries. FOLLOW_SEGMENTATION requires 1x1 tiling. + ThumbnailHeight: + $ref: "#/components/schemas/__integerMin2Max4096" + description: Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. + ThumbnailInterval: + $ref: "#/components/schemas/__doubleMin0Max2147483647" + description: Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. + ThumbnailWidth: + $ref: "#/components/schemas/__integerMin8Max4096" + description: Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + TileHeight: + $ref: "#/components/schemas/__integerMin1Max2048" + description: Number of thumbnails in each column of a tile image. Set a value between 1 and 2048. + TileWidth: + $ref: "#/components/schemas/__integerMin1Max512" + description: Number of thumbnails in each row of a tile image. Set a value between 1 and 512. HlsManifestCompression: description: When set to GZIP, compresses HLS playlist. type: string @@ -5977,6 +6066,9 @@ components: description: These settings relate to your QuickTime MOV output container. type: object properties: + AudioDuration: + $ref: "#/components/schemas/CmfcAudioDuration" + description: Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration. In all other cases, keep the default value, Default codec duration. When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec. ClapAtom: $ref: "#/components/schemas/MovClapAtom" description: When enabled, include 'clap' atom if appropriate for the video output settings. @@ -6751,6 +6843,9 @@ components: EntropyEncoding: $ref: "#/components/schemas/H264EntropyEncoding" description: Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. + ExplicitWeightedPrediction: + $ref: "#/components/schemas/H264ExplicitWeightedPrediction" + description: Enable or disable explicit weighted prediction for the H.264 encoder. Weighted prediction improves compression efficiency for content with fading or brightness changes between frames. FieldEncoding: $ref: "#/components/schemas/H264FieldEncoding" description: The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs. @@ -6952,6 +7047,12 @@ components: enum: - CABAC - CAVLC + H264ExplicitWeightedPrediction: + description: Enable or disable explicit weighted prediction for the H.264 encoder. Weighted prediction improves compression efficiency for content with fading or brightness changes between frames. + type: string + enum: + - DISABLED + - ENABLED H264FieldEncoding: description: The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs. type: string @@ -8543,6 +8644,9 @@ components: DolbyVision: $ref: "#/components/schemas/DolbyVision" description: Enable Dolby Vision feature to produce Dolby Vision compatible video output. + DurationControl: + $ref: "#/components/schemas/DurationControl" + description: Enable integer-second duration normalization. When enabled, the output duration is adjusted to land on an exact integer-second boundary. The adjustment method (trim, compress, or pad) is chosen automatically based on how far the input duration is from the nearest integer second. Hdr10Plus: $ref: "#/components/schemas/Hdr10Plus" description: Enable HDR10+ analysis and metadata injection. Compatible with HEVC only. @@ -8741,6 +8845,19 @@ components: enum: - PROFILE_5 - PROFILE_8_1 + DurationControl: + description: Settings for integer-second duration normalization. When this preprocessor is present, the output duration will be adjusted to an exact integer-second boundary. If the input is within the trim threshold of an integer second, trailing frames are dropped. If within the compression threshold and less than 500ms over the previous integer second, the output is sped up slightly. Otherwise, black frames are padded to the next integer second. + type: object + properties: + IntegerDurationMaximumCompressionDenominator: + $ref: "#/components/schemas/__integerMin1Max2147483647" + description: Required. Denominator of the maximum allowed compression ratio. + IntegerDurationMaximumCompressionNumerator: + $ref: "#/components/schemas/__integerMin0Max2147483647" + description: Required. Numerator of the maximum allowed compression ratio, defined as overrun divided by target duration. For example, numerator 5 with denominator 100 means max 5% compression. Set to 0 to disable compression entirely (only trim or pad will be used). + IntegerDurationTrimThresholdMilliseconds: + $ref: "#/components/schemas/__integerMin0Max500" + description: Maximum number of fractional milliseconds past an integer second that qualify for the trim path (frame dropping). Default is 0 (trimming disabled). Hdr10Plus: description: Setting for HDR10+ metadata insertion type: object @@ -9959,18 +10076,24 @@ components: description: The container of your media file. This information helps you understand the overall structure and details of your media, including format, duration, and track layout. type: object properties: + BitRate: + $ref: "#/components/schemas/__long" + description: The overall bit rate of your media file, in bits per second. This is derived from the file size and duration as (file size in bytes * 8) / duration in seconds. Duration: $ref: "#/components/schemas/__double" description: The total duration of your media file, in seconds. Format: $ref: "#/components/schemas/Format" - description: "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), WebM, MXF, Wave, AVI, or MPEG-TS. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize." + description: "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), WebM, MXF, Wave, AVI, MPEG-TS, MPEG-PS, or MP3. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize." StartTimecode: $ref: "#/components/schemas/__string" description: The start timecode of the media file, in HH:MM:SS:FF format (or HH:MM:SS;FF for drop frame timecode). Note that this field is null when the container does not include an embedded start timecode. Tracks: $ref: "#/components/schemas/__listOfTrack" description: Details about each track (video, audio, or data) in the media file. + __long: + type: integer + format: int64 __double: type: number format: double @@ -9985,6 +10108,8 @@ components: - wave - avi - mpegts + - mpegps + - mp3 __listOfTrack: type: array items: @@ -10033,12 +10158,12 @@ components: LanguageCode: $ref: "#/components/schemas/__string" description: The language code of the audio track, in three character ISO 639-3 format. + ObjectCount: + $ref: "#/components/schemas/__integer" + description: The number of audio objects in an object-based or immersive audio track. This field is present for codecs that support object-based audio, such as E-AC-3 with Joint Object Coding (JOC) or IAMF. This field is null when the audio track does not contain object-based audio metadata. SampleRate: $ref: "#/components/schemas/__integer" description: The sample rate of the audio track. - __long: - type: integer - format: int64 FrameRate: description: The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values. type: object @@ -10057,6 +10182,7 @@ components: - AC3 - EAC3 - FLAC + - MP2 - MP3 - OPUS - PCM @@ -10111,12 +10237,18 @@ components: FrameRate: $ref: "#/components/schemas/FrameRate" description: The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values. + HdrMetadata: + $ref: "#/components/schemas/HdrMetadata" + description: HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content. Height: $ref: "#/components/schemas/__integer" description: The height of the video track, in pixels. MatrixCoefficients: $ref: "#/components/schemas/MatrixCoefficients" description: The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes. + Rotation: + $ref: "#/components/schemas/__integer" + description: The clockwise rotation angle of the video track, in degrees, as derived from container-level metadata (e.g. the MP4 tkhd transformation matrix or the Matroska ProjectionPoseRoll element). Common values are 90, 180, and 270. This field is null when no rotation metadata is present or when the rotation is 0 degrees. For MP4, non-standard transformation matrices also yield null. TransferCharacteristics: $ref: "#/components/schemas/TransferCharacteristics" description: The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction. @@ -10139,6 +10271,12 @@ components: ColorPrimaries: $ref: "#/components/schemas/ColorPrimaries" description: The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding. + ContentLightLevel: + $ref: "#/components/schemas/ContentLightLevel" + description: Content light level information (CTA-861.3). Describes the light level characteristics of the content. + FieldOrder: + $ref: "#/components/schemas/__string" + description: The field order of interlaced video, which indicates whether the top or bottom field is displayed first. Use this to select the correct deinterlacing behavior. One of "TopFieldFirst" or "BottomFieldFirst". This field is present only for interlaced video; it is omitted for progressive video and when the field order is not indicated by the source. Height: $ref: "#/components/schemas/__integer" description: The height in pixels as coded by the codec. This represents the actual encoded video height as specified in the video stream headers. @@ -10151,6 +10289,9 @@ components: Profile: $ref: "#/components/schemas/__string" description: The codec profile used to encode the video. Profiles define specific feature sets and capabilities within a codec standard. For example, H.264 profiles include Baseline, Main, and High, each supporting different encoding features and complexity levels. + Rotation: + $ref: "#/components/schemas/__integer" + description: The clockwise rotation angle of the video, in degrees, as specified in the codec bitstream via a Display Orientation SEI message (payload type 47 for both H.264 and H.265). This field is null when the video essence does not contain a Display Orientation SEI message or when the rotation is 0 degrees. ScanType: $ref: "#/components/schemas/__string" description: The scanning method specified in the video essence, indicating whether the video uses progressive or interlaced scanning. @@ -10180,6 +10321,16 @@ components: - SMPTE_2067XYZ - EBU_3213_E - LAST + ContentLightLevel: + description: Content light level information (CTA-861.3). Describes the light level characteristics of the content. + type: object + properties: + MaxContentLightLevel: + $ref: "#/components/schemas/__integer" + description: Maximum content light level (MaxCLL), in cd/m². + MaxFrameAverageLightLevel: + $ref: "#/components/schemas/__integer" + description: Maximum frame-average light level (MaxFALL), in cd/m². MatrixCoefficients: description: The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes. type: string @@ -10225,6 +10376,50 @@ components: - SMPTE_428_1 - ARIB_B67 - LAST + HdrMetadata: + description: HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content. + type: object + properties: + ContentLightLevel: + $ref: "#/components/schemas/ContentLightLevel" + description: Content light level information (CTA-861.3). Describes the light level characteristics of the content. + MasteringDisplayColorVolume: + $ref: "#/components/schemas/MasteringDisplayColorVolume" + description: Mastering display color volume metadata (SMPTE ST 2086). Describes the color volume of the display used to master the content. Chromaticity coordinates are in units of 0.00002. Luminance values are in units of 0.0001 cd/m². + MasteringDisplayColorVolume: + description: Mastering display color volume metadata (SMPTE ST 2086). Describes the color volume of the display used to master the content. Chromaticity coordinates are in units of 0.00002. Luminance values are in units of 0.0001 cd/m². + type: object + properties: + BluePrimaryX: + $ref: "#/components/schemas/__integer" + description: Blue primary chromaticity x coordinate, in units of 0.00002. + BluePrimaryY: + $ref: "#/components/schemas/__integer" + description: Blue primary chromaticity y coordinate, in units of 0.00002. + GreenPrimaryX: + $ref: "#/components/schemas/__integer" + description: Green primary chromaticity x coordinate, in units of 0.00002. + GreenPrimaryY: + $ref: "#/components/schemas/__integer" + description: Green primary chromaticity y coordinate, in units of 0.00002. + MaxLuminance: + $ref: "#/components/schemas/__long" + description: Maximum display mastering luminance, in units of 0.0001 cd/m². + MinLuminance: + $ref: "#/components/schemas/__long" + description: Minimum display mastering luminance, in units of 0.0001 cd/m². + RedPrimaryX: + $ref: "#/components/schemas/__integer" + description: Red primary chromaticity x coordinate, in units of 0.00002. + RedPrimaryY: + $ref: "#/components/schemas/__integer" + description: Red primary chromaticity y coordinate, in units of 0.00002. + WhitePointX: + $ref: "#/components/schemas/__integer" + description: White point chromaticity x coordinate, in units of 0.00002. + WhitePointY: + $ref: "#/components/schemas/__integer" + description: White point chromaticity y coordinate, in units of 0.00002. Metadata: description: Metadata and other file information. type: object diff --git a/providers/src/aws/v00.00.00000/services/medialive.yaml b/providers/src/aws/v00.00.00000/services/medialive.yaml index 4631dd18..e0909d75 100644 --- a/providers/src/aws/v00.00.00000/services/medialive.yaml +++ b/providers/src/aws/v00.00.00000/services/medialive.yaml @@ -4144,6 +4144,9 @@ components: Username: $ref: "#/components/schemas/__string" description: username for destination + VirtualSourceAddress: + $ref: "#/components/schemas/__string" + description: Specifies the source IP address for outbound multicast packets. __listOfSrtOutputDestinationSettings: description: Placeholder documentation for __listOfSrtOutputDestinationSettings type: array @@ -4303,19 +4306,27 @@ components: properties: Algorithm: $ref: "#/components/schemas/AudioNormalizationAlgorithm" - description: Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. + description: "Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1." AlgorithmControl: $ref: "#/components/schemas/AudioNormalizationAlgorithmControl" description: When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. TargetLkfs: $ref: "#/components/schemas/__doubleMinNegative59Max0" description: Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act recommends a target of -24 LKFS. The EBU R-128 specification recommends a target of -23 LKFS. + PeakCalculation: + $ref: "#/components/schemas/AudioNormalizationPeakCalculation" + description: If set to TRUE_PEAK, calculate the TruePeak for each output's audio track loudness. + PeakLimiterThreshold: + $ref: "#/components/schemas/__doubleMinNegative8Max0" + description: Peak limiter threshold in decibels relative to true peak (dBTP) if TRUE_PEAK is enabled. If TRUE_PEAK is not enabled a full scale (dbFS) value is used. The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Leave blank to use the default value 0. AudioNormalizationAlgorithm: description: Audio Normalization Algorithm type: string enum: - ITU_1770_1 - ITU_1770_2 + - ITU_1770_3 + - ITU_1770_4 AudioNormalizationAlgorithmControl: description: Audio Normalization Algorithm Control type: string @@ -4325,6 +4336,16 @@ components: description: Placeholder documentation for __doubleMinNegative59Max0 type: number format: double + AudioNormalizationPeakCalculation: + description: Audio Normalization Peak Calculation + type: string + enum: + - NONE + - TRUE_PEAK + __doubleMinNegative8Max0: + description: Placeholder documentation for __doubleMinNegative8Max0 + type: number + format: double AudioType: description: Audio Type type: string @@ -4359,6 +4380,9 @@ components: NielsenNaesIiNwSettings: $ref: "#/components/schemas/NielsenNaesIiNw" description: Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). + NielsenNwOnlySettings: + $ref: "#/components/schemas/NielsenNwOnly" + description: Complete these fields only if you want to insert watermarks of type Nielsen NAES VI (NW) only, without inserting NAES II (N2) watermarks. NielsenCBET: description: Nielsen CBET type: object @@ -4428,6 +4452,22 @@ components: - US_PACIFIC - US_SAMOA - UTC + NielsenNwOnly: + description: Nielsen Nw Only + type: object + properties: + CheckDigitString: + $ref: "#/components/schemas/__stringMin2Max2" + description: Enter the check digit string for the watermark + Sid: + $ref: "#/components/schemas/__doubleMin1Max65535" + description: Enter the Nielsen Source ID (SID) to include in the watermark + Timezone: + $ref: "#/components/schemas/NielsenWatermarkTimezones" + description: Choose the timezone for the time stamps in the watermark. If not provided, the timestamps will be in Coordinated Universal Time (UTC) + required: + - CheckDigitString + - Sid AudioCodecSettings: description: Audio Codec Settings type: object @@ -6344,7 +6384,7 @@ components: description: If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. Scte35Type: $ref: "#/components/schemas/Scte35Type" - description: Type of scte35 track to add. none or scte35WithoutSegmentation + description: SCTE-35 insertion type. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "scte35WithoutSegmentation" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame so that a downstream re-packager might split the segment there, but MediaLive itself will not introduce a new segment boundary there. SegmentLength: $ref: "#/components/schemas/__integerMin1" description: The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units. @@ -6387,6 +6427,7 @@ components: enum: - NONE - SCTE_35_WITHOUT_SEGMENTATION + - SCTE_35_WITHOUT_IDR CmafIngestSegmentLengthUnits: description: Cmaf Ingest Segment Length Units type: string @@ -6657,7 +6698,7 @@ components: description: If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. Scte35Type: $ref: "#/components/schemas/Scte35Type" - description: Type of scte35 track to add. none or scte35WithoutSegmentation + description: SCTE-35 insertion type. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "scte35WithoutSegmentation" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame so that a downstream re-packager might split the segment there, but MediaLive itself will not introduce a new segment boundary there. SegmentLength: $ref: "#/components/schemas/__integerMin1" description: The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units. @@ -6952,7 +6993,7 @@ components: description: Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). Scte35Control: $ref: "#/components/schemas/M2tsScte35Control" - description: Optionally pass SCTE-35 signals from the input source to this output. + description: SCTE-35 control. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "passthrough" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame, and MediaLive itself will introduce a new segment boundary there. Scte35Pid: $ref: "#/components/schemas/__string" description: Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). @@ -7151,6 +7192,7 @@ components: enum: - NONE - PASSTHROUGH + - SCTE_35_WITHOUT_IDR M2tsSegmentationMarkers: description: M2ts Segmentation Markers type: string @@ -7499,7 +7541,7 @@ components: description: Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. Scte35Control: $ref: "#/components/schemas/M2tsScte35Control" - description: Optionally pass SCTE-35 signals from the input source to this output. + description: SCTE-35 control. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "passthrough" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame, and MediaLive itself will introduce a new segment boundary there. Scte35PrerollPullupMilliseconds: $ref: "#/components/schemas/__doubleMin0Max5000" description: Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount. @@ -7696,6 +7738,12 @@ components: Width: $ref: "#/components/schemas/__integer" description: Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. + CropRectangle: + $ref: "#/components/schemas/VideoPositionRectangle" + description: "Region of the input video to crop before scaling. If not specified, the entire input frame is used. Note: Unlike {@link outputPositionRectangle}, the bounds of cropRectangle are validated at ingest time by the encoder/scaler rather than at the API level, because the input resolution is not known until the source is probed. Field-level constraints on (x, y, width, height) defined on {@link VideoPositionRectangle} still apply." + OutputPositionRectangle: + $ref: "#/components/schemas/VideoPositionRectangle" + description: Position of the encoded video within the output frame. The area outside the rectangle is filled with black. If not specified, the video fills the entire output frame. When used, both {@link width} and {@link height} of the VideoDescription must be explicitly specified so that the rectangle can be validated against the output frame. required: - Name VideoCodecSettings: @@ -8830,6 +8878,33 @@ components: - DEFAULT - STRETCH_TO_OUTPUT - SMART_CROP + VideoPositionRectangle: + description: A rectangle defined by position (x, y) and dimensions (width, height) in pixels. Used for output positioning and input cropping. + type: object + properties: + Height: + $ref: "#/components/schemas/__integerMin2Max8192" + description: Height in pixels. Must be an even number. + Width: + $ref: "#/components/schemas/__integerMin2Max8192" + description: Width in pixels. Must be an even number. + X: + $ref: "#/components/schemas/__integerMin0Max8190" + description: Left offset in pixels. Must be an even number. + "Y": + $ref: "#/components/schemas/__integerMin0Max8190" + description: Top offset in pixels. Must be an even number. + required: + - X + - "Y" + - Height + - Width + __integerMin2Max8192: + description: Placeholder documentation for __integerMin2Max8192 + type: integer + __integerMin0Max8190: + description: Placeholder documentation for __integerMin0Max8190 + type: integer ThumbnailConfiguration: description: Thumbnail Configuration type: object @@ -9097,37 +9172,34 @@ components: Pid: $ref: "#/components/schemas/__integerMin0Max8191" description: Selects a specific PID from within a source. + Pids: + $ref: "#/components/schemas/__listOfAudioPid" + description: Selects one or more unique PIDs from within a source. When using 'pids', you can specify per-PID audio pre-mixer settings. required: - Pid __integerMin0Max8191: description: Placeholder documentation for __integerMin0Max8191 type: integer - AudioTrackSelection: - description: Audio Track Selection - type: object - properties: - Tracks: - $ref: "#/components/schemas/__listOfAudioTrack" - description: Selects one or more unique audio tracks from within a source. - DolbyEDecode: - $ref: "#/components/schemas/AudioDolbyEDecode" - description: Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337 - required: - - Tracks - __listOfAudioTrack: - description: Placeholder documentation for __listOfAudioTrack + __listOfAudioPid: + description: Placeholder documentation for __listOfAudioPid type: array items: - $ref: "#/components/schemas/AudioTrack" - AudioTrack: - description: Audio Track + $ref: "#/components/schemas/AudioPid" + AudioPid: + description: Represents a single PID value for audio selection with optional pre-mixer settings type: object properties: - Track: - $ref: "#/components/schemas/__integerMin1" - description: 1-based integer value that maps to a specific audio track + DolbyEDecode: + $ref: "#/components/schemas/AudioDolbyEDecode" + description: Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337. When using the 'pids' array, if this field is not specified and Dolby E content is present, the decoder will extract the specified program. To maintain legacy behavior (allPrograms), explicitly set programSelection to "allChannels". + Pid: + $ref: "#/components/schemas/__integerMin0Max8191" + description: PID value from within a source. + PremixSettings: + $ref: "#/components/schemas/AudioPreMixerSettings" + description: Optional audio pre-mixer settings for this PID. When specified, allows per-PID audio processing including channel remixing, gain adjustment, and loudness normalization before interleaving. required: - - Track + - Pid AudioDolbyEDecode: description: Audio Dolby EDecode type: object @@ -9150,6 +9222,55 @@ components: - PROGRAM_6 - PROGRAM_7 - PROGRAM_8 + AudioPreMixerSettings: + description: Audio pre-mixer settings for normalizing audio before interleaving. These settings can be applied to individual PIDs or tracks before they are combined. + type: object + properties: + AudioNormalizationSettings: + $ref: "#/components/schemas/AudioNormalizationSettings" + description: Audio normalization settings for loudness control. When specified, audio loudness will be normalized according to the chosen algorithm. + Channels: + $ref: "#/components/schemas/__integerMin1Max16" + description: Number of audio channels. If specified, the audio will be remixed to match this channel count. Ignored if remixSettings is specified. + GainDb: + $ref: "#/components/schemas/__doubleMinNegative60Max60" + description: "Gain adjustment in dB to apply. Range: -60 to +60 dB" + RemixSettings: + $ref: "#/components/schemas/RemixSettings" + description: Settings that control how input audio channels are remixed. When specified, allows fine-grained control over channel mapping and gain levels. Takes precedence over the 'channels' setting. + __doubleMinNegative60Max60: + description: Placeholder documentation for __doubleMinNegative60Max60 + type: number + format: double + AudioTrackSelection: + description: Audio Track Selection + type: object + properties: + Tracks: + $ref: "#/components/schemas/__listOfAudioTrack" + description: Selects one or more unique audio tracks from within a source. + DolbyEDecode: + $ref: "#/components/schemas/AudioDolbyEDecode" + description: Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337 + required: + - Tracks + __listOfAudioTrack: + description: Placeholder documentation for __listOfAudioTrack + type: array + items: + $ref: "#/components/schemas/AudioTrack" + AudioTrack: + description: Represents a single audio track for selection with optional pre-mixer settings + type: object + properties: + Track: + $ref: "#/components/schemas/__integerMin1" + description: 1-based integer value that maps to a specific audio track + PremixSettings: + $ref: "#/components/schemas/AudioPreMixerSettings" + description: Optional audio pre-mixer settings for this track. When specified, allows per-track audio processing including channel remixing, gain adjustment, and loudness normalization before interleaving. + required: + - Track __listOfCaptionSelector: description: Placeholder documentation for __listOfCaptionSelector type: array @@ -9188,6 +9309,8 @@ components: $ref: "#/components/schemas/Scte27SourceSettings" TeletextSourceSettings: $ref: "#/components/schemas/TeletextSourceSettings" + SmartSubtitleSourceSettings: + $ref: "#/components/schemas/SmartSubtitleSourceSettings" AncillarySourceSettings: description: Ancillary Source Settings type: object @@ -9320,6 +9443,22 @@ components: description: Placeholder documentation for __doubleMin0Max100 type: number format: double + SmartSubtitleSourceSettings: + description: Smart Subtitle Source Settings + type: object + properties: + CaptionSynchronizationMode: + $ref: "#/components/schemas/CaptionSynchronizationMode" + description: Controls whether MediaLive delays video to synchronize captions with audio and video output. + InferenceFeedOutput: + $ref: "#/components/schemas/__string" + description: The name of the Elemental Inference feed output that supplies subtitle input into this caption selector. + CaptionSynchronizationMode: + description: Controls how MediaLive synchronizes Elemental Inference generated subtitles with video output. video_aligned_captions - MediaLive delays video to ensure captions are synchronized with audio and video. no_video_delay - MediaLive does not delay video for caption alignment. Captions output timing is adjusted to align with video as captions become available. + type: string + enum: + - NO_VIDEO_DELAY + - VIDEO_ALIGNED_CAPTIONS InputDeblockFilter: description: Input Deblock Filter type: string @@ -9608,6 +9747,24 @@ components: FeedArn: $ref: "#/components/schemas/__string" description: The ARN of the feed resource that is associated with this channel. The feed is a resource in the Elemental Inference service. + AudioFeedInputs: + $ref: "#/components/schemas/__listOfAudioFeedInput" + description: A list of audio feed inputs that map audio selectors in the channel to feed inputs on the associated Elemental Inference feed. + __listOfAudioFeedInput: + description: Placeholder documentation for __listOfAudioFeedInput + type: array + items: + $ref: "#/components/schemas/AudioFeedInput" + AudioFeedInput: + description: Maps an audio selector in the channel to a feed input on the associated Elemental Inference feed. + type: object + properties: + AudioSelectorName: + $ref: "#/components/schemas/__string" + description: The name of the audio selector in the channel that will be sent to the Elemental Inference feed input. + FeedInput: + $ref: "#/components/schemas/__string" + description: The name of the feed input on the Elemental Inference feed that will receive the audio from the specified audio selector. CreateChannelResponse: description: Placeholder documentation for CreateChannelResponse type: object @@ -9835,6 +9992,9 @@ components: FeedArn: $ref: "#/components/schemas/__string" description: The ARN of the feed resource that is associated with this channel. The feed is a resource in the Elemental Inference service. + AudioFeedInputs: + $ref: "#/components/schemas/__listOfAudioFeedInput" + description: A list of audio feed inputs that map audio selectors in the channel to feed inputs on the associated Elemental Inference feed. CreateChannelPlacementGroupResponse: description: Placeholder documentation for CreateChannelPlacementGroupResponse type: object diff --git a/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml b/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml index 80e9f19c..22231303 100644 --- a/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml +++ b/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml @@ -127,6 +127,8 @@ paths: $ref: "#/components/schemas/InputSwitchConfiguration" OutputHeaderConfiguration: $ref: "#/components/schemas/OutputHeaderConfiguration" + OutputLockingMode: + $ref: "#/components/schemas/OutputLockingMode" Tags: $ref: "#/components/schemas/TagMap" required: @@ -333,6 +335,8 @@ paths: $ref: "#/components/schemas/ForceEndpointErrorConfiguration" UriSeparator: $ref: "#/components/schemas/UriSeparator" + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" Tags: $ref: "#/components/schemas/TagMap" required: @@ -729,6 +733,8 @@ paths: $ref: "#/components/schemas/ForceEndpointErrorConfiguration" UriSeparator: $ref: "#/components/schemas/UriSeparator" + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" required: - ContainerType responses: @@ -1092,6 +1098,11 @@ components: PublishMQCS: $ref: "#/components/schemas/Boolean" description: When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF. + OutputLockingMode: + type: string + enum: + - EPOCH_LOCKED + - NON_EPOCH_LOCKED TagMap: type: object properties: {} @@ -1134,6 +1145,9 @@ components: OutputHeaderConfiguration: $ref: "#/components/schemas/OutputHeaderConfiguration" description: The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF. + OutputLockingMode: + $ref: "#/components/schemas/OutputLockingMode" + description: "The output locking mode configured for the channel. The allowed values are: EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0." required: - Arn - ChannelName @@ -1390,6 +1404,9 @@ components: description: The SCTE configuration options in the segment settings. Encryption: $ref: "#/components/schemas/Encryption" + OutputTimestampMode: + $ref: "#/components/schemas/OutputTimestampMode" + description: "The output timestamp mode for the origin endpoint's segments. This setting is only configurable on channels with OutputLockingMode set to NON_EPOCH_LOCKED. This value is immutable after endpoint creation. If you don't specify a value, the default is PASSTHROUGH. The allowed values are: PASSTHROUGH - Output PTS (Presentation Timestamp) values pass through unchanged from the input. REBASED_TO_CHANNEL_START - Output PTS is rebased relative to the channel start time." SegmentSegmentDurationSecondsInteger: type: integer minimum: 1 @@ -1436,6 +1453,8 @@ components: - DISTRIBUTOR_PROMO - PROVIDER_AD_BLOCK - DISTRIBUTOR_AD_BLOCK + - CONTENT_IDENTIFICATION + - CALL_AD_SERVER ScteInSegments: type: string enum: @@ -1604,6 +1623,11 @@ components: minLength: 20 maxLength: 2048 pattern: arn:([^:\n]+):acm:([^:\n]+):([0-9]+):certificate/[a-zA-Z0-9-_]+ + OutputTimestampMode: + type: string + enum: + - PASSTHROUGH + - REBASED_TO_CHANNEL_START CreateOriginEndpointRequestStartoverWindowSecondsInteger: type: integer minimum: 0 @@ -1824,6 +1848,9 @@ components: Compactness: $ref: "#/components/schemas/DashCompactness" description: The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest. For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide. + AudioTimelinePattern: + $ref: "#/components/schemas/DashAudioTimelinePattern" + description: "How MediaPackage represents the audio timeline in the DASH manifest. This setting applies DASH Segment Duration Patternization, as defined in the MPEG-DASH specification, to audio adaptation sets. When set to PATTERNED, MediaPackage uses a pattern-based segment template for audio, which reduces manifest size by expressing repeating segment durations as a pattern instead of listing each segment individually. When set to NONE, the manifest contains an explicit timeline that lists each audio segment. Valid values: NONE | PATTERNED For information about audio timeline patterns, see DASH audio timeline pattern in the Elemental MediaPackage v2 User Guide." SubtitleConfiguration: $ref: "#/components/schemas/DashSubtitleConfiguration" description: The configuration for DASH subtitles. @@ -2058,6 +2085,11 @@ components: enum: - STANDARD - NONE + DashAudioTimelinePattern: + type: string + enum: + - NONE + - PATTERNED DashSubtitleConfiguration: description: The configuration for DASH subtitles. type: object @@ -2141,6 +2173,11 @@ components: enum: - UNDERSCORE - HYPHEN + StreamNameOutputMode: + type: string + enum: + - INDEX + - PASSTHROUGH_NAME CreateOriginEndpointResponse: type: object properties: @@ -2192,6 +2229,9 @@ components: UriSeparator: $ref: "#/components/schemas/UriSeparator" description: The separator character used in generated URIs for this origin endpoint. + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" + description: The output mode for stream names in egress manifests for this origin endpoint. ETag: $ref: "#/components/schemas/EntityTag" description: The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. @@ -2344,6 +2384,9 @@ components: Compactness: $ref: "#/components/schemas/DashCompactness" description: The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest. + AudioTimelinePattern: + $ref: "#/components/schemas/DashAudioTimelinePattern" + description: How MediaPackage represents the audio timeline in the DASH manifest, using DASH Segment Duration Patternization for audio adaptation sets. PATTERNED indicates that MediaPackage uses a pattern-based segment template for audio, reducing manifest size. NONE indicates that the manifest contains an explicit timeline for each audio segment. SubtitleConfiguration: $ref: "#/components/schemas/DashSubtitleConfiguration" description: The configuration for DASH subtitles. @@ -2433,6 +2476,9 @@ components: OutputHeaderConfiguration: $ref: "#/components/schemas/OutputHeaderConfiguration" description: The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF. + OutputLockingMode: + $ref: "#/components/schemas/OutputLockingMode" + description: "The output locking mode configured for the channel. The allowed values are: EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0." required: - Arn - ChannelName @@ -2608,6 +2654,9 @@ components: UriSeparator: $ref: "#/components/schemas/UriSeparator" description: The separator character used in generated URIs for this origin endpoint. + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" + description: The output mode for stream names in egress manifests for this origin endpoint. ETag: $ref: "#/components/schemas/EntityTag" description: The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. @@ -2751,6 +2800,9 @@ components: InputType: $ref: "#/components/schemas/InputType" description: "The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments). CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests)." + OutputLockingMode: + $ref: "#/components/schemas/OutputLockingMode" + description: "The output locking mode configured for the channel. The allowed values are: EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0." required: - Arn - ChannelName @@ -2902,6 +2954,9 @@ components: UriSeparator: $ref: "#/components/schemas/UriSeparator" description: The separator character used in generated URIs for this origin endpoint. + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" + description: The output mode for stream names in egress manifests for this origin endpoint. required: - Arn - ChannelGroupName @@ -3080,6 +3135,9 @@ components: OutputHeaderConfiguration: $ref: "#/components/schemas/OutputHeaderConfiguration" description: The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF. + OutputLockingMode: + $ref: "#/components/schemas/OutputLockingMode" + description: "The output locking mode configured for the channel. This value is immutable after channel creation. The allowed values are: EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0." required: - Arn - ChannelName @@ -3172,6 +3230,9 @@ components: UriSeparator: $ref: "#/components/schemas/UriSeparator" description: The separator character used in generated URIs for this origin endpoint. + StreamNameOutputMode: + $ref: "#/components/schemas/StreamNameOutputMode" + description: The output mode for stream names in egress manifests for this origin endpoint. ETag: $ref: "#/components/schemas/EntityTag" description: The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. diff --git a/providers/src/aws/v00.00.00000/services/mediatailor.yaml b/providers/src/aws/v00.00.00000/services/mediatailor.yaml index 6849a036..a5f73e30 100644 --- a/providers/src/aws/v00.00.00000/services/mediatailor.yaml +++ b/providers/src/aws/v00.00.00000/services/mediatailor.yaml @@ -862,6 +862,8 @@ paths: $ref: "#/components/schemas/HttpRequestConfiguration" CustomOutputConfiguration: $ref: "#/components/schemas/CustomOutputConfiguration" + ConcurrentExecutorConfiguration: + $ref: "#/components/schemas/ConcurrentExecutorConfiguration" SequentialExecutorConfiguration: $ref: "#/components/schemas/SequentialExecutorConfiguration" Tags: @@ -1278,6 +1280,10 @@ paths: $ref: "#/components/schemas/AdDecisionServerConfiguration" FunctionMapping: $ref: "#/components/schemas/FunctionMapping" + AdsPersonalizationTimeouts: + $ref: "#/components/schemas/AdsPersonalizationTimeouts" + AdsPersonalizationConcurrency: + $ref: "#/components/schemas/AdsPersonalizationConcurrency" responses: "200": description: Success @@ -1711,7 +1717,10 @@ components: description: The name of the manifest for the channel that will appear in the channel output's playback URL. PlaybackUrl: $ref: "#/components/schemas/__string" - description: The URL used for playback by content players. + description: The URL that your player uses for playback. + DualStackPlaybackUrl: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that your player uses for playback. SourceGroup: $ref: "#/components/schemas/__string" description: A string used to associate a package configuration source group with a channel output. @@ -2623,6 +2632,9 @@ components: CustomOutputConfiguration: $ref: "#/components/schemas/CustomOutputConfiguration" description: The configuration for a CUSTOM_OUTPUT function. + ConcurrentExecutorConfiguration: + $ref: "#/components/schemas/ConcurrentExecutorConfiguration" + description: The configuration for a CONCURRENT_EXECUTOR function. SequentialExecutorConfiguration: $ref: "#/components/schemas/SequentialExecutorConfiguration" description: The configuration for a SEQUENTIAL_EXECUTOR function. @@ -2642,9 +2654,10 @@ components: enum: - HTTP_REQUEST - CUSTOM_OUTPUT + - CONCURRENT_EXECUTOR - SEQUENTIAL_EXECUTOR HttpRequestConfiguration: - description: -- Function Configuration DataStructure + description: The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for the request. For more information, see HTTP_REQUEST in the MediaTailor User Guide. type: object properties: Runtime: @@ -2697,8 +2710,8 @@ components: description: A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.variant), and each value is an expression that MediaTailor evaluates at runtime against the current session state. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide. required: - Runtime - SequentialExecutorConfiguration: - description: The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see SEQUENTIAL_EXECUTOR in the MediaTailor User Guide. + ConcurrentExecutorConfiguration: + description: The configuration for a CONCURRENT_EXECUTOR function. A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions in the MediaTailor User Guide. type: object properties: Runtime: @@ -2707,17 +2720,22 @@ components: Output: type: object properties: {} - description: An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps. + description: A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions. FunctionList: $ref: "#/components/schemas/__listOfFunctionsRef" - description: An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data. + description: The list of child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs. TimeoutMilliseconds: $ref: "#/components/schemas/__integer" - description: The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior. + description: The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior. + MaxConcurrency: + $ref: "#/components/schemas/__integer" + description: The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time. required: - Runtime + - Output - FunctionList - TimeoutMilliseconds + - MaxConcurrency __listOfFunctionsRef: type: array items: @@ -2732,6 +2750,30 @@ components: FunctionId: $ref: "#/components/schemas/__string" description: The identifier of the child function to execute in this step. + Alias: + $ref: "#/components/schemas/__string" + description: An optional alternate name for the function within the executor. If omitted, MediaTailor uses the function identifier. + SequentialExecutorConfiguration: + description: The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see SEQUENTIAL_EXECUTOR in the MediaTailor User Guide. + type: object + properties: + Runtime: + $ref: "#/components/schemas/RuntimeType" + description: The expression language used to evaluate expressions in the function configuration. Set this to JSONata. + Output: + type: object + properties: {} + description: An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps. + FunctionList: + $ref: "#/components/schemas/__listOfFunctionsRef" + description: An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data. + TimeoutMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior. + required: + - Runtime + - FunctionList + - TimeoutMilliseconds GetPlaybackConfigurationResponse: type: object properties: @@ -2780,10 +2822,16 @@ components: description: The Amazon Resource Name (ARN) for the playback configuration. PlaybackEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. + description: The URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting. + DualStackPlaybackEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting. SessionInitializationEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL that the player uses to initialize a session that uses client-side reporting. + description: The URL that your player uses to initialize a session that uses client-side reporting. + DualStackSessionInitializationEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting. SlateAdUrl: $ref: "#/components/schemas/__string" description: The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. @@ -2807,6 +2855,12 @@ components: type: object properties: {} description: A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide. + AdsPersonalizationTimeouts: + $ref: "#/components/schemas/AdsPersonalizationTimeouts" + description: The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows. + AdsPersonalizationConcurrency: + $ref: "#/components/schemas/AdsPersonalizationConcurrency" + description: The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request. AvailSuppression: description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression. type: object @@ -2857,7 +2911,10 @@ components: properties: ManifestEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations. + description: The URL that MediaTailor generates to initiate a playback session. The session uses server-side reporting. + DualStackManifestEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that MediaTailor generates to initiate a playback session. The session uses server-side reporting. MpdLocation: $ref: "#/components/schemas/__string" description: The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. @@ -2875,7 +2932,10 @@ components: properties: ManifestEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. + description: The URL that MediaTailor generates to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. + DualStackManifestEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that MediaTailor generates to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. InsertionMode: description: Insertion Mode controls whether players can use stitched or guided ad insertion. type: string @@ -2892,6 +2952,28 @@ components: MaxDurationSeconds: $ref: "#/components/schemas/__integer" description: The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns. + AdDecisionServerConfiguration: + $ref: "#/components/schemas/PreRollAdDecisionServerConfiguration" + description: The configuration for the ad decision server (ADS) for live pre-roll ads. The configuration contains settings that control how MediaTailor processes VAST responses for pre-roll ad breaks. + PreRollAdDecisionServerConfiguration: + description: The ad decision server configuration for live pre-roll ads. It contains settings that control how MediaTailor processes VAST responses for pre-roll ad breaks. + type: object + properties: + VastResponse: + $ref: "#/components/schemas/PreRollVastResponse" + description: The settings that control how MediaTailor processes VAST responses for live pre-roll ad breaks. + PreRollVastResponse: + description: The settings that control how MediaTailor processes VAST responses from the ad decision server for live pre-roll ad breaks. + type: object + properties: + AdSequencingMode: + $ref: "#/components/schemas/PreRollAdSequencingMode" + description: The ad sequencing mode for live pre-roll ads. FOLLOW_AD_SEQUENCE inserts sequenced ads in increasing order and uses standalone ads only as replacements when a sequenced ad fails. IGNORE_AD_SEQUENCE inserts ads in the order they appear in the VAST response, regardless of sequence attributes. The default behavior is IGNORE_AD_SEQUENCE. + PreRollAdSequencingMode: + type: string + enum: + - FOLLOW_AD_SEQUENCE + - IGNORE_AD_SEQUENCE LogConfiguration: description: Defines where AWS Elemental MediaTailor sends logs for the playback configuration. type: object @@ -2951,6 +3033,9 @@ components: HttpRequest: $ref: "#/components/schemas/HttpRequest" description: The HTTP request configuration parameters for the ad decision server. + VastResponse: + $ref: "#/components/schemas/VastResponse" + description: The settings that control how MediaTailor processes VAST responses from the ad decision server. HttpRequest: description: HTTP request configuration parameters that define how MediaTailor communicates with the ad decision server. type: object @@ -2978,6 +3063,49 @@ components: enum: - NONE - GZIP + VastResponse: + description: The settings that control how MediaTailor processes VAST responses from the ad decision server. + type: object + properties: + AdSequencingMode: + $ref: "#/components/schemas/AdSequencingMode" + description: The ad sequencing mode that controls how MediaTailor handles sequenced and standalone ads in VAST responses. FOLLOW_AD_SEQUENCE inserts sequenced ads in increasing order for both live and VOD workflows, using standalone ads only as replacements when a sequenced ad fails. FOLLOW_AD_SEQUENCE_ONLY_LIVE enables ad sequencing for live workflows only. FOLLOW_AD_SEQUENCE_ONLY_VOD enables ad sequencing for VOD workflows only. IGNORE_AD_SEQUENCE inserts ads in the order they appear in the VAST response, regardless of sequence attributes. The default behavior is IGNORE_AD_SEQUENCE. + AdSequencingMode: + type: string + enum: + - FOLLOW_AD_SEQUENCE + - IGNORE_AD_SEQUENCE + - FOLLOW_AD_SEQUENCE_ONLY_LIVE + - FOLLOW_AD_SEQUENCE_ONLY_VOD + AdsPersonalizationTimeouts: + description: The timeout settings for ad decision server interactions during ad personalization. + type: object + properties: + AdsRequestTimeoutMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum time, in milliseconds, that MediaTailor waits for a single ad decision server response during live or VOD playback. The default is 3000. + LiveMaximumAdsPersonalizationTimeMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity for live manifests, including making requests, waiting for responses, and following VAST wrapper redirects. The default is 10000. + VodMaximumAdsPersonalizationTimeMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity for VOD manifests, including making requests, waiting for responses, and following VAST wrapper redirects. The default is 10000. + PrefetchAdsRequestTimeoutMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum time, in milliseconds, that MediaTailor waits for a single ad decision server response during prefetch retrieval. If not set, the value of AdsRequestTimeoutMilliseconds is used. + PrefetchMaximumAdsPersonalizationTimeMilliseconds: + $ref: "#/components/schemas/__integer" + description: The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity during prefetch retrieval, including making requests, waiting for responses, and following VAST wrapper redirects. + AdsPersonalizationConcurrency: + description: The concurrency settings for ad decision server interactions during ad personalization. + type: object + properties: + MaxConcurrentAdsRequests: + $ref: "#/components/schemas/__integer" + description: The maximum number of simultaneous requests that MediaTailor makes to the ad decision server per manifest request. The default is 1. + EnableVodVastParallelization: + $ref: "#/components/schemas/__boolean" + description: Enables parallel processing of ad decision server requests in VOD workflows when the ADS returns VAST responses. The default is false. GetPrefetchScheduleResponse: type: object properties: @@ -3136,7 +3264,7 @@ components: items: $ref: "#/components/schemas/Function" Function: - description: -- Define Mixin -- + description: Defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. The FunctionType determines the function's runtime behavior. For more information about functions, see Working with functions in the MediaTailor User Guide. type: object properties: FunctionId: @@ -3154,6 +3282,9 @@ components: CustomOutputConfiguration: $ref: "#/components/schemas/CustomOutputConfiguration" description: The configuration for a CUSTOM_OUTPUT function. + ConcurrentExecutorConfiguration: + $ref: "#/components/schemas/ConcurrentExecutorConfiguration" + description: The configuration for a CONCURRENT_EXECUTOR function. SequentialExecutorConfiguration: $ref: "#/components/schemas/SequentialExecutorConfiguration" description: The configuration for a SEQUENTIAL_EXECUTOR function. @@ -3273,10 +3404,16 @@ components: description: The Amazon Resource Name (ARN) for the playback configuration. PlaybackEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. + description: The URL that your player accesses to get a manifest from AWS Elemental MediaTailor. + DualStackPlaybackEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor. SessionInitializationEndpointPrefix: $ref: "#/components/schemas/__string" - description: The URL that the player uses to initialize a session that uses client-side reporting. + description: The URL that your player uses to initialize a session that uses client-side reporting. + DualStackSessionInitializationEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting. SlateAdUrl: $ref: "#/components/schemas/__string" description: The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. @@ -3299,6 +3436,12 @@ components: type: object properties: {} description: A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide. + AdsPersonalizationTimeouts: + $ref: "#/components/schemas/AdsPersonalizationTimeouts" + description: The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows. + AdsPersonalizationConcurrency: + $ref: "#/components/schemas/AdsPersonalizationConcurrency" + description: The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request. __integerMin1Max100: type: integer minimum: 1 @@ -3479,6 +3622,9 @@ components: CustomOutputConfiguration: $ref: "#/components/schemas/CustomOutputConfiguration" description: The configuration for a CUSTOM_OUTPUT function. + ConcurrentExecutorConfiguration: + $ref: "#/components/schemas/ConcurrentExecutorConfiguration" + description: The configuration for a CONCURRENT_EXECUTOR function. SequentialExecutorConfiguration: $ref: "#/components/schemas/SequentialExecutorConfiguration" description: The configuration for a SEQUENTIAL_EXECUTOR function. @@ -3558,9 +3704,15 @@ components: PlaybackEndpointPrefix: $ref: "#/components/schemas/__string" description: The playback endpoint prefix associated with the playback configuration. + DualStackPlaybackEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) playback endpoint prefix associated with the playback configuration. SessionInitializationEndpointPrefix: $ref: "#/components/schemas/__string" description: The session initialization endpoint prefix associated with the playback configuration. + DualStackSessionInitializationEndpointPrefix: + $ref: "#/components/schemas/__string" + description: The dual-stack (IPv4 and IPv6) session initialization endpoint prefix associated with the playback configuration. SlateAdUrl: $ref: "#/components/schemas/__string" description: The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. @@ -3584,6 +3736,12 @@ components: type: object properties: {} description: A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide. + AdsPersonalizationTimeouts: + $ref: "#/components/schemas/AdsPersonalizationTimeouts" + description: The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows. + AdsPersonalizationConcurrency: + $ref: "#/components/schemas/AdsPersonalizationConcurrency" + description: The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request. StartChannelResponse: type: object StopChannelResponse: diff --git a/providers/src/aws/v00.00.00000/services/meteringmarketplace.yaml b/providers/src/aws/v00.00.00000/services/meteringmarketplace.yaml index 9bc225a4..ae9aa14f 100644 --- a/providers/src/aws/v00.00.00000/services/meteringmarketplace.yaml +++ b/providers/src/aws/v00.00.00000/services/meteringmarketplace.yaml @@ -21,7 +21,7 @@ paths: /BatchMeterUsage: post: operationId: BatchMeterUsage - description: Amazon Web Services Marketplace is introducing Concurrent Agreements, enabling buyers to make multiple purchases per Amazon Web Services account. Starting June 1, 2026, new SaaS products must use CustomerAWSAccountId (instead of CustomerIdentifier), LicenseArn (instead of ProductCode) to support this feature. Existing integrations will continue to work. Review the new integration for Concurrent Agreements here. To post metering records for customers, SaaS applications call BatchMeterUsage, which is used for metering SaaS flexible consumption pricing (FCP). Identical requests are idempotent and can be retried with the same records or a subset of records. Each BatchMeterUsage request is for only one product. If you want to meter usage for multiple products, you must make multiple BatchMeterUsage calls. Usage records should be submitted in quick succession following a recorded event. Usage records aren't accepted 6 hours or more after an event. BatchMeterUsage can process up to 25 UsageRecords at a time, and each request must be less than 1 MB in size. Optionally, you can have multiple usage allocations for usage data that's split into buckets according to predefined tags. BatchMeterUsage returns a list of UsageRecordResult objects, which have each UsageRecord. It also returns a list of UnprocessedRecords, which indicate errors on the service side that should be retried. For Amazon Web Services Regions that support BatchMeterUsage, see BatchMeterUsage Region support. For an example of BatchMeterUsage, see BatchMeterUsage code example in the Amazon Web Services Marketplace Seller Guide. + description: Amazon Web Services Marketplace is introducing Concurrent Agreements, enabling buyers to make multiple purchases per Amazon Web Services account. Starting June 1, 2026, new SaaS products must use CustomerAWSAccountId (instead of CustomerIdentifier), LicenseArn (instead of ProductCode) to support this feature. BatchMeterUsage does not support CustomerIdentifier for new integrations. Existing integrations continue to work. Review the new integration for Concurrent Agreements here. To post metering records for customers, SaaS applications call BatchMeterUsage, which is used for metering SaaS flexible consumption pricing (FCP). Identical requests are idempotent and can be retried with the same records or a subset of records. Each BatchMeterUsage request is for only one product. If you want to meter usage for multiple products, you must make multiple BatchMeterUsage calls. Usage records should be submitted in quick succession following a recorded event. Usage records aren't accepted 24 hours or more after an event. At the end of each billing cycle, a 6-hour grace period applies. We accept usage records for the previous billing month until 06:00 UTC on the first day of the next month. For example, you must submit March usage records before 06:00 UTC on April 1. After this grace period, we return a TimestampOutOfBoundsException error. BatchMeterUsage can process up to 25 UsageRecords at a time, and each request must be less than 1 MB in size. Optionally, you can have multiple usage allocations for usage data that's split into buckets according to predefined tags. BatchMeterUsage returns a list of UsageRecordResult objects, which have each UsageRecord. It also returns a list of UnprocessedRecords, which indicate errors on the service side that should be retried. For Amazon Web Services Regions that support BatchMeterUsage, see BatchMeterUsage Region support. For an example of BatchMeterUsage, see BatchMeterUsage code example in the Amazon Web Services Marketplace Seller Guide. parameters: - name: X-Amz-Target in: header @@ -150,7 +150,7 @@ paths: /ResolveCustomer: post: operationId: ResolveCustomer - description: ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn. To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using ResolveCustomer, see ResolveCustomer code example in the Amazon Web Services Marketplace Seller Guide. Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the aws-marketplace:ResolveCustomer action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference. For Amazon Web Services Regions that support ResolveCustomer, see ResolveCustomer Region support. + description: ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn. For new SaaS product integrations, the CustomerIdentifier field is not populated in the ResolveCustomer API response. New integrations must use CustomerAWSAccountId and LicenseArn to identify customers. Existing integrations continue to work unchanged. To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using ResolveCustomer, see ResolveCustomer code example in the Amazon Web Services Marketplace Seller Guide. Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the aws-marketplace:ResolveCustomer action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference. For Amazon Web Services Regions that support ResolveCustomer, see ResolveCustomer Region support. parameters: - name: X-Amz-Target in: header @@ -170,7 +170,7 @@ paths: properties: RegistrationToken: $ref: "#/components/schemas/NonEmptyString" - description: When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn. + description: When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn. For new SaaS product integrations, the CustomerIdentifier field is not populated. Use CustomerAWSAccountId and LicenseArn for customer identification. required: - RegistrationToken responses: @@ -235,10 +235,10 @@ components: properties: Timestamp: $ref: "#/components/schemas/Timestamp" - description: Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to six hours in the past. Make sure the timestamp value is not before the start of the software usage. + description: Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to 24 hours in the past. Make sure the timestamp value is not before the start of the software usage. At the end of each billing cycle, you have a 6-hour grace period to submit usage records for the previous billing month before 06:00 UTC on the first day of the next month. CustomerIdentifier: $ref: "#/components/schemas/CustomerIdentifier" - description: The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application. + description: The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application. CustomerIdentifier is not supported for new SaaS product integrations. Use CustomerAWSAccountId to identify the buyer. Dimension: $ref: "#/components/schemas/UsageDimension" description: During the process of registering a product on Amazon Web Services Marketplace, dimensions are specified. These represent different units of value in your application. @@ -406,7 +406,7 @@ components: properties: CustomerIdentifier: $ref: "#/components/schemas/CustomerIdentifier" - description: The CustomerIdentifier is used to identify an individual customer in your application. + description: The CustomerIdentifier is used to identify an individual customer in your application. For new SaaS product integrations, this field is not populated. Use CustomerAWSAccountId and LicenseArn to identify customers instead. ProductCode: $ref: "#/components/schemas/ProductCode" description: The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code. diff --git a/providers/src/aws/v00.00.00000/services/mgn.yaml b/providers/src/aws/v00.00.00000/services/mgn.yaml index 873e1811..da2ca02f 100644 --- a/providers/src/aws/v00.00.00000/services/mgn.yaml +++ b/providers/src/aws/v00.00.00000/services/mgn.yaml @@ -343,6 +343,8 @@ paths: $ref: "#/components/schemas/InternetProtocol" storeSnapshotOnLocalZone: $ref: "#/components/schemas/Boolean" + storageConfiguration: + $ref: "#/components/schemas/StorageConfiguration" required: - stagingAreaSubnetId - associateDefaultSecurityGroup @@ -2643,6 +2645,8 @@ paths: $ref: "#/components/schemas/InternetProtocol" storeSnapshotOnLocalZone: $ref: "#/components/schemas/Boolean" + storageConfiguration: + $ref: "#/components/schemas/StorageConfiguration" required: - sourceServerID responses: @@ -2698,6 +2702,8 @@ paths: $ref: "#/components/schemas/InternetProtocol" storeSnapshotOnLocalZone: $ref: "#/components/schemas/Boolean" + storageConfiguration: + $ref: "#/components/schemas/StorageConfiguration" required: - replicationConfigurationTemplateID responses: @@ -2725,6 +2731,12 @@ paths: $ref: "#/components/schemas/SourceServerID" connectorAction: $ref: "#/components/schemas/SourceServerConnectorAction" + userProvidedID: + $ref: "#/components/schemas/UserProvidedId" + fqdnForActionFramework: + $ref: "#/components/schemas/FqdnForActionFramework" + platform: + $ref: "#/components/schemas/OperatingSystemString" required: - sourceServerID responses: @@ -3101,6 +3113,12 @@ components: firstBoot: $ref: "#/components/schemas/FirstBoot" description: Launched instance first boot. + lastKnownChecks: + $ref: "#/components/schemas/LastKnownChecksList" + description: Launched instance last known checks. + lastKnownFsxChecksStatus: + $ref: "#/components/schemas/LastKnownCheckStatus" + description: Launched instance last known FSx checks status. EC2InstanceID: type: string minLength: 0 @@ -3118,6 +3136,48 @@ components: - SUCCEEDED - UNKNOWN - STOPPED + LastKnownChecksList: + description: List of last known checks. + type: array + items: + $ref: "#/components/schemas/LastKnownCheck" + LastKnownCheck: + description: Last known check performed on a launched instance. + type: object + properties: + type_: + $ref: "#/components/schemas/LastKnownCheckType" + description: Last known check type. + name: + $ref: "#/components/schemas/BoundedString" + description: Last known check name. + status: + $ref: "#/components/schemas/LastKnownCheckStatus" + description: Last known check status. + error: + $ref: "#/components/schemas/BoundedString" + description: Last known check error. + checkedAt: + $ref: "#/components/schemas/Timestamp" + description: Last known check timestamp. + LastKnownCheckType: + type: string + enum: + - EC2 + - FSx + BoundedString: + type: string + minLength: 0 + maxLength: 256 + LastKnownCheckStatus: + type: string + enum: + - PASSED + - FAILED + - PENDING + Timestamp: + type: string + format: date-time DataReplicationInfo: description: Request data replication info. type: object @@ -3173,10 +3233,6 @@ components: backloggedStorageBytes: $ref: "#/components/schemas/PositiveInteger" description: Request to query data replication backlog size in bytes. - BoundedString: - type: string - minLength: 0 - maxLength: 256 DataReplicationState: type: string enum: @@ -3233,6 +3289,7 @@ components: - PAIR_REPLICATION_SERVER_WITH_AGENT - CONNECT_AGENT_TO_REPLICATION_SERVER - START_DATA_TRANSFER + - SETUP_FSX_PROXY DataReplicationInitiationStepStatus: type: string enum: @@ -3270,6 +3327,8 @@ components: - FAILED_TO_START_DATA_TRANSFER - UNSUPPORTED_VM_CONFIGURATION - LAST_SNAPSHOT_JOB_FAILED + - FAILED_TO_SETUP_FSX_PROXY + - FAILED_TO_CREATE_FSX_SNAPSHOT LargeBoundedString: type: string minLength: 0 @@ -3525,7 +3584,7 @@ components: SecretArn: type: string minLength: 20 - maxLength: 100 + maxLength: 256 pattern: arn:[\w-]+:secretsmanager:([a-z]{2}-(gov-)?[a-z]+-\d{1})?:(\d{12})?:secret:(.+) ConnectorArn: type: string @@ -3841,6 +3900,7 @@ components: - CISCO_ACI - LOGICAL_MODEL - MODELIZE_IT + - AWS_DISCOVERY_COLLECTOR SourceS3Configuration: description: S3 configuration for source network data. type: object @@ -3956,9 +4016,6 @@ components: minLength: 21 maxLength: 21 pattern: nmd-[0-9a-zA-Z]{17} - Timestamp: - type: string - format: date-time SubnetID: type: string minLength: 0 @@ -3999,6 +4056,41 @@ components: enum: - IPV4 - IPV6 + StorageConfiguration: + description: Storage configuration for replication. + type: object + properties: + storageType: + $ref: "#/components/schemas/StorageType" + description: Storage configuration storage type. + fsxOntapConfiguration: + $ref: "#/components/schemas/FsxOntapConfiguration" + description: Storage configuration FSx ONTAP configuration. + required: + - storageType + StorageType: + type: string + enum: + - EBS + - FSX_ONTAP + FsxOntapConfiguration: + description: FSx for ONTAP storage configuration. + type: object + properties: + storageVirtualMachineId: + $ref: "#/components/schemas/StorageVirtualMachineId" + description: FSx ONTAP configuration storage virtual machine ID. + credentialsSecretArn: + $ref: "#/components/schemas/SecretArn" + description: FSx ONTAP configuration credentials secret ARN. + required: + - storageVirtualMachineId + - credentialsSecretArn + StorageVirtualMachineId: + type: string + minLength: 21 + maxLength: 21 + pattern: (svm-[0-9a-f]{17,}) ReplicationConfigurationTemplate: type: object properties: @@ -4058,6 +4150,9 @@ components: storeSnapshotOnLocalZone: $ref: "#/components/schemas/Boolean" description: Replication Configuration template store snapshot on local zone. + storageConfiguration: + $ref: "#/components/schemas/StorageConfiguration" + description: Replication Configuration template storage configuration. required: - replicationConfigurationTemplateID ReplicationConfigurationTemplateID: @@ -4616,6 +4711,9 @@ components: storeSnapshotOnLocalZone: $ref: "#/components/schemas/Boolean" description: Replication Configuration store snapshot on local zone. + storageConfiguration: + $ref: "#/components/schemas/StorageConfiguration" + description: Replication Configuration storage configuration. ReplicationConfigurationReplicatedDisks: type: array items: @@ -4650,6 +4748,7 @@ components: - STANDARD - GP3 - IO2 + - FSX_ONTAP InitializeServiceResponse: type: object ListApplicationsRequestFilters: @@ -6427,6 +6526,11 @@ components: inspectionCidr: $ref: "#/components/schemas/Cidr" description: The updated CIDR block for inspection traffic. + FqdnForActionFramework: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9_](([a-zA-Z0-9_\\-]{0,61}[a-zA-Z0-9_])?\\.)+[a-zA-Z]{2,63}$|^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}" x-stackQL-resources: applications: id: aws.mgn.applications diff --git a/providers/src/aws/v00.00.00000/services/mq.yaml b/providers/src/aws/v00.00.00000/services/mq.yaml index 1fc09a34..fe278eb4 100644 --- a/providers/src/aws/v00.00.00000/services/mq.yaml +++ b/providers/src/aws/v00.00.00000/services/mq.yaml @@ -59,6 +59,8 @@ paths: $ref: "#/components/schemas/__boolean" SecurityGroups: $ref: "#/components/schemas/__listOf__string" + StorageSize: + $ref: "#/components/schemas/__integer" StorageType: $ref: "#/components/schemas/BrokerStorageType" SubnetIds: @@ -413,8 +415,12 @@ paths: $ref: "#/components/schemas/Logs" MaintenanceWindowStartTime: $ref: "#/components/schemas/WeeklyStartTime" + ResourceShareArns: + $ref: "#/components/schemas/__listOf__string" SecurityGroups: $ref: "#/components/schemas/__listOf__string" + StorageSize: + $ref: "#/components/schemas/__integer" DataReplicationMode: $ref: "#/components/schemas/DataReplicationMode" responses: @@ -585,6 +591,36 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeConfigurationRevisionResponse" + /v1/brokers/{broker-id}/shared-resources: + get: + operationId: DescribeSharedResources + description: Returns the resources shared to a broker. + parameters: + - name: broker-id + in: path + required: true + schema: + $ref: "#/components/schemas/__string" + description: The unique ID that Amazon MQ generates for the broker. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of resources that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/__string" + description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeSharedResourcesResponse" /v1/configurations/{configuration-id}/revisions: get: operationId: ListConfigurationRevisions @@ -1050,12 +1086,18 @@ components: PendingSecurityGroups: $ref: "#/components/schemas/__listOf__string" description: The list of pending security groups to authorize connections to brokers. + PendingStorageSize: + $ref: "#/components/schemas/__integer" + description: The pending storage size in GB, to be applied on the next broker restart. PubliclyAccessible: $ref: "#/components/schemas/__boolean" description: Enables connections from applications outside of the VPC that hosts the broker's subnets. SecurityGroups: $ref: "#/components/schemas/__listOf__string" description: The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. + StorageSize: + $ref: "#/components/schemas/__integer" + description: The broker's storage size in GB. StorageType: $ref: "#/components/schemas/BrokerStorageType" description: The broker's storage type. @@ -1408,6 +1450,85 @@ components: Description: $ref: "#/components/schemas/__string" description: The description of the configuration. + DescribeSharedResourcesResponse: + type: object + properties: + NextToken: + $ref: "#/components/schemas/__string" + description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + SharedResources: + $ref: "#/components/schemas/__listOfSharedResource" + description: A list of resources shared to the broker. + __listOfSharedResource: + type: array + items: + $ref: "#/components/schemas/SharedResource" + SharedResource: + description: Represents a resource that is shared with the broker, including its type, ARN, and current status. + type: object + properties: + DnsNames: + $ref: "#/components/schemas/__listOf__string" + description: The DNS names accessible by the broker. + Error: + $ref: "#/components/schemas/SharedResourceError" + description: Information on the error encountered by the resource. + ResourceArn: + $ref: "#/components/schemas/__string" + description: The ARN of the shared resource. + ResourceShareArns: + $ref: "#/components/schemas/__listOf__string" + description: The resource share ARNs to which the resource belongs. + Status: + $ref: "#/components/schemas/SharedResourceStatus" + description: The status of the shared resource. + Type: + $ref: "#/components/schemas/SharedResourceType" + description: The type of shared resource. + required: + - Status + - ResourceArn + - Type + SharedResourceError: + description: Information on the error encountered by the resource. + type: object + properties: + Code: + $ref: "#/components/schemas/SharedResourceErrorCode" + description: The error code associated with the error. + Message: + $ref: "#/components/schemas/__string" + description: The error message. + required: + - Message + - Code + SharedResourceErrorCode: + description: The error code associated with the error. + type: string + enum: + - QUOTA_EXCEEDED + - SHARE_NOT_FOUND + - INVITE_FAILED + - SETUP_INCOMPLETE + - INTERNAL_ERROR + - AZ_MISMATCH + - RESOURCE_CONFIGURATION_NOT_FOUND + SharedResourceStatus: + description: The status of the shared resource. + type: string + enum: + - AVAILABLE + - SETUP_IN_PROGRESS + - DELETION_IN_PROGRESS + - PENDING_CREATE + - PENDING_DELETE + - ERROR + SharedResourceType: + description: The type of shared resource. + type: string + enum: + - RESOURCE_SHARE + - RESOURCE DescribeUserResponse: type: object properties: @@ -1634,6 +1755,9 @@ components: MaintenanceWindowStartTime: $ref: "#/components/schemas/WeeklyStartTime" description: The parameters that determine the WeeklyStartTime. + ResourceShareArns: + $ref: "#/components/schemas/__listOf__string" + description: The pending broker's target list of resource shares SecurityGroups: $ref: "#/components/schemas/__listOf__string" description: The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers. @@ -1649,6 +1773,9 @@ components: PendingDataReplicationMode: $ref: "#/components/schemas/DataReplicationMode" description: Describes whether this broker will be a part of a data replication pair after reboot. + StorageSize: + $ref: "#/components/schemas/__integer" + description: The broker's storage size in GB. UpdateConfigurationResponse: type: object properties: @@ -1979,3 +2106,31 @@ components: insert: [] update: [] delete: [] + shared_resources: + id: aws.mq.shared_resources + name: shared_resources + title: shared_resources + methods: + describe_shared_resources: + operation: + $ref: "#/paths/~1v1~1brokers~1{broker-id}~1shared-resources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.SharedResources + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.NextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/shared_resources/methods/describe_shared_resources" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/mwaa.yaml b/providers/src/aws/v00.00.00000/services/mwaa.yaml index 9d46040f..a8899f7d 100644 --- a/providers/src/aws/v00.00.00000/services/mwaa.yaml +++ b/providers/src/aws/v00.00.00000/services/mwaa.yaml @@ -717,7 +717,7 @@ components: description: 'The key-value tag pairs associated to your environment. For example, "Environment": "Staging". For more information, refer to Tagging Amazon Web Services resources.' WebserverAccessMode: $ref: "#/components/schemas/WebserverAccessMode" - description: The Apache Airflow web server access mode. For more information, refer to Apache Airflow access modes. + description: The Apache Airflow web server access mode. For more information, refer to Apache Airflow access modes. If set to PUBLIC_AND_PRIVATE, creates both a public network load balancer (NLB) for browser access and a private VPC endpoint (VPCE) for worker-to-webserver communication. This mode is only available for Apache Airflow version 3.2 and later. MinWorkers: $ref: "#/components/schemas/MinWorkers" description: The minimum number of workers that run in your environment. For example, 2. diff --git a/providers/src/aws/v00.00.00000/services/mwaa_serverless.yaml b/providers/src/aws/v00.00.00000/services/mwaa_serverless.yaml index 46f5c9df..e41bd692 100644 --- a/providers/src/aws/v00.00.00000/services/mwaa_serverless.yaml +++ b/providers/src/aws/v00.00.00000/services/mwaa_serverless.yaml @@ -48,6 +48,9 @@ paths: DefinitionS3Location: $ref: "#/components/schemas/DefinitionS3Location" description: The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment. + Code: + $ref: "#/components/schemas/Code" + description: The location of code artifacts in Amazon S3 for the workflow. The service copies the code from this location at the time of the request. RoleArn: $ref: "#/components/schemas/RoleARN" description: The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services. @@ -602,6 +605,9 @@ paths: DefinitionS3Location: $ref: "#/components/schemas/DefinitionS3Location" description: The Amazon S3 location where the updated workflow definition file is stored. + Code: + $ref: "#/components/schemas/Code" + description: The location of code artifacts in Amazon S3 for the updated workflow. The service copies the code from this location at the time of the request. RoleArn: $ref: "#/components/schemas/RoleARN" description: The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when it executes the updated workflow. @@ -704,6 +710,41 @@ components: - ObjectKey String: type: string + Code: + description: Specifies the Amazon S3 location of code artifacts that workflows use during execution. + type: object + properties: + S3Location: + $ref: "#/components/schemas/S3Location" + description: The Amazon S3 location of the code artifacts that your workflow tasks use during execution. + S3Location: + description: Specifies the Amazon S3 location of code artifacts that workflows use during execution. + type: object + properties: + Bucket: + $ref: "#/components/schemas/S3LocationBucketString" + description: The name of the Amazon S3 bucket. + ObjectKey: + $ref: "#/components/schemas/S3LocationObjectKeyString" + description: The key of the code artifact within the Amazon S3 bucket. + VersionId: + $ref: "#/components/schemas/S3LocationVersionIdString" + description: The version ID of the object in Amazon S3. If not specified, the latest version is used. + required: + - Bucket + - ObjectKey + S3LocationBucketString: + type: string + minLength: 3 + maxLength: 63 + S3LocationObjectKeyString: + type: string + minLength: 1 + maxLength: 1024 + S3LocationVersionIdString: + type: string + minLength: 1 + maxLength: 1024 RoleARN: type: string minLength: 1 @@ -957,6 +998,12 @@ components: DefinitionS3Location: $ref: "#/components/schemas/DefinitionS3Location" description: The Amazon S3 location of the workflow definition file. + Code: + $ref: "#/components/schemas/Code" + description: The Amazon S3 location of the code artifacts provided during workflow creation or update. + CodeSnapshottedAt: + $ref: "#/components/schemas/TimestampValue" + description: The time at which the code artifacts were copied for this workflow, in ISO 8601 date-time format. ScheduleConfiguration: $ref: "#/components/schemas/ScheduleConfiguration" description: The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time. diff --git a/providers/src/aws/v00.00.00000/services/neptune.yaml b/providers/src/aws/v00.00.00000/services/neptune.yaml index 25a833e3..738cbb89 100644 --- a/providers/src/aws/v00.00.00000/services/neptune.yaml +++ b/providers/src/aws/v00.00.00000/services/neptune.yaml @@ -220,7 +220,7 @@ paths: - name: SourceDBClusterParameterGroupIdentifier in: query required: true - description: "The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1." + description: "The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. Must specify a valid DB cluster parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. The source DB cluster parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups." schema: $ref: "#/components/schemas/String" - name: TargetDBClusterParameterGroupIdentifier @@ -352,7 +352,7 @@ paths: - name: SourceDBParameterGroupIdentifier in: query required: true - description: "The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN." + description: "The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN. The source DB parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups." schema: $ref: "#/components/schemas/String" - name: TargetDBParameterGroupIdentifier @@ -436,7 +436,7 @@ paths: - name: DatabaseName in: query required: false - description: The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating. + description: Not supported by Neptune. schema: $ref: "#/components/schemas/String" - name: DBClusterIdentifier @@ -577,6 +577,12 @@ paths: description: "The storage type for the new DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0." schema: $ref: "#/components/schemas/String" + - name: NetworkType + in: query + required: false + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -3301,6 +3307,12 @@ paths: description: "The storage type to associate with the DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0." schema: $ref: "#/components/schemas/String" + - name: NetworkType + in: query + required: false + description: "The network type of the DB cluster. Valid Values: IPV4 – The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -4491,6 +4503,12 @@ paths: description: "Specifies the storage type to be associated with the DB cluster. Valid values: standard, iopt1 Default: standard" schema: $ref: "#/components/schemas/String" + - name: NetworkType + in: query + required: false + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -4629,6 +4647,12 @@ paths: description: "Specifies the storage type to be associated with the DB cluster. Valid values: standard, iopt1 Default: standard" schema: $ref: "#/components/schemas/String" + - name: NetworkType + in: query + required: false + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -4983,7 +5007,7 @@ components: properties: SourceDBClusterParameterGroupIdentifier: $ref: "#/components/schemas/String" - description: "The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1." + description: "The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. Must specify a valid DB cluster parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. The source DB cluster parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups." TargetDBClusterParameterGroupIdentifier: $ref: "#/components/schemas/String" description: "The identifier for the copied DB cluster parameter group. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1" @@ -5123,7 +5147,7 @@ components: properties: SourceDBParameterGroupIdentifier: $ref: "#/components/schemas/String" - description: "The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN." + description: "The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN. The source DB parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups." TargetDBParameterGroupIdentifier: $ref: "#/components/schemas/String" description: "The identifier for the copied DB parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-db-parameter-group" @@ -5307,6 +5331,9 @@ components: StorageType: type: string description: "The storage type used by the DB cluster. Valid Values: standard – ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0." + NetworkType: + type: string + description: "The network type of the DB cluster. Valid Values: IPV4 – The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication." CreateDBClusterOutputDisplay: type: object properties: @@ -5331,7 +5358,7 @@ components: description: If set to true, tags are copied to any snapshot of the DB cluster that is created. DatabaseName: $ref: "#/components/schemas/String" - description: The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating. + description: Not supported by Neptune. DBClusterIdentifier: $ref: "#/components/schemas/String" description: "The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1" @@ -5401,6 +5428,9 @@ components: StorageType: $ref: "#/components/schemas/String" description: "The storage type for the new DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0." + NetworkType: + $ref: "#/components/schemas/String" + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." required: - DBClusterIdentifier - Engine @@ -5656,6 +5686,9 @@ components: DeletionProtection: type: boolean description: Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance. + NetworkType: + type: string + description: "The network type of the DB instance. Inherited from the DB cluster. Valid Values: IPV4, DUAL" CreateDBInstanceOutputDisplay: type: object properties: @@ -5851,6 +5884,9 @@ components: DBSubnetGroupArn: type: string description: The Amazon Resource Name (ARN) for the DB subnet group. + SupportedNetworkTypes: + type: string + description: The network types supported by the DB subnet group. Valid network types include IPV4 and DUAL. A DB subnet group supports DUAL if all subnets in the group have both IPv4 and IPv6 CIDRs. CreateDBSubnetGroupOutputDisplay: type: object properties: @@ -6797,6 +6833,9 @@ components: SupportsGlobalDatabases: type: boolean description: A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes. + SupportedNetworkTypes: + type: string + description: The network types supported by the orderable DB instance option. DescribeOrderableDBInstanceOptionsOutputDisplay: type: object properties: @@ -7024,6 +7063,9 @@ components: StorageType: $ref: "#/components/schemas/String" description: "The storage type to associate with the DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0." + NetworkType: + $ref: "#/components/schemas/String" + description: "The network type of the DB cluster. Valid Values: IPV4 – The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." required: - DBClusterIdentifier ModifyDBClusterEndpointOutputDisplay: @@ -7582,6 +7624,9 @@ components: StorageType: $ref: "#/components/schemas/String" description: "Specifies the storage type to be associated with the DB cluster. Valid values: standard, iopt1 Default: standard" + NetworkType: + $ref: "#/components/schemas/String" + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." required: - DBClusterIdentifier - SnapshotIdentifier @@ -7647,6 +7692,9 @@ components: StorageType: $ref: "#/components/schemas/String" description: "Specifies the storage type to be associated with the DB cluster. Valid values: standard, iopt1 Default: standard" + NetworkType: + $ref: "#/components/schemas/String" + description: "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6." required: - DBClusterIdentifier - SourceDBClusterIdentifier diff --git a/providers/src/aws/v00.00.00000/services/neptune_graph.yaml b/providers/src/aws/v00.00.00000/services/neptune_graph.yaml index c450a0db..b1ce23f3 100644 --- a/providers/src/aws/v00.00.00000/services/neptune_graph.yaml +++ b/providers/src/aws/v00.00.00000/services/neptune_graph.yaml @@ -1030,7 +1030,7 @@ components: type: string minLength: 1 maxLength: 1024 - pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36} + pattern: arn:aws[^:]*:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36} ParquetType: type: string enum: @@ -2480,7 +2480,7 @@ components: type: string minLength: 1 maxLength: 128 - pattern: (?!aws:)[a-zA-Z+-=._:/]+ + pattern: "[a-zA-Z+-=._:/]+" UntagResourceOutput: type: object UpdateGraphOutput: diff --git a/providers/src/aws/v00.00.00000/services/network_firewall.yaml b/providers/src/aws/v00.00.00000/services/network_firewall.yaml index b66362aa..dd0df968 100644 --- a/providers/src/aws/v00.00.00000/services/network_firewall.yaml +++ b/providers/src/aws/v00.00.00000/services/network_firewall.yaml @@ -220,6 +220,52 @@ paths: application/json: schema: $ref: "#/components/schemas/AttachRuleGroupsToProxyConfigurationResponse" + /CreateContainerAssociation: + post: + operationId: CreateContainerAssociation + description: Creates a Network Firewall container association. The association monitors container lifecycle events in your Amazon ECS or Amazon EKS clusters and resolves running container addresses for use in firewall rules. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.CreateContainerAssociation + default: NetworkFirewall_20201112.CreateContainerAssociation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. You can't change the name of a container association after you create it. + Description: + $ref: "#/components/schemas/Description" + description: A description of the container association. + Type: + $ref: "#/components/schemas/ContainerMonitoringType" + description: "The type of containers to monitor. You can't change the container type after creation. Valid values: ECS - Amazon Elastic Container Service EKS - Amazon Elastic Kubernetes Service" + ContainerMonitoringConfigurations: + $ref: "#/components/schemas/ContainerMonitoringConfigurations" + description: The monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters to narrow which containers are tracked. + Tags: + $ref: "#/components/schemas/TagList" + description: The key:value pairs to associate with the resource. + required: + - ContainerAssociationName + - ContainerMonitoringConfigurations + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateContainerAssociationResponse" /CreateFirewall: post: operationId: CreateFirewall @@ -283,6 +329,18 @@ paths: AvailabilityZoneChangeProtection: $ref: "#/components/schemas/Boolean" description: "Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection. Default value: FALSE" + NatGatewayMappings: + $ref: "#/components/schemas/NatGatewayMappingsList" + description: The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway. + ProxySettings: + $ref: "#/components/schemas/ProxySettings" + description: The listener configuration for a proxy mode firewall, used when NoSourcePreservation is TRUE. This specifies the ports and protocols on which the firewall's proxy listens for traffic. + NoSourcePreservation: + $ref: "#/components/schemas/Boolean" + description: "Optional. Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When set to TRUE, the firewall proxies traffic through a NAT gateway and the traffic reaching the destination uses the NAT gateway's IP address as the source. When you set this to TRUE, you must specify NatGatewayMappings and VpcEndpoint instead of a top-level VpcId and SubnetMappings. You can't change this setting after you create the firewall. Default value: FALSE" + VpcEndpoint: + $ref: "#/components/schemas/VpcEndpoint" + description: The VPC and subnets for the firewall endpoint, used when NoSourcePreservation is TRUE. Network Firewall creates the firewall endpoint in the subnets that you specify here. For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level VpcId and SubnetMappings. required: - FirewallName - FirewallPolicyArn @@ -682,6 +740,40 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateVpcEndpointAssociationResponse" + /DeleteContainerAssociation: + post: + operationId: DeleteContainerAssociation + description: Deletes a container association. The resource transitions to a DELETING state. Deletion is asynchronous - Network Firewall returns immediately while cleanup proceeds in the background. You can't delete a container association while a rule group references it. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.DeleteContainerAssociation + default: NetworkFirewall_20201112.DeleteContainerAssociation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. You must specify the ARN or the name, and you can specify both. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteContainerAssociationResponse" /DeleteFirewall: post: operationId: DeleteFirewall @@ -1064,6 +1156,42 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteVpcEndpointAssociationResponse" + /DescribeContainerAssociation: + post: + operationId: DescribeContainerAssociation + description: Retrieves the configuration and status of a container association. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.DescribeContainerAssociation + default: NetworkFirewall_20201112.DescribeContainerAssociation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. You must specify the ARN or the name, and you can specify both. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both. + required: + - ContainerAssociationName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeContainerAssociationResponse" /DescribeFirewall: post: operationId: DescribeFirewall @@ -1826,6 +1954,40 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAnalysisReportsResponse" + /ListContainerAssociations: + post: + operationId: ListContainerAssociations + description: Lists the container associations in your account and Region. Use the NextToken parameter in subsequent requests to retrieve additional results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.ListContainerAssociations + default: NetworkFirewall_20201112.ListContainerAssociations + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/PaginationMaxResults" + description: The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects. + NextToken: + $ref: "#/components/schemas/PaginationToken" + description: When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListContainerAssociationsResponse" /ListFirewallPolicies: post: operationId: ListFirewallPolicies @@ -2578,6 +2740,58 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateAvailabilityZoneChangeProtectionResponse" + /UpdateContainerAssociation: + post: + operationId: UpdateContainerAssociation + description: Updates the monitoring configurations and description of a container association. You can't change the container type after creation. Provide an update token to enable optimistic concurrency control. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.UpdateContainerAssociation + default: NetworkFirewall_20201112.UpdateContainerAssociation + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. You must specify the ARN or the name, and you can specify both. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both. + Description: + $ref: "#/components/schemas/Description" + description: A description of the container association. When omitted, the existing description remains unchanged. To clear the description, pass an empty string. + Type: + $ref: "#/components/schemas/ContainerMonitoringType" + description: "The container type. This value must match the existing type and can't be changed. Valid values: ECS - Amazon Elastic Container Service EKS - Amazon Elastic Kubernetes Service" + ContainerMonitoringConfigurations: + $ref: "#/components/schemas/ContainerMonitoringConfigurations" + description: The updated monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters. + Tags: + $ref: "#/components/schemas/TagList" + description: The key:value pairs to associate with the resource. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. + required: + - ContainerMonitoringConfigurations + - UpdateToken + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateContainerAssociationResponse" /UpdateFirewallAnalysisSettings: post: operationId: UpdateFirewallAnalysisSettings @@ -3112,6 +3326,46 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateProxyRulePrioritiesResponse" + /UpdateProxySettings: + post: + operationId: UpdateProxySettings + description: Modifies the proxy listener configuration of a proxy mode firewall. Proxy mode firewalls are created with NoSourcePreservation set to TRUE. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - NetworkFirewall_20201112.UpdateProxySettings + default: NetworkFirewall_20201112.UpdateProxySettings + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + FirewallArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both. + FirewallName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. + ProxySettings: + $ref: "#/components/schemas/ProxySettings" + description: The proxy listener configuration to set on the firewall. This specifies the ports and protocols on which the firewall's proxy listens for traffic. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateProxySettingsResponse" /UpdateRuleGroup: post: operationId: UpdateRuleGroup @@ -3577,6 +3831,88 @@ components: minLength: 0 maxLength: 256 pattern: ^.*$ + ContainerMonitoringType: + type: string + enum: + - ECS + - EKS + ContainerMonitoringConfigurations: + type: array + items: + $ref: "#/components/schemas/ContainerMonitoringConfiguration" + ContainerMonitoringConfiguration: + description: Contains the monitoring configuration for a single cluster in a container association. Specifies the cluster ARN and optional attribute filters to narrow which containers are tracked. + type: object + properties: + ClusterArn: + $ref: "#/components/schemas/ResourceArn" + description: The ARN of the Amazon ECS or Amazon EKS cluster to monitor. The cluster must be in the same Region and account as the container association. + AttributeFilters: + $ref: "#/components/schemas/ContainerAttributes" + description: Key-value pairs that filter which containers are tracked. For Amazon EKS, you can filter by namespace and Kubernetes labels. For Amazon ECS, you can filter by container instance attributes (EC2 launch type only). + required: + - ClusterArn + ContainerAttributes: + type: array + items: + $ref: "#/components/schemas/ContainerAttribute" + ContainerAttribute: + description: A key-value filter pair used in container association monitoring configurations to narrow which containers are tracked. + type: object + properties: + Key: + $ref: "#/components/schemas/ContainerAttributeKey" + description: The attribute key to filter on. + Value: + $ref: "#/components/schemas/ContainerAttributeValue" + description: The attribute value to match. + required: + - Key + - Value + ContainerAttributeKey: + type: string + minLength: 1 + maxLength: 256 + pattern: \S+ + ContainerAttributeValue: + type: string + minLength: 1 + maxLength: 256 + pattern: \S+ + CreateContainerAssociationResponse: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. + Description: + $ref: "#/components/schemas/Description" + description: A description of the container association. + Type: + $ref: "#/components/schemas/ContainerMonitoringType" + description: "The container type. Valid values: ECS - Amazon Elastic Container Service EKS - Amazon Elastic Kubernetes Service" + ContainerMonitoringConfigurations: + $ref: "#/components/schemas/ContainerMonitoringConfigurations" + description: The monitoring configurations for the container association. + Status: + $ref: "#/components/schemas/ContainerAssociationStatus" + description: The current status of the container association. For a new container association, the status is CREATING. + Tags: + $ref: "#/components/schemas/TagList" + description: The key:value pairs to associate with the resource. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. + ContainerAssociationStatus: + type: string + enum: + - ACTIVE + - CREATING + - DELETING + - UPDATING VpcId: type: string minLength: 1 @@ -3620,6 +3956,65 @@ components: minLength: 1 maxLength: 128 pattern: ^tgw-[0-9a-z]+$ + NatGatewayMappingsList: + type: array + items: + $ref: "#/components/schemas/NatGatewayMapping" + NatGatewayMapping: + description: A NAT gateway that a proxy mode firewall uses to proxy traffic. This is used in CreateFirewall when NoSourcePreservation is TRUE. + type: object + properties: + NatGatewayId: + $ref: "#/components/schemas/NatGatewayId" + description: A unique identifier for the NAT gateway to use with proxy resources. + required: + - NatGatewayId + NatGatewayId: + type: string + minLength: 1 + ProxySettings: + description: The listener configuration for a proxy mode firewall. This specifies the ports and protocols on which the firewall's proxy listens for traffic. + type: object + properties: + ListenerProperties: + $ref: "#/components/schemas/ListenerProperties" + description: Listener properties for HTTP and HTTPS traffic. + required: + - ListenerProperties + ListenerProperties: + type: array + items: + $ref: "#/components/schemas/ListenerProperty" + ListenerProperty: + description: Open port for taking HTTP or HTTPS traffic. + type: object + properties: + Port: + $ref: "#/components/schemas/NatGatewayPort" + description: Port for processing traffic. + Type: + $ref: "#/components/schemas/ListenerPropertyType" + description: Selection of HTTP or HTTPS traffic. + NatGatewayPort: + type: integer + ListenerPropertyType: + type: string + enum: + - HTTP + - HTTPS + VpcEndpoint: + description: The VPC and subnets for a proxy mode firewall endpoint. This is used in CreateFirewall when NoSourcePreservation is TRUE, to specify where Network Firewall creates the firewall endpoint. This differs from VpcEndpointAssociation, which defines additional secondary endpoints for a firewall in other VPCs. + type: object + properties: + VpcId: + $ref: "#/components/schemas/VpcId" + description: The unique identifier of the VPC where Network Firewall creates the proxy mode firewall endpoint. + SubnetMappings: + $ref: "#/components/schemas/SubnetMappings" + description: The subnets in which Network Firewall creates the firewall endpoint for a proxy mode firewall. Each subnet must belong to a different Availability Zone in the VPC. + required: + - VpcId + - SubnetMappings CreateFirewallResponse: type: object properties: @@ -3686,6 +4081,18 @@ components: AvailabilityZoneChangeProtection: $ref: "#/components/schemas/Boolean" description: A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones. + NatGatewayMappings: + $ref: "#/components/schemas/NatGatewayMappingsList" + description: The NAT gateways that the firewall uses to proxy traffic. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE. + ProxySettings: + $ref: "#/components/schemas/ProxySettings" + description: The listener configuration for the firewall's proxy. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE. + NoSourcePreservation: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When this value is TRUE, the firewall proxies traffic through a NAT gateway and uses the NAT gateway's IP address as the source for traffic reaching the destination. + VpcEndpoint: + $ref: "#/components/schemas/VpcEndpoint" + description: The VPC and subnets for the firewall endpoint. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE. required: - FirewallPolicyArn - VpcId @@ -3801,7 +4208,7 @@ components: description: References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules. StatefulDefaultActions: $ref: "#/components/schemas/StatefulActions" - description: "The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order. Valid values of the stateful default action: aws:drop_strict aws:drop_established aws:alert_strict aws:alert_established For more information, see Strict evaluation order in the Network Firewall Developer Guide." + description: "The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order. Valid values of the stateful default action: aws:drop_strict aws:drop_established aws:alert_strict aws:alert_established aws:drop_established_app_layer aws:alert_established_app_layer aws:drop_established_app_layer_to_server aws:alert_established_app_layer_to_server For more information, see Strict evaluation order in the Network Firewall Developer Guide." StatefulEngineOptions: $ref: "#/components/schemas/StatefulEngineOptions" description: Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings. @@ -3937,7 +4344,7 @@ components: items: $ref: "#/components/schemas/CollectionMember_String" StatefulEngineOptions: - description: Configuration settings for the handling of the stateful rule groups in a firewall policy. + description: Configuration settings for the handling of the stateful rule groups in a firewall policy. Updating any setting in StatefulEngineOptions may require a restart of the stateful engine in order to apply the changes. When this occurs, existing connections will be treated according to your stream exception policy configuration. type: object properties: RuleOrder: @@ -3961,7 +4368,7 @@ components: - CONTINUE - REJECT FlowTimeouts: - description: Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. Existing connections and flows are not impacted when you update this value. Only new connections after you update this value are impacted. + description: Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. When you update this value, existing connections will be treated according to your stream exception policy configuration. type: object properties: TcpIdleTimeoutSeconds: @@ -4046,9 +4453,6 @@ components: LastUpdateTime: type: string format: date-time - NatGatewayId: - type: string - minLength: 1 ListenerPropertiesRequest: type: array items: @@ -4066,13 +4470,6 @@ components: required: - Port - Type - NatGatewayPort: - type: integer - ListenerPropertyType: - type: string - enum: - - HTTP - - HTTPS TlsInterceptPropertiesRequest: description: This data type is used specifically for the CreateProxy and UpdateProxy APIs. TLS decryption on traffic to filter on attributes in the HTTP header. type: object @@ -4168,20 +4565,6 @@ components: - MODIFYING - COMPLETED - FAILED - ListenerProperties: - type: array - items: - $ref: "#/components/schemas/ListenerProperty" - ListenerProperty: - description: Open port for taking HTTP or HTTPS traffic. - type: object - properties: - Port: - $ref: "#/components/schemas/NatGatewayPort" - description: Port for processing traffic. - Type: - $ref: "#/components/schemas/ListenerPropertyType" - description: Selection of HTTP or HTTPS traffic. TlsInterceptProperties: description: TLS decryption on traffic to filter on attributes in the HTTP header. type: object @@ -5055,6 +5438,18 @@ components: description: The list of the Availability Zone sync states for all subnets that are defined by the firewall. required: - Status + DeleteContainerAssociationResponse: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. + Status: + $ref: "#/components/schemas/ContainerAssociationStatus" + description: The current status of the container association. After deletion is initiated, the status is DELETING. DeleteFirewallResponse: type: object properties: @@ -5145,6 +5540,42 @@ components: VpcEndpointAssociationStatus: $ref: "#/components/schemas/VpcEndpointAssociationStatus" description: Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN. + DescribeContainerAssociationResponse: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. + Description: + $ref: "#/components/schemas/Description" + description: A description of the container association. + Type: + $ref: "#/components/schemas/ContainerMonitoringType" + description: "The container type. Valid values: ECS - Amazon Elastic Container Service EKS - Amazon Elastic Kubernetes Service" + ContainerMonitoringConfigurations: + $ref: "#/components/schemas/ContainerMonitoringConfigurations" + description: The monitoring configurations for the container association. + Status: + $ref: "#/components/schemas/ContainerAssociationStatus" + description: The current status of the container association. + ResolvedCidrCount: + $ref: "#/components/schemas/CIDRCount" + description: The number of CIDR blocks resolved from the monitored containers. + LastUpdatedTime: + $ref: "#/components/schemas/ContainerAssociationLastUpdatedTime" + description: The most recent time that Network Firewall updated the container association. + Tags: + $ref: "#/components/schemas/TagList" + description: The key:value pairs to associate with the resource. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. + ContainerAssociationLastUpdatedTime: + type: string + format: date-time DescribeFirewallResponse: type: object properties: @@ -5759,6 +6190,29 @@ components: Status: $ref: "#/components/schemas/Status" description: The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED. + ListContainerAssociationsResponse: + type: object + properties: + ContainerAssociations: + $ref: "#/components/schemas/ContainerAssociations" + description: The container association metadata objects for the account and Region. + NextToken: + $ref: "#/components/schemas/PaginationToken" + description: When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. + ContainerAssociations: + type: array + items: + $ref: "#/components/schemas/ContainerAssociationSummary" + ContainerAssociationSummary: + description: The metadata for a container association returned by ListContainerAssociations. Contains the ARN and name that you use to identify the container association in other operations. + type: object + properties: + Arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. + Name: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. ListFirewallPoliciesResponse: type: object properties: @@ -6144,6 +6598,33 @@ components: AvailabilityZoneChangeProtection: $ref: "#/components/schemas/Boolean" description: A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE. + UpdateContainerAssociationResponse: + type: object + properties: + ContainerAssociationName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the container association. + ContainerAssociationArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the container association. + Description: + $ref: "#/components/schemas/Description" + description: A description of the container association. + Type: + $ref: "#/components/schemas/ContainerMonitoringType" + description: "The container type. Valid values: ECS - Amazon Elastic Container Service EKS - Amazon Elastic Kubernetes Service" + ContainerMonitoringConfigurations: + $ref: "#/components/schemas/ContainerMonitoringConfigurations" + description: The monitoring configurations for the container association. + Status: + $ref: "#/components/schemas/ContainerAssociationStatus" + description: The current status of the container association. + Tags: + $ref: "#/components/schemas/TagList" + description: The key:value pairs to associate with the resource. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. UpdateFirewallAnalysisSettingsResponse: type: object properties: @@ -6351,6 +6832,21 @@ components: UpdateToken: $ref: "#/components/schemas/UpdateToken" description: A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request. To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. + UpdateProxySettingsResponse: + type: object + properties: + FirewallArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the firewall. + FirewallName: + $ref: "#/components/schemas/ResourceName" + description: The descriptive name of the firewall. You can't change the name of a firewall after you create it. + UpdateToken: + $ref: "#/components/schemas/UpdateToken" + description: An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. + ProxySettings: + $ref: "#/components/schemas/ProxySettings" + description: The updated proxy listener configuration on the firewall. UpdateRuleGroupResponse: type: object properties: @@ -6698,6 +7194,94 @@ components: - $ref: "#/components/x-stackQL-resources/proxy_configurations/methods/detach_rule_groups_from_proxy_configuration" delete: - $ref: "#/components/x-stackQL-resources/proxy_configurations/methods/delete_proxy_configuration" + container_associations: + id: aws.network_firewall.container_associations + name: container_associations + title: container_associations + methods: + create_container_association: + operation: + $ref: "#/paths/~1CreateContainerAssociation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_container_association: + operation: + $ref: "#/paths/~1DeleteContainerAssociation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_container_association: + operation: + $ref: "#/paths/~1DescribeContainerAssociation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_container_associations: + operation: + $ref: "#/paths/~1ListContainerAssociations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.ContainerAssociations + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_container_association: + operation: + $ref: "#/paths/~1UpdateContainerAssociation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/container_associations/methods/describe_container_association" + - $ref: "#/components/x-stackQL-resources/container_associations/methods/list_container_associations" + insert: + - $ref: "#/components/x-stackQL-resources/container_associations/methods/create_container_association" + update: + - $ref: "#/components/x-stackQL-resources/container_associations/methods/update_container_association" + delete: + - $ref: "#/components/x-stackQL-resources/container_associations/methods/delete_container_association" firewalls: id: aws.network_firewall.firewalls name: firewalls @@ -6930,6 +7514,19 @@ components: config: requestBodyTranslate: algorithm: naive + update_proxy_settings: + operation: + $ref: "#/paths/~1UpdateProxySettings/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/proxies/methods/describe_proxy" @@ -6938,6 +7535,7 @@ components: - $ref: "#/components/x-stackQL-resources/proxies/methods/create_proxy" update: - $ref: "#/components/x-stackQL-resources/proxies/methods/update_proxy" + - $ref: "#/components/x-stackQL-resources/proxies/methods/update_proxy_settings" delete: - $ref: "#/components/x-stackQL-resources/proxies/methods/delete_proxy" proxy_rule_groups: diff --git a/providers/src/aws/v00.00.00000/services/observabilityadmin.yaml b/providers/src/aws/v00.00.00000/services/observabilityadmin.yaml index 5ad52e95..4be29ffb 100644 --- a/providers/src/aws/v00.00.00000/services/observabilityadmin.yaml +++ b/providers/src/aws/v00.00.00000/services/observabilityadmin.yaml @@ -729,6 +729,8 @@ paths: $ref: "#/components/schemas/Records" Configuration: $ref: "#/components/schemas/TelemetryPipelineConfiguration" + SignalType: + $ref: "#/components/schemas/SignalType" required: - Records - Configuration @@ -964,6 +966,9 @@ components: SourceLogsConfiguration: $ref: "#/components/schemas/SourceLogsConfiguration" description: Log specific configuration for centralization source log groups. + SourceMetricsConfiguration: + $ref: "#/components/schemas/SourceMetricsConfiguration" + description: Metric specific configuration for centralization source metrics. required: - Regions Regions: @@ -1005,6 +1010,17 @@ components: enum: - ALLOW - SKIP + SourceMetricsConfiguration: + description: Configuration for selecting source metrics for centralization. + type: object + properties: + MetricsSelectionCriteria: + $ref: "#/components/schemas/MetricsFilterString" + description: The filter expression that selects which source metrics to centralize. Currently, only * (all metrics) is supported. Other values return a validation error. + MetricsFilterString: + type: string + minLength: 1 + maxLength: 2000 CentralizationRuleDestination: description: Configuration specifying the primary destination for centralized telemetry data. type: object @@ -1018,6 +1034,9 @@ components: DestinationLogsConfiguration: $ref: "#/components/schemas/DestinationLogsConfiguration" description: Log specific configuration for centralization destination log groups. + DestinationMetricsConfiguration: + $ref: "#/components/schemas/DestinationMetricsConfiguration" + description: Metric specific configuration for centralization destination metrics. required: - Region AccountIdentifier: @@ -1038,8 +1057,11 @@ components: LogGroupNameConfiguration: $ref: "#/components/schemas/LogGroupNameConfiguration" description: Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created. + TagPropagationConfiguration: + $ref: "#/components/schemas/TagPropagationConfiguration" + description: Specifies the tag propagation configuration for this centralization rule. When present, LogGroupNameConfiguration must use a LogGroupNamePattern that contains ${source.logGroup}, ${source.accountId}, and ${source.region}. LogsEncryptionConfiguration: - description: Configuration for encrypting centralized log groups. This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys. + description: Configuration for encrypting centralized destination log groups. By default, this configuration applies only to destination log groups whose corresponding source log groups are encrypted using customer managed KMS keys. To encrypt all destination log groups created by the rule, set EncryptionScope to NEW_DESTINATION_LOG_GROUPS. type: object properties: EncryptionStrategy: @@ -1051,6 +1073,9 @@ components: EncryptionConflictResolutionStrategy: $ref: "#/components/schemas/EncryptionConflictResolutionStrategy" description: Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group. + EncryptionScope: + $ref: "#/components/schemas/EncryptionScope" + description: Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED. If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted. If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture. This field is not valid when EncryptionStrategy is AWS_OWNED. required: - EncryptionStrategy EncryptionStrategy: @@ -1068,6 +1093,12 @@ components: enum: - ALLOW - SKIP + EncryptionScope: + description: Determines which newly created destination log groups are encrypted with the configured KMS key. + type: string + enum: + - ENCRYPTED_SOURCE_ONLY + - NEW_DESTINATION_LOG_GROUPS LogsBackupConfiguration: description: Configuration for backing up centralized log data to a secondary region. type: object @@ -1095,6 +1126,46 @@ components: minLength: 1 maxLength: 512 pattern: (?:[\._\-/#A-Za-z0-9]+|\$\{[A-Za-z]+(?:\.[A-Za-z]+){1,2}\})+ + TagPropagationConfiguration: + description: Specifies configuration for propagating resource tags from source log groups to centralized destination log groups. The service uses a customer-managed IAM role in the destination account to add, update, and remove tags on destination log groups. + type: object + properties: + DestinationRoleArn: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of a customer-managed IAM role in the destination account. The service assumes this role to propagate tags to destination log groups. You must have iam:PassRole permission on this role. + TagConflictResolutionStrategy: + $ref: "#/components/schemas/TagConflictResolutionStrategy" + description: The strategy for resolving conflicts when a tag key exists on both the source and destination log groups. If not specified, defaults to UPDATE_SYNC. ADD_ONLY – Only adds new tags from the source without modifying existing destination tags. UPDATE_SYNC – Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source. IN_SYNC – Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source. + required: + - DestinationRoleArn + IamRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/[\w+=,.@/-]+ + TagConflictResolutionStrategy: + description: The strategy for resolving tag conflicts between source and destination log groups. ADD_ONLY – Only adds new tags from the source without modifying existing destination tags. UPDATE_SYNC – Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source. IN_SYNC – Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source. + type: string + enum: + - IN_SYNC + - ADD_ONLY + - UPDATE_SYNC + DestinationMetricsConfiguration: + description: Configuration for centralization destination metrics, including backup settings. + type: object + properties: + BackupConfiguration: + $ref: "#/components/schemas/MetricsBackupConfiguration" + description: Configuration defining the backup region for the metrics backup destination. + MetricsBackupConfiguration: + description: Configuration for backing up centralized metrics data to a secondary region. + type: object + properties: + Region: + $ref: "#/components/schemas/Region" + description: Metrics specific backup destination region within the primary destination account to which metrics data should be centralized. + required: + - Region TagMapInput: type: object properties: {} @@ -1157,7 +1228,7 @@ components: properties: ResourceType: $ref: "#/components/schemas/ResourceType" - description: The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL"). + description: The type of Amazon Web Services resource to configure telemetry for (for example, AWS::EC2::VPC, AWS::EKS::Cluster, AWS::ElasticLoadBalancingV2::LoadBalancer, or AWS::Bedrock::KnowledgeBase). TelemetryType: $ref: "#/components/schemas/TelemetryType" description: The type of telemetry to collect (Logs, Metrics, or Traces). @@ -1206,6 +1277,8 @@ components: - AWS::SecurityHub::HubV2 - AWS::CloudWatch::OTelEnrichment - AWS::MSK::Cluster + - AWS::S3::Bucket + - AWS::Bedrock::KnowledgeBase TelemetryType: type: string enum: @@ -1255,10 +1328,13 @@ components: description: Configuration parameters specific to WAF logging when WAF is the resource type. LogDeliveryParameters: $ref: "#/components/schemas/LogDeliveryParameters" - description: Configuration parameters specific to Amazon Bedrock AgentCore logging when Amazon Bedrock AgentCore is the resource type. + description: The configuration parameters for log delivery when the resource type supports configurable log types, such as Amazon Bedrock Knowledge Bases or Elastic Load Balancing Application Load Balancers. MskMonitoringParameters: $ref: "#/components/schemas/MskMonitoringParameters" description: Configuration parameters specific to MSK monitoring when MSK is the resource type. + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the log groups created during telemetry rule remediation. DestinationType: type: string enum: @@ -1495,17 +1571,18 @@ components: enum: - WAF_LOGS LogDeliveryParameters: - description: Configuration parameters for Amazon Bedrock AgentCore logging, including logType settings. + description: The configuration parameters for log delivery, including logType settings. Applies to resource types that support configurable log delivery, such as Amazon Bedrock Knowledge Bases and Elastic Load Balancing Application Load Balancers. type: object properties: LogTypes: $ref: "#/components/schemas/LogTypes" - description: The type of log that the source is sending. + description: The types of logs to collect from the resource. LogTypes: type: array items: $ref: "#/components/schemas/LogType" LogType: + description: "The following log types are supported for log delivery configuration: APPLICATION_LOGS – Application-level logs. USAGE_LOGS – Resource usage logs. SECURITY_FINDING_LOGS – Security finding logs. ACCESS_LOGS – Access logs (such as Elastic Load Balancing access logs). CONNECTION_LOGS – Connection logs. S3_SERVER_ACCESS_LOGS – Amazon S3 server access logs." type: string enum: - APPLICATION_LOGS @@ -1513,6 +1590,10 @@ components: - SECURITY_FINDING_LOGS - ACCESS_LOGS - CONNECTION_LOGS + - S3_SERVER_ACCESS_LOGS + - ALB_ACCESS_LOGS + - ALB_CONNECTION_LOGS + - ALB_HEALTH_CHECK_LOGS MskMonitoringParameters: description: Configuration parameters for Amazon MSK cluster monitoring, including enhanced monitoring level settings. type: object @@ -1528,6 +1609,11 @@ components: - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION + KmsKeyArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:\d{12}:key/(mrk-)?[a-f0-9-]+ Boolean: type: boolean AllRegions: @@ -1581,6 +1667,12 @@ components: FailureReason: $ref: "#/components/schemas/CentralizationFailureReason" description: The reason why an organization centralization rule is marked UNHEALTHY. + TagPropagationStatus: + $ref: "#/components/schemas/TagPropagationStatus" + description: The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed. + TagPropagationFailureReason: + $ref: "#/components/schemas/TagPropagationFailureReason" + description: The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy. CentralizationRule: $ref: "#/components/schemas/CentralizationRule" description: The configuration details for the organization centralization rule. @@ -1599,6 +1691,18 @@ components: - TRUSTED_ACCESS_NOT_ENABLED - DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION - INTERNAL_SERVER_ERROR + TagPropagationStatus: + description: The health status of tag propagation for a centralization rule. This status is independent of the overall RuleHealth for log delivery. + type: string + enum: + - Healthy + - Unhealthy + TagPropagationFailureReason: + description: The reason tag propagation is unhealthy for a centralization rule. RoleNotAssumable – The service cannot assume the destination role due to a trust policy or external ID misconfiguration. RoleLacksPermissions – The role was assumed successfully but the tag API call was denied by the role's permissions policy. + type: string + enum: + - RoleNotAssumable + - RoleLacksPermissions GetS3TableIntegrationOutput: type: object properties: @@ -1865,6 +1969,12 @@ components: FailureReason: $ref: "#/components/schemas/CentralizationFailureReason" description: The reason why an organization centralization rule is marked UNHEALTHY. + TagPropagationStatus: + $ref: "#/components/schemas/TagPropagationStatus" + description: The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed. + TagPropagationFailureReason: + $ref: "#/components/schemas/TagPropagationFailureReason" + description: The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy. DestinationAccountId: $ref: "#/components/schemas/String" description: The primary destination account of the organization centralization rule. @@ -2171,6 +2281,11 @@ components: enum: - STRING - JSON + SignalType: + type: string + enum: + - LOG + - METRIC TestTelemetryPipelineOutput: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/odb.yaml b/providers/src/aws/v00.00.00000/services/odb.yaml index c0ba0a13..e4d45530 100644 --- a/providers/src/aws/v00.00.00000/services/odb.yaml +++ b/providers/src/aws/v00.00.00000/services/odb.yaml @@ -92,6 +92,287 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateIamRoleToResourceOutput" + /AssociateVirtualMachinesToExadbVmCluster: + post: + operationId: AssociateVirtualMachinesToExadbVmCluster + description: Adds virtual machines to the specified Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.AssociateVirtualMachinesToExadbVmCluster + default: Odb.AssociateVirtualMachinesToExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster to add virtual machines to. + desiredNodeCount: + $ref: "#/components/schemas/AssociateVirtualMachinesToExadbVmClusterInputDesiredNodeCountInteger" + description: The desired number of nodes in the Exascale VM cluster after the association. + required: + - exadbVmClusterId + - desiredNodeCount + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AssociateVirtualMachinesToExadbVmClusterOutput" + /CreateAutonomousDatabase: + post: + operationId: CreateAutonomousDatabase + description: Creates a new Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.CreateAutonomousDatabase + default: Odb.CreateAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + odbNetworkId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the ODB network to be used for the Autonomous Database. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The user-friendly name for the Autonomous Database. The name does not have to be unique. + dbName: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputDbNameString" + description: The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account. + adminPassword: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputAdminPasswordString" + description: The password for the ADMIN user of the Autonomous Database. + computeCount: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputComputeCountDouble" + description: The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database. + dataStorageSizeInTBs: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputDataStorageSizeInTBsInteger" + description: The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database. + dataStorageSizeInGBs: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputDataStorageSizeInGBsInteger" + description: The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database. + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. + isAutoScalingEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database. + isAutoScalingForStorageEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable automatic scaling of the storage for the Autonomous Database. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model to apply to the Autonomous Database. + characterSet: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputCharacterSetString" + description: The character set to use for the Autonomous Database. + ncharacterSet: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputNcharacterSetString" + description: The national character set to use for the Autonomous Database. + dbVersion: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputDbVersionString" + description: The Oracle Database software version to use for the Autonomous Database. + databaseEdition: + $ref: "#/components/schemas/DatabaseEdition" + description: The Oracle Database edition to apply to the Autonomous Database. + standbyAllowlistedIpsSource: + $ref: "#/components/schemas/StandbyAllowlistedIpsSource" + description: The source of the allowlisted IP addresses for the standby Autonomous Database. + autonomousMaintenanceScheduleType: + $ref: "#/components/schemas/AutonomousMaintenanceScheduleType" + description: The maintenance schedule type for the Autonomous Database. + backupRetentionPeriodInDays: + $ref: "#/components/schemas/Integer" + description: The retention period, in days, for automatic backups of the Autonomous Database. + byolComputeCountLimit: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputByolComputeCountLimitDouble" + description: The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. + cpuCoreCount: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputCpuCoreCountInteger" + description: The number of CPU cores to allocate to the Autonomous Database. + customerContactsToSendToOCI: + $ref: "#/components/schemas/CustomerContacts" + description: The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database. + privateEndpointIp: + $ref: "#/components/schemas/String" + description: The private endpoint IP address for the Autonomous Database. + privateEndpointLabel: + $ref: "#/components/schemas/String" + description: The private endpoint label for the Autonomous Database. + resourcePoolLeaderId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the resource pool leader Autonomous Database. + resourcePoolSummary: + $ref: "#/components/schemas/ResourcePoolSummary" + description: The configuration of the resource pool for the Autonomous Database. + scheduledOperations: + $ref: "#/components/schemas/ScheduledOperationDetailsList" + description: The list of scheduled start and stop times for the Autonomous Database. + standbyAllowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the standby Autonomous Database. + allowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the Autonomous Database. + transportableTablespace: + $ref: "#/components/schemas/TransportableTablespace" + description: The transportable tablespace configuration to use when creating the Autonomous Database. + isBackupRetentionLocked: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened. + isLocalDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable local Oracle Data Guard for the Autonomous Database. + isMtlsConnectionRequired: + $ref: "#/components/schemas/Boolean" + description: Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. + dbToolsDetails: + $ref: "#/components/schemas/DatabaseToolList" + description: The list of database management tools to enable for the Autonomous Database. + source: + $ref: "#/components/schemas/SourceType" + description: The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy. + sourceConfiguration: + $ref: "#/components/schemas/SourceConfiguration" + description: The configuration details for the source used to create the Autonomous Database. + encryptionKeyProvider: + $ref: "#/components/schemas/EncryptionKeyProviderInput" + description: The provider of the encryption key to use for the Autonomous Database. + encryptionKeyConfiguration: + $ref: "#/components/schemas/EncryptionKeyConfigurationInput" + description: The configuration of the encryption key to use for the Autonomous Database. + adminPasswordSource: + $ref: "#/components/schemas/AdminPasswordSource" + description: The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret. + adminPasswordSourceConfiguration: + $ref: "#/components/schemas/AdminPasswordSourceConfigurationInput" + description: The configuration of the admin password source for the Autonomous Database. + clientToken: + $ref: "#/components/schemas/CreateAutonomousDatabaseInputClientTokenString" + description: A client-provided token to ensure the idempotency of the request. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAutonomousDatabaseOutput" + /CreateAutonomousDatabaseBackup: + post: + operationId: CreateAutonomousDatabaseBackup + description: Creates a new backup of the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.CreateAutonomousDatabaseBackup + default: Odb.CreateAutonomousDatabaseBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to back up. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The user-friendly name for the Autonomous Database backup. + retentionPeriodInDays: + $ref: "#/components/schemas/CreateAutonomousDatabaseBackupInputRetentionPeriodInDaysInteger" + description: The retention period, in days, for the Autonomous Database backup. + clientToken: + $ref: "#/components/schemas/CreateAutonomousDatabaseBackupInputClientTokenString" + description: A client-provided token to ensure the idempotency of the request. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAutonomousDatabaseBackupOutput" + /CreateAutonomousDatabaseWallet: + post: + operationId: CreateAutonomousDatabaseWallet + description: Creates a new wallet for the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.CreateAutonomousDatabaseWallet + default: Odb.CreateAutonomousDatabaseWallet + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to create a wallet for. + walletType: + $ref: "#/components/schemas/WalletType" + description: The type of wallet to create, either a regional wallet or an instance wallet. + password: + $ref: "#/components/schemas/CreateAutonomousDatabaseWalletInputPasswordString" + description: The password to encrypt the keys inside the wallet. + passwordSource: + $ref: "#/components/schemas/WalletPasswordSource" + description: The source of the password for encrypting the wallet. When set to CUSTOMER_MANAGED_AWS_SECRET, the password is retrieved from an Amazon Web Services Secrets Manager secret. + passwordSourceConfiguration: + $ref: "#/components/schemas/WalletPasswordSourceConfigurationInput" + description: The configuration of the password source for the Autonomous Database wallet. + clientToken: + $ref: "#/components/schemas/CreateAutonomousDatabaseWalletInputClientTokenString" + description: A client-provided token to ensure the idempotency of the request. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAutonomousDatabaseWalletOutput" /CreateCloudAutonomousVmCluster: post: operationId: CreateCloudAutonomousVmCluster @@ -282,7 +563,7 @@ paths: $ref: "#/components/schemas/CreateCloudVmClusterInputGiVersionString" description: "A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure. Example: 19.0.0.0" hostname: - $ref: "#/components/schemas/CreateCloudVmClusterInputHostnameString" + $ref: "#/components/schemas/Hostname" description: "The host name for the VM cluster. Constraints: Can't be \"localhost\" or \"hostname\". Can't contain \"-version\". The maximum length of the combined hostname and domain is 63 characters. The hostname must be unique within the subnet." sshPublicKeys: $ref: "#/components/schemas/StringList" @@ -291,7 +572,7 @@ paths: $ref: "#/components/schemas/ResourceIdOrArn" description: The unique identifier of the ODB network for the VM cluster. clusterName: - $ref: "#/components/schemas/CreateCloudVmClusterInputClusterNameString" + $ref: "#/components/schemas/ClusterName" description: A name for the Grid Infrastructure cluster. The name isn't case sensitive. dataCollectionOptions: $ref: "#/components/schemas/DataCollectionOptions" @@ -301,7 +582,7 @@ paths: description: The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster. dbNodeStorageSizeInGBs: $ref: "#/components/schemas/Integer" - description: The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster. + description: The amount of local node storage, in gigabytes (GB), to allocate for the VM cluster. dbServers: $ref: "#/components/schemas/StringList" description: The list of database servers for the VM cluster. @@ -319,7 +600,7 @@ paths: description: "The Oracle license model to apply to the VM cluster. Default: LICENSE_INCLUDED" memorySizeInGBs: $ref: "#/components/schemas/Integer" - description: The amount of memory, in gigabytes (GBs), to allocate for the VM cluster. + description: The amount of memory, in gigabytes (GB), to allocate for the VM cluster. systemVersion: $ref: "#/components/schemas/CreateCloudVmClusterInputSystemVersionString" description: The version of the operating system of the image for the VM cluster. @@ -347,6 +628,173 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateCloudVmClusterOutput" + /CreateExadbVmCluster: + post: + operationId: CreateExadbVmCluster + description: Creates an Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.CreateExadbVmCluster + default: Odb.CreateExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: A user-friendly name for the Exascale VM cluster. + enabledEcpuCount: + $ref: "#/components/schemas/CreateExadbVmClusterInputEnabledEcpuCountInteger" + description: The number of ECPUs to enable for the Exascale VM cluster. + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault for this Exascale VM cluster. + gridImageId: + $ref: "#/components/schemas/CreateExadbVmClusterInputGridImageIdString" + description: The Grid Infrastructure software image ID for the Exascale VM cluster. + hostname: + $ref: "#/components/schemas/Hostname" + description: The host name for the Exascale VM cluster. + nodeCount: + $ref: "#/components/schemas/CreateExadbVmClusterInputNodeCountInteger" + description: The number of nodes in the Exascale VM cluster. + odbNetworkId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the ODB network for the Exascale VM cluster. + shape: + $ref: "#/components/schemas/CreateExadbVmClusterInputShapeString" + description: The shape of the Exascale VM cluster. + sshPublicKeys: + $ref: "#/components/schemas/StringList" + description: The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. + totalEcpuCount: + $ref: "#/components/schemas/CreateExadbVmClusterInputTotalEcpuCountInteger" + description: The total number of ECPUs for the Exascale VM cluster. + vmFileSystemStorageTotalSizeInGBs: + $ref: "#/components/schemas/CreateExadbVmClusterInputVmFileSystemStorageTotalSizeInGBsInteger" + description: The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster. + clusterName: + $ref: "#/components/schemas/ClusterName" + description: A name for the Grid Infrastructure cluster. The name isn't case sensitive. + dataCollectionOptions: + $ref: "#/components/schemas/DataCollectionOptions" + description: The set of preferences for the various diagnostic collection options for the Exascale VM cluster. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model to apply to the Exascale VM cluster. + scanListenerPortTcp: + $ref: "#/components/schemas/CreateExadbVmClusterInputScanListenerPortTcpInteger" + description: The port number for TCP connections to the single client access name (SCAN) listener. + scanListenerPortTcpSsl: + $ref: "#/components/schemas/CreateExadbVmClusterInputScanListenerPortTcpSslInteger" + description: The port number for TCP connections with SSL to the single client access name (SCAN) listener. + shapeAttribute: + $ref: "#/components/schemas/ShapeAttribute" + description: The shape attribute for the Exascale VM cluster. + systemVersion: + $ref: "#/components/schemas/CreateExadbVmClusterInputSystemVersionString" + description: The version of the operating system of the image for the Exascale VM cluster. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: The list of resource tags to apply to the Exascale VM cluster. + timeZone: + $ref: "#/components/schemas/CreateExadbVmClusterInputTimeZoneString" + description: The time zone for the Exascale VM cluster. + clientToken: + $ref: "#/components/schemas/CreateExadbVmClusterInputClientTokenString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used. + required: + - displayName + - enabledEcpuCount + - exascaleDbStorageVaultId + - gridImageId + - hostname + - nodeCount + - odbNetworkId + - shape + - sshPublicKeys + - totalEcpuCount + - vmFileSystemStorageTotalSizeInGBs + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateExadbVmClusterOutput" + /CreateExascaleDbStorageVault: + post: + operationId: CreateExascaleDbStorageVault + description: Creates an Exascale storage vault. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.CreateExascaleDbStorageVault + default: Odb.CreateExascaleDbStorageVault + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: A user-friendly name for the Exascale storage vault. + highCapacityDatabaseStorageTotalSizeInGBs: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputHighCapacityDatabaseStorageTotalSizeInGBsInteger" + description: The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault. + additionalFlashCacheInPercent: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputAdditionalFlashCacheInPercentInteger" + description: The additional flash cache percentage for the Exascale storage vault. + autoscaleLimitInGBs: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputAutoscaleLimitInGBsInteger" + description: The autoscale limit in gigabytes (GB) for the Exascale storage vault. + availabilityZoneId: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputAvailabilityZoneIdString" + description: The Availability Zone ID for the Exascale storage vault. + availabilityZone: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputAvailabilityZoneString" + description: The Availability Zone for the Exascale storage vault. + description: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputDescriptionString" + description: A description of the Exascale storage vault. + isAutoscaleEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether autoscaling is enabled for the Exascale storage vault. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: The list of resource tags to apply to the Exascale storage vault. + timeZone: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputTimeZoneString" + description: The time zone for the Exascale storage vault. + clientToken: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultInputClientTokenString" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used. + required: + - displayName + - highCapacityDatabaseStorageTotalSizeInGBs + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateExascaleDbStorageVaultOutput" /CreateOdbNetwork: post: operationId: CreateOdbNetwork @@ -481,6 +929,72 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateOdbPeeringConnectionOutput" + /DeleteAutonomousDatabase: + post: + operationId: DeleteAutonomousDatabase + description: Deletes the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.DeleteAutonomousDatabase + default: Odb.DeleteAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to delete. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAutonomousDatabaseOutput" + /DeleteAutonomousDatabaseBackup: + post: + operationId: DeleteAutonomousDatabaseBackup + description: Deletes the specified Autonomous Database backup. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.DeleteAutonomousDatabaseBackup + default: Odb.DeleteAutonomousDatabaseBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database backup to delete. + required: + - autonomousDatabaseBackupId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAutonomousDatabaseBackupOutput" /DeleteCloudAutonomousVmCluster: post: operationId: DeleteCloudAutonomousVmCluster @@ -580,6 +1094,72 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteCloudVmClusterOutput" + /DeleteExadbVmCluster: + post: + operationId: DeleteExadbVmCluster + description: Deletes the specified Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.DeleteExadbVmCluster + default: Odb.DeleteExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster to delete. + required: + - exadbVmClusterId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteExadbVmClusterOutput" + /DeleteExascaleDbStorageVault: + post: + operationId: DeleteExascaleDbStorageVault + description: Deletes the specified Exascale storage vault. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.DeleteExascaleDbStorageVault + default: Odb.DeleteExascaleDbStorageVault + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault to delete. + required: + - exascaleDbStorageVaultId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteExascaleDbStorageVaultOutput" /DeleteOdbNetwork: post: operationId: DeleteOdbNetwork @@ -691,6 +1271,178 @@ paths: application/json: schema: $ref: "#/components/schemas/DisassociateIamRoleFromResourceOutput" + /DisassociateVirtualMachinesFromExadbVmCluster: + post: + operationId: DisassociateVirtualMachinesFromExadbVmCluster + description: Removes virtual machines from the specified Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.DisassociateVirtualMachinesFromExadbVmCluster + default: Odb.DisassociateVirtualMachinesFromExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster to remove virtual machines from. + dbNodeIds: + $ref: "#/components/schemas/ResourceIdList" + description: The list of DB node IDs to remove from the Exascale VM cluster. + required: + - exadbVmClusterId + - dbNodeIds + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisassociateVirtualMachinesFromExadbVmClusterOutput" + /FailoverAutonomousDatabase: + post: + operationId: FailoverAutonomousDatabase + description: Initiates a failover of the specified Autonomous Database to a standby peer database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.FailoverAutonomousDatabase + default: Odb.FailoverAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to fail over. + peerDbArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the peer Autonomous Database to fail over to. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/FailoverAutonomousDatabaseOutput" + /GetAutonomousDatabase: + post: + operationId: GetAutonomousDatabase + description: Gets information about a specific Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.GetAutonomousDatabase + default: Odb.GetAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to retrieve information about. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAutonomousDatabaseOutput" + /GetAutonomousDatabaseBackup: + post: + operationId: GetAutonomousDatabaseBackup + description: Gets information about a specific Autonomous Database backup. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.GetAutonomousDatabaseBackup + default: Odb.GetAutonomousDatabaseBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database backup to retrieve information about. + required: + - autonomousDatabaseBackupId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAutonomousDatabaseBackupOutput" + /GetAutonomousDatabaseWalletDetails: + post: + operationId: GetAutonomousDatabaseWalletDetails + description: Gets the wallet details for the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.GetAutonomousDatabaseWalletDetails + default: Odb.GetAutonomousDatabaseWalletDetails + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to retrieve wallet details for. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAutonomousDatabaseWalletDetailsOutput" /GetCloudAutonomousVmCluster: post: operationId: GetCloudAutonomousVmCluster @@ -849,12 +1601,14 @@ paths: properties: cloudVmClusterId: $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the VM cluster that contains the DB node. + description: The unique identifier of the VM cluster that contains the DB node. You must specify either this parameter or exadbVmClusterId. + exadbVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Exascale VM cluster that contains the DB node. You must specify either this parameter or cloudVmClusterId. dbNodeId: $ref: "#/components/schemas/ResourceId" description: The unique identifier of the DB node to retrieve information about. required: - - cloudVmClusterId - dbNodeId responses: "200": @@ -900,6 +1654,72 @@ paths: application/json: schema: $ref: "#/components/schemas/GetDbServerOutput" + /GetExadbVmCluster: + post: + operationId: GetExadbVmCluster + description: Returns information about the specified Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.GetExadbVmCluster + default: Odb.GetExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster. + required: + - exadbVmClusterId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetExadbVmClusterOutput" + /GetExascaleDbStorageVault: + post: + operationId: GetExascaleDbStorageVault + description: Returns information about the specified Exascale storage vault. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.GetExascaleDbStorageVault + default: Odb.GetExascaleDbStorageVault + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault. + required: + - exascaleDbStorageVaultId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetExascaleDbStorageVaultOutput" /GetOciOnboardingStatus: post: operationId: GetOciOnboardingStatus @@ -1017,6 +1837,9 @@ paths: ociIdentityDomain: $ref: "#/components/schemas/Boolean" description: The Oracle Cloud Infrastructure (OCI) identity domain configuration for service initialization. + autonomousDatabaseOciAwsSecretsManagerIntegration: + $ref: "#/components/schemas/Access" + description: Specifies whether to enable or disable the OCI service-account role for Amazon Web Services Secrets Manager integration with Autonomous Database. responses: "200": description: Success @@ -1024,10 +1847,10 @@ paths: application/json: schema: $ref: "#/components/schemas/InitializeServiceOutput" - /ListAutonomousVirtualMachines: + /ListAutonomousDatabaseBackups: post: - operationId: ListAutonomousVirtualMachines - description: Lists all Autonomous VMs in an Autonomous VM cluster. + operationId: ListAutonomousDatabaseBackups + description: Lists the backups of the specified Autonomous Database. parameters: - name: X-Amz-Target in: header @@ -1036,8 +1859,8 @@ paths: schema: type: string enum: - - Odb.ListAutonomousVirtualMachines - default: Odb.ListAutonomousVirtualMachines + - Odb.ListAutonomousDatabaseBackups + default: Odb.ListAutonomousDatabaseBackups requestBody: required: true content: @@ -1046,27 +1869,33 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListAutonomousVirtualMachinesInputMaxResultsInteger" - description: The maximum number of items to return per page. + $ref: "#/components/schemas/ListAutonomousDatabaseBackupsInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListAutonomousVirtualMachinesInputNextTokenString" - description: The pagination token to continue listing from. - cloudAutonomousVmClusterId: + $ref: "#/components/schemas/ListAutonomousDatabaseBackupsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + autonomousDatabaseId: $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the Autonomous VM cluster whose virtual machines you're listing. + description: The unique identifier of the Autonomous Database whose backups you want to list. + status: + $ref: "#/components/schemas/AutonomousDatabaseBackupStatus" + description: The status of the Autonomous Database backups to return results for. + type: + $ref: "#/components/schemas/AutonomousDatabaseBackupType" + description: The type of the Autonomous Database backups to return results for. required: - - cloudAutonomousVmClusterId + - autonomousDatabaseId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListAutonomousVirtualMachinesOutput" - /ListCloudAutonomousVmClusters: + $ref: "#/components/schemas/ListAutonomousDatabaseBackupsOutput" + /ListAutonomousDatabaseCharacterSets: post: - operationId: ListCloudAutonomousVmClusters - description: Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure. + operationId: ListAutonomousDatabaseCharacterSets + description: Lists the available character sets for Autonomous Databases. parameters: - name: X-Amz-Target in: header @@ -1075,8 +1904,8 @@ paths: schema: type: string enum: - - Odb.ListCloudAutonomousVmClusters - default: Odb.ListCloudAutonomousVmClusters + - Odb.ListAutonomousDatabaseCharacterSets + default: Odb.ListAutonomousDatabaseCharacterSets requestBody: required: true content: @@ -1085,25 +1914,25 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListCloudAutonomousVmClustersInputMaxResultsInteger" - description: The maximum number of items to return per page. + $ref: "#/components/schemas/ListAutonomousDatabaseCharacterSetsInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListCloudAutonomousVmClustersInputNextTokenString" - description: The pagination token to continue listing from. - cloudExadataInfrastructureId: - $ref: "#/components/schemas/ResourceIdOrArn" - description: The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed. + $ref: "#/components/schemas/ListAutonomousDatabaseCharacterSetsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + characterSetType: + $ref: "#/components/schemas/characterSetType" + description: The type of character set to return results for, either the database character set or the national character set. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListCloudAutonomousVmClustersOutput" - /ListCloudExadataInfrastructures: + $ref: "#/components/schemas/ListAutonomousDatabaseCharacterSetsOutput" + /ListAutonomousDatabaseClones: post: - operationId: ListCloudExadataInfrastructures - description: Returns information about the Exadata infrastructures owned by your Amazon Web Services account. + operationId: ListAutonomousDatabaseClones + description: Lists the clones of the specified Autonomous Database. parameters: - name: X-Amz-Target in: header @@ -1112,8 +1941,8 @@ paths: schema: type: string enum: - - Odb.ListCloudExadataInfrastructures - default: Odb.ListCloudExadataInfrastructures + - Odb.ListAutonomousDatabaseClones + default: Odb.ListAutonomousDatabaseClones requestBody: required: true content: @@ -1122,22 +1951,27 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListCloudExadataInfrastructuresInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListAutonomousDatabaseClonesInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListCloudExadataInfrastructuresInputNextTokenString" + $ref: "#/components/schemas/ListAutonomousDatabaseClonesInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the source Autonomous Database whose clones you want to list. + required: + - autonomousDatabaseId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListCloudExadataInfrastructuresOutput" - /ListCloudVmClusters: + $ref: "#/components/schemas/ListAutonomousDatabaseClonesOutput" + /ListAutonomousDatabasePeers: post: - operationId: ListCloudVmClusters - description: Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure. + operationId: ListAutonomousDatabasePeers + description: Lists the peer databases of the specified Autonomous Database. parameters: - name: X-Amz-Target in: header @@ -1146,8 +1980,8 @@ paths: schema: type: string enum: - - Odb.ListCloudVmClusters - default: Odb.ListCloudVmClusters + - Odb.ListAutonomousDatabasePeers + default: Odb.ListAutonomousDatabasePeers requestBody: required: true content: @@ -1156,25 +1990,27 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListCloudVmClustersInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListAutonomousDatabasePeersInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListCloudVmClustersInputNextTokenString" + $ref: "#/components/schemas/ListAutonomousDatabasePeersInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - cloudExadataInfrastructureId: + autonomousDatabaseId: $ref: "#/components/schemas/ResourceIdOrArn" - description: The unique identifier of the Oracle Exadata infrastructure. + description: The unique identifier of the Autonomous Database whose peer databases you want to list. + required: + - autonomousDatabaseId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListCloudVmClustersOutput" - /ListDbNodes: + $ref: "#/components/schemas/ListAutonomousDatabasePeersOutput" + /ListAutonomousDatabaseVersions: post: - operationId: ListDbNodes - description: Returns information about the DB nodes for the specified VM cluster. + operationId: ListAutonomousDatabaseVersions + description: Lists the available Oracle Database software versions for Autonomous Databases. parameters: - name: X-Amz-Target in: header @@ -1183,8 +2019,8 @@ paths: schema: type: string enum: - - Odb.ListDbNodes - default: Odb.ListDbNodes + - Odb.ListAutonomousDatabaseVersions + default: Odb.ListAutonomousDatabaseVersions requestBody: required: true content: @@ -1193,27 +2029,25 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListDbNodesInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListAutonomousDatabaseVersionsInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListDbNodesInputNextTokenString" + $ref: "#/components/schemas/ListAutonomousDatabaseVersionsInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - cloudVmClusterId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the VM cluster. - required: - - cloudVmClusterId + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database to return versions for, such as transaction processing, data warehouse, JSON database, or APEX. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListDbNodesOutput" - /ListDbServers: + $ref: "#/components/schemas/ListAutonomousDatabaseVersionsOutput" + /ListAutonomousDatabases: post: - operationId: ListDbServers - description: Returns information about the database servers that belong to the specified Exadata infrastructure. + operationId: ListAutonomousDatabases + description: Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region. parameters: - name: X-Amz-Target in: header @@ -1222,8 +2056,8 @@ paths: schema: type: string enum: - - Odb.ListDbServers - default: Odb.ListDbServers + - Odb.ListAutonomousDatabases + default: Odb.ListAutonomousDatabases requestBody: required: true content: @@ -1231,28 +2065,23 @@ paths: schema: type: object properties: - cloudExadataInfrastructureId: - $ref: "#/components/schemas/ResourceIdOrArn" - description: The unique identifier of the Oracle Exadata infrastructure. maxResults: - $ref: "#/components/schemas/ListDbServersInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListAutonomousDatabasesInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. nextToken: - $ref: "#/components/schemas/ListDbServersInputNextTokenString" + $ref: "#/components/schemas/ListAutonomousDatabasesInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - required: - - cloudExadataInfrastructureId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListDbServersOutput" - /ListDbSystemShapes: + $ref: "#/components/schemas/ListAutonomousDatabasesOutput" + /ListAutonomousVirtualMachines: post: - operationId: ListDbSystemShapes - description: Returns information about the shapes that are available for an Exadata infrastructure. + operationId: ListAutonomousVirtualMachines + description: Lists all Autonomous VMs in an Autonomous VM cluster. parameters: - name: X-Amz-Target in: header @@ -1261,8 +2090,8 @@ paths: schema: type: string enum: - - Odb.ListDbSystemShapes - default: Odb.ListDbSystemShapes + - Odb.ListAutonomousVirtualMachines + default: Odb.ListAutonomousVirtualMachines requestBody: required: true content: @@ -1271,28 +2100,27 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListDbSystemShapesInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListAutonomousVirtualMachinesInputMaxResultsInteger" + description: The maximum number of items to return per page. nextToken: - $ref: "#/components/schemas/ListDbSystemShapesInputNextTokenString" - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - availabilityZone: - $ref: "#/components/schemas/ListDbSystemShapesInputAvailabilityZoneString" - description: The logical name of the AZ, for example, us-east-1a. This name varies depending on the account. - availabilityZoneId: - $ref: "#/components/schemas/ListDbSystemShapesInputAvailabilityZoneIdString" - description: The physical ID of the AZ, for example, use1-az4. This ID persists across accounts. + $ref: "#/components/schemas/ListAutonomousVirtualMachinesInputNextTokenString" + description: The pagination token to continue listing from. + cloudAutonomousVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous VM cluster whose virtual machines you're listing. + required: + - cloudAutonomousVmClusterId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListDbSystemShapesOutput" - /ListGiVersions: + $ref: "#/components/schemas/ListAutonomousVirtualMachinesOutput" + /ListCloudAutonomousVmClusters: post: - operationId: ListGiVersions - description: Returns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape. + operationId: ListCloudAutonomousVmClusters + description: Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure. parameters: - name: X-Amz-Target in: header @@ -1301,8 +2129,8 @@ paths: schema: type: string enum: - - Odb.ListGiVersions - default: Odb.ListGiVersions + - Odb.ListCloudAutonomousVmClusters + default: Odb.ListCloudAutonomousVmClusters requestBody: required: true content: @@ -1311,25 +2139,25 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListGiVersionsInputMaxResultsInteger" - description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + $ref: "#/components/schemas/ListCloudAutonomousVmClustersInputMaxResultsInteger" + description: The maximum number of items to return per page. nextToken: - $ref: "#/components/schemas/ListGiVersionsInputNextTokenString" - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - shape: - $ref: "#/components/schemas/ListGiVersionsInputShapeString" - description: The shape to return GI versions for. For a list of valid shapes, use the ListDbSystemShapes operation.. + $ref: "#/components/schemas/ListCloudAutonomousVmClustersInputNextTokenString" + description: The pagination token to continue listing from. + cloudExadataInfrastructureId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListGiVersionsOutput" - /ListOdbNetworks: + $ref: "#/components/schemas/ListCloudAutonomousVmClustersOutput" + /ListCloudExadataInfrastructures: post: - operationId: ListOdbNetworks - description: Returns information about the ODB networks owned by your Amazon Web Services account. + operationId: ListCloudExadataInfrastructures + description: Returns information about the Exadata infrastructures owned by your Amazon Web Services account. parameters: - name: X-Amz-Target in: header @@ -1338,8 +2166,8 @@ paths: schema: type: string enum: - - Odb.ListOdbNetworks - default: Odb.ListOdbNetworks + - Odb.ListCloudExadataInfrastructures + default: Odb.ListCloudExadataInfrastructures requestBody: required: true content: @@ -1348,10 +2176,10 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListOdbNetworksInputMaxResultsInteger" + $ref: "#/components/schemas/ListCloudExadataInfrastructuresInputMaxResultsInteger" description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" nextToken: - $ref: "#/components/schemas/ListOdbNetworksInputNextTokenString" + $ref: "#/components/schemas/ListCloudExadataInfrastructuresInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. responses: "200": @@ -1359,11 +2187,11 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListOdbNetworksOutput" - /ListOdbPeeringConnections: + $ref: "#/components/schemas/ListCloudExadataInfrastructuresOutput" + /ListCloudVmClusters: post: - operationId: ListOdbPeeringConnections - description: Lists all ODB peering connections or those associated with a specific ODB network. + operationId: ListCloudVmClusters + description: Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure. parameters: - name: X-Amz-Target in: header @@ -1372,8 +2200,8 @@ paths: schema: type: string enum: - - Odb.ListOdbPeeringConnections - default: Odb.ListOdbPeeringConnections + - Odb.ListCloudVmClusters + default: Odb.ListCloudVmClusters requestBody: required: true content: @@ -1382,25 +2210,25 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListOdbPeeringConnectionsInputMaxResultsInteger" - description: "The maximum number of ODB peering connections to return in the response. Default: 20 Constraints: Must be between 1 and 100." + $ref: "#/components/schemas/ListCloudVmClustersInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" nextToken: - $ref: "#/components/schemas/ListOdbPeeringConnectionsInputNextTokenString" - description: The pagination token for the next page of ODB peering connections. - odbNetworkId: + $ref: "#/components/schemas/ListCloudVmClustersInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + cloudExadataInfrastructureId: $ref: "#/components/schemas/ResourceIdOrArn" - description: The identifier of the ODB network to list peering connections for. If not specified, lists all ODB peering connections in the account. + description: The unique identifier of the Oracle Exadata infrastructure. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListOdbPeeringConnectionsOutput" - /ListSystemVersions: + $ref: "#/components/schemas/ListCloudVmClustersOutput" + /ListDbNodes: post: - operationId: ListSystemVersions - description: Returns information about the system versions that are available for a VM cluster for the specified giVersion and shape. + operationId: ListDbNodes + description: Returns information about the DB nodes for the specified VM cluster. parameters: - name: X-Amz-Target in: header @@ -1409,8 +2237,8 @@ paths: schema: type: string enum: - - Odb.ListSystemVersions - default: Odb.ListSystemVersions + - Odb.ListDbNodes + default: Odb.ListDbNodes requestBody: required: true content: @@ -1419,31 +2247,28 @@ paths: type: object properties: maxResults: - $ref: "#/components/schemas/ListSystemVersionsInputMaxResultsInteger" + $ref: "#/components/schemas/ListDbNodesInputMaxResultsInteger" description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" nextToken: - $ref: "#/components/schemas/ListSystemVersionsInputNextTokenString" + $ref: "#/components/schemas/ListDbNodesInputNextTokenString" description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. - giVersion: - $ref: "#/components/schemas/ListSystemVersionsInputGiVersionString" - description: The software version of the Exadata Grid Infrastructure (GI). - shape: - $ref: "#/components/schemas/ListSystemVersionsInputShapeString" - description: The Exadata hardware system model. - required: - - giVersion - - shape + cloudVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the VM cluster. You must specify either this parameter or exadbVmClusterId. + exadbVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Exascale VM cluster. You must specify either this parameter or cloudVmClusterId. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListSystemVersionsOutput" - /ListTagsForResource: + $ref: "#/components/schemas/ListDbNodesOutput" + /ListDbServers: post: - operationId: ListTagsForResource - description: Returns information about the tags applied to this resource. + operationId: ListDbServers + description: Returns information about the database servers that belong to the specified Exadata infrastructure. parameters: - name: X-Amz-Target in: header @@ -1452,8 +2277,8 @@ paths: schema: type: string enum: - - Odb.ListTagsForResource - default: Odb.ListTagsForResource + - Odb.ListDbServers + default: Odb.ListDbServers requestBody: required: true content: @@ -1461,22 +2286,28 @@ paths: schema: type: object properties: - resourceArn: - $ref: "#/components/schemas/ResourceArn" - description: The Amazon Resource Name (ARN) of the resource to list tags for. + cloudExadataInfrastructureId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Oracle Exadata infrastructure. + maxResults: + $ref: "#/components/schemas/ListDbServersInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + nextToken: + $ref: "#/components/schemas/ListDbServersInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. required: - - resourceArn + - cloudExadataInfrastructureId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListTagsForResourceResponse" - /RebootDbNode: + $ref: "#/components/schemas/ListDbServersOutput" + /ListDbSystemShapes: post: - operationId: RebootDbNode - description: Reboots the specified DB node in a VM cluster. + operationId: ListDbSystemShapes + description: Returns information about the shapes that are available for an Exadata infrastructure. parameters: - name: X-Amz-Target in: header @@ -1485,8 +2316,8 @@ paths: schema: type: string enum: - - Odb.RebootDbNode - default: Odb.RebootDbNode + - Odb.ListDbSystemShapes + default: Odb.ListDbSystemShapes requestBody: required: true content: @@ -1494,26 +2325,32 @@ paths: schema: type: object properties: - cloudVmClusterId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the VM cluster that contains the DB node to reboot. - dbNodeId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the DB node to reboot. - required: - - cloudVmClusterId - - dbNodeId + maxResults: + $ref: "#/components/schemas/ListDbSystemShapesInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + nextToken: + $ref: "#/components/schemas/ListDbSystemShapesInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + availabilityZone: + $ref: "#/components/schemas/ListDbSystemShapesInputAvailabilityZoneString" + description: The logical name of the AZ, for example, us-east-1a. This name varies depending on the account. + availabilityZoneId: + $ref: "#/components/schemas/ListDbSystemShapesInputAvailabilityZoneIdString" + description: The physical ID of the AZ, for example, use1-az4. This ID persists across accounts. + shapeFamily: + $ref: "#/components/schemas/ListDbSystemShapesInputShapeFamilyString" + description: The shape family to filter results by. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/RebootDbNodeOutput" - /StartDbNode: + $ref: "#/components/schemas/ListDbSystemShapesOutput" + /ListExadbVmClusters: post: - operationId: StartDbNode - description: Starts the specified DB node in a VM cluster. + operationId: ListExadbVmClusters + description: Returns information about the Exascale VM clusters owned by your Amazon Web Services account. parameters: - name: X-Amz-Target in: header @@ -1522,8 +2359,8 @@ paths: schema: type: string enum: - - Odb.StartDbNode - default: Odb.StartDbNode + - Odb.ListExadbVmClusters + default: Odb.ListExadbVmClusters requestBody: required: true content: @@ -1531,26 +2368,26 @@ paths: schema: type: object properties: - cloudVmClusterId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the VM cluster that contains the DB node to start. - dbNodeId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the DB node to start. - required: - - cloudVmClusterId - - dbNodeId + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault to list the associated Exascale VM clusters. + maxResults: + $ref: "#/components/schemas/ListExadbVmClustersInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. + nextToken: + $ref: "#/components/schemas/ListExadbVmClustersInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/StartDbNodeOutput" - /StopDbNode: + $ref: "#/components/schemas/ListExadbVmClustersOutput" + /ListExascaleDbStorageVaults: post: - operationId: StopDbNode - description: Stops the specified DB node in a VM cluster. + operationId: ListExascaleDbStorageVaults + description: Returns information about the Exascale storage vaults owned by your Amazon Web Services account. parameters: - name: X-Amz-Target in: header @@ -1559,8 +2396,8 @@ paths: schema: type: string enum: - - Odb.StopDbNode - default: Odb.StopDbNode + - Odb.ListExascaleDbStorageVaults + default: Odb.ListExascaleDbStorageVaults requestBody: required: true content: @@ -1568,26 +2405,23 @@ paths: schema: type: object properties: - cloudVmClusterId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the VM cluster that contains the DB node to stop. - dbNodeId: - $ref: "#/components/schemas/ResourceId" - description: The unique identifier of the DB node to stop. - required: - - cloudVmClusterId - - dbNodeId + maxResults: + $ref: "#/components/schemas/ListExascaleDbStorageVaultsInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. + nextToken: + $ref: "#/components/schemas/ListExascaleDbStorageVaultsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/StopDbNodeOutput" - /TagResource: + $ref: "#/components/schemas/ListExascaleDbStorageVaultsOutput" + /ListGiMinorVersions: post: - operationId: TagResource - description: Applies tags to the specified resource. + operationId: ListGiMinorVersions + description: Returns a list of the Oracle Grid Infrastructure (GI) minor versions for the specified major version. parameters: - name: X-Amz-Target in: header @@ -1596,8 +2430,8 @@ paths: schema: type: string enum: - - Odb.TagResource - default: Odb.TagResource + - Odb.ListGiMinorVersions + default: Odb.ListGiMinorVersions requestBody: required: true content: @@ -1605,26 +2439,37 @@ paths: schema: type: object properties: - resourceArn: - $ref: "#/components/schemas/ResourceArn" - description: The Amazon Resource Name (ARN) of the resource to apply tags to. - tags: - $ref: "#/components/schemas/RequestTagMap" - description: The list of tags to apply to the resource. + giVersion: + $ref: "#/components/schemas/ListGiMinorVersionsInputGiVersionString" + description: The Oracle Grid Infrastructure (GI) major version. + maxResults: + $ref: "#/components/schemas/ListGiMinorVersionsInputMaxResultsInteger" + description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. + nextToken: + $ref: "#/components/schemas/ListGiMinorVersionsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + shapeFamily: + $ref: "#/components/schemas/ListGiMinorVersionsInputShapeFamilyString" + description: The shape family for the GI minor version. + availabilityZone: + $ref: "#/components/schemas/ListGiMinorVersionsInputAvailabilityZoneString" + description: The Availability Zone to filter GI minor versions. + availabilityZoneId: + $ref: "#/components/schemas/ListGiMinorVersionsInputAvailabilityZoneIdString" + description: The Availability Zone ID to filter GI minor versions. required: - - resourceArn - - tags + - giVersion responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/TagResourceResponse" - /UntagResource: + $ref: "#/components/schemas/ListGiMinorVersionsOutput" + /ListGiVersions: post: - operationId: UntagResource - description: Removes tags from the specified resource. + operationId: ListGiVersions + description: Returns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape. parameters: - name: X-Amz-Target in: header @@ -1633,8 +2478,8 @@ paths: schema: type: string enum: - - Odb.UntagResource - default: Odb.UntagResource + - Odb.ListGiVersions + default: Odb.ListGiVersions requestBody: required: true content: @@ -1642,26 +2487,26 @@ paths: schema: type: object properties: - resourceArn: - $ref: "#/components/schemas/ResourceArn" - description: The Amazon Resource Name (ARN) of the resource to remove tags from. - tagKeys: - $ref: "#/components/schemas/TagKeys" - description: The names (keys) of the tags to remove from the resource. - required: - - resourceArn - - tagKeys + maxResults: + $ref: "#/components/schemas/ListGiVersionsInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + nextToken: + $ref: "#/components/schemas/ListGiVersionsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + shape: + $ref: "#/components/schemas/ListGiVersionsInputShapeString" + description: The shape to return GI versions for. For a list of valid shapes, use the ListDbSystemShapes operation.. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/UntagResourceResponse" - /UpdateCloudExadataInfrastructure: + $ref: "#/components/schemas/ListGiVersionsOutput" + /ListOdbNetworks: post: - operationId: UpdateCloudExadataInfrastructure - description: Updates the properties of an Exadata infrastructure resource. + operationId: ListOdbNetworks + description: Returns information about the ODB networks owned by your Amazon Web Services account. parameters: - name: X-Amz-Target in: header @@ -1670,8 +2515,8 @@ paths: schema: type: string enum: - - Odb.UpdateCloudExadataInfrastructure - default: Odb.UpdateCloudExadataInfrastructure + - Odb.ListOdbNetworks + default: Odb.ListOdbNetworks requestBody: required: true content: @@ -1679,24 +2524,23 @@ paths: schema: type: object properties: - cloudExadataInfrastructureId: - $ref: "#/components/schemas/ResourceIdOrArn" - description: The unique identifier of the Exadata infrastructure to update. - maintenanceWindow: - $ref: "#/components/schemas/MaintenanceWindow" - required: - - cloudExadataInfrastructureId + maxResults: + $ref: "#/components/schemas/ListOdbNetworksInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + nextToken: + $ref: "#/components/schemas/ListOdbNetworksInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/UpdateCloudExadataInfrastructureOutput" - /UpdateOdbNetwork: + $ref: "#/components/schemas/ListOdbNetworksOutput" + /ListOdbPeeringConnections: post: - operationId: UpdateOdbNetwork - description: Updates properties of a specified ODB network. + operationId: ListOdbPeeringConnections + description: Lists all ODB peering connections or those associated with a specific ODB network. parameters: - name: X-Amz-Target in: header @@ -1705,8 +2549,8 @@ paths: schema: type: string enum: - - Odb.UpdateOdbNetwork - default: Odb.UpdateOdbNetwork + - Odb.ListOdbPeeringConnections + default: Odb.ListOdbPeeringConnections requestBody: required: true content: @@ -1714,58 +2558,69 @@ paths: schema: type: object properties: + maxResults: + $ref: "#/components/schemas/ListOdbPeeringConnectionsInputMaxResultsInteger" + description: "The maximum number of ODB peering connections to return in the response. Default: 20 Constraints: Must be between 1 and 100." + nextToken: + $ref: "#/components/schemas/ListOdbPeeringConnectionsInputNextTokenString" + description: The pagination token for the next page of ODB peering connections. odbNetworkId: $ref: "#/components/schemas/ResourceIdOrArn" - description: The unique identifier of the ODB network to update. - displayName: - $ref: "#/components/schemas/ResourceDisplayName" - description: The new user-friendly name of the ODB network. - peeredCidrsToBeAdded: - $ref: "#/components/schemas/StringList" - description: The list of CIDR ranges from the peered VPC that allow access to the ODB network. - peeredCidrsToBeRemoved: - $ref: "#/components/schemas/StringList" - description: The list of CIDR ranges from the peered VPC to remove from the ODB network. - s3Access: - $ref: "#/components/schemas/Access" - description: Specifies the updated configuration for Amazon S3 access from the ODB network. - zeroEtlAccess: - $ref: "#/components/schemas/Access" - description: Specifies the updated configuration for Zero-ETL access from the ODB network. - stsAccess: - $ref: "#/components/schemas/Access" - description: The Amazon Web Services Security Token Service (STS) access configuration for the ODB network. - kmsAccess: - $ref: "#/components/schemas/Access" - description: The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network. - s3PolicyDocument: - $ref: "#/components/schemas/PolicyDocument" - description: Specifies the updated endpoint policy for Amazon S3 access from the ODB network. - stsPolicyDocument: - $ref: "#/components/schemas/PolicyDocument" - description: The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network. - kmsPolicyDocument: - $ref: "#/components/schemas/PolicyDocument" - description: The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network. - crossRegionS3RestoreSourcesToEnable: - $ref: "#/components/schemas/StringList" - description: The cross-Region Amazon S3 restore sources to enable for the ODB network. - crossRegionS3RestoreSourcesToDisable: - $ref: "#/components/schemas/StringList" - description: The cross-Region Amazon S3 restore sources to disable for the ODB network. + description: The identifier of the ODB network to list peering connections for. If not specified, lists all ODB peering connections in the account. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListOdbPeeringConnectionsOutput" + /ListSystemVersions: + post: + operationId: ListSystemVersions + description: Returns information about the system versions that are available for a VM cluster for the specified giVersion and shape. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.ListSystemVersions + default: Odb.ListSystemVersions + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/ListSystemVersionsInputMaxResultsInteger" + description: "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. Default: 10" + nextToken: + $ref: "#/components/schemas/ListSystemVersionsInputNextTokenString" + description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. + giVersion: + $ref: "#/components/schemas/ListSystemVersionsInputGiVersionString" + description: The software version of the Exadata Grid Infrastructure (GI). + shape: + $ref: "#/components/schemas/ListSystemVersionsInputShapeString" + description: The Exadata hardware system model. required: - - odbNetworkId + - giVersion + - shape responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/UpdateOdbNetworkOutput" - /UpdateOdbPeeringConnection: + $ref: "#/components/schemas/ListSystemVersionsOutput" + /ListTagsForResource: post: - operationId: UpdateOdbPeeringConnection - description: Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection. + operationId: ListTagsForResource + description: Returns information about the tags applied to this resource. parameters: - name: X-Amz-Target in: header @@ -1774,8 +2629,8 @@ paths: schema: type: string enum: - - Odb.UpdateOdbPeeringConnection - default: Odb.UpdateOdbPeeringConnection + - Odb.ListTagsForResource + default: Odb.ListTagsForResource requestBody: required: true content: @@ -1783,51 +2638,902 @@ paths: schema: type: object properties: - odbPeeringConnectionId: + resourceArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the resource to list tags for. + required: + - resourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + /RebootAutonomousDatabase: + post: + operationId: RebootAutonomousDatabase + description: Reboots the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.RebootAutonomousDatabase + default: Odb.RebootAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: $ref: "#/components/schemas/ResourceIdOrArn" - description: The identifier of the Oracle Database@Amazon Web Services peering connection to update. - displayName: - $ref: "#/components/schemas/ResourceDisplayName" - description: A new display name for the peering connection. - peerNetworkCidrsToBeAdded: - $ref: "#/components/schemas/PeeredCidrList" - description: A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@Amazon Web Services network. - peerNetworkCidrsToBeRemoved: - $ref: "#/components/schemas/PeeredCidrList" - description: A list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection. + description: The unique identifier of the Autonomous Database to reboot. + isOnlineReboot: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to perform an online reboot of the Autonomous Database without interrupting active connections. required: - - odbPeeringConnectionId + - autonomousDatabaseId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/UpdateOdbPeeringConnectionOutput" -components: - parameters: - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false + $ref: "#/components/schemas/RebootAutonomousDatabaseOutput" + /RebootDbNode: + post: + operationId: RebootDbNode + description: Reboots the specified DB node in a VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.RebootDbNode + default: Odb.RebootDbNode + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + cloudVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the VM cluster that contains the DB node to reboot. You must specify either this parameter or exadbVmClusterId. + exadbVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Exascale VM cluster that contains the DB node to reboot. You must specify either this parameter or cloudVmClusterId. + dbNodeId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the DB node to reboot. + required: + - dbNodeId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RebootDbNodeOutput" + /RestoreAutonomousDatabase: + post: + operationId: RestoreAutonomousDatabase + description: Restores the specified Autonomous Database to a point in time. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.RestoreAutonomousDatabase + default: Odb.RestoreAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to restore. + timestamp: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time to which to restore the Autonomous Database. + required: + - autonomousDatabaseId + - timestamp + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RestoreAutonomousDatabaseOutput" + /ShrinkAutonomousDatabase: + post: + operationId: ShrinkAutonomousDatabase + description: Shrinks the storage of the specified Autonomous Database to reclaim unused space. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.ShrinkAutonomousDatabase + default: Odb.ShrinkAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to shrink. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ShrinkAutonomousDatabaseOutput" + /StartAutonomousDatabase: + post: + operationId: StartAutonomousDatabase + description: Starts the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.StartAutonomousDatabase + default: Odb.StartAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to start. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartAutonomousDatabaseOutput" + /StartDbNode: + post: + operationId: StartDbNode + description: Starts the specified DB node in a VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.StartDbNode + default: Odb.StartDbNode + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + cloudVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the VM cluster that contains the DB node to start. You must specify either this parameter or exadbVmClusterId. + exadbVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Exascale VM cluster that contains the DB node to start. You must specify either this parameter or cloudVmClusterId. + dbNodeId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the DB node to start. + required: + - dbNodeId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartDbNodeOutput" + /StopAutonomousDatabase: + post: + operationId: StopAutonomousDatabase + description: Stops the specified Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.StopAutonomousDatabase + default: Odb.StopAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to stop. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StopAutonomousDatabaseOutput" + /StopDbNode: + post: + operationId: StopDbNode + description: Stops the specified DB node in a VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.StopDbNode + default: Odb.StopDbNode + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + cloudVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or exadbVmClusterId. + exadbVmClusterId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or cloudVmClusterId. + dbNodeId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the DB node to stop. + required: + - dbNodeId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StopDbNodeOutput" + /SwitchoverAutonomousDatabase: + post: + operationId: SwitchoverAutonomousDatabase + description: Performs a switchover of the specified Autonomous Database to a standby peer database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.SwitchoverAutonomousDatabase + default: Odb.SwitchoverAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to switch over. + peerDbArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the peer Autonomous Database to switch over to. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SwitchoverAutonomousDatabaseOutput" + /TagResource: + post: + operationId: TagResource + description: Applies tags to the specified resource. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.TagResource + default: Odb.TagResource + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + resourceArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the resource to apply tags to. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: The list of tags to apply to the resource. + required: + - resourceArn + - tags + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceResponse" + /UntagResource: + post: + operationId: UntagResource + description: Removes tags from the specified resource. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UntagResource + default: Odb.UntagResource + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + resourceArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the resource to remove tags from. + tagKeys: + $ref: "#/components/schemas/TagKeys" + description: The names (keys) of the tags to remove from the resource. + required: + - resourceArn + - tagKeys + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceResponse" + /UpdateAutonomousDatabase: + post: + operationId: UpdateAutonomousDatabase + description: Updates the properties of an Autonomous Database. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateAutonomousDatabase + default: Odb.UpdateAutonomousDatabase + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database to update. + adminPassword: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputAdminPasswordString" + description: The new password for the ADMIN user of the Autonomous Database. + computeCount: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputComputeCountDouble" + description: The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database. + cpuCoreCount: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputCpuCoreCountInteger" + description: The number of CPU cores to allocate to the Autonomous Database. + dataStorageSizeInTBs: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputDataStorageSizeInTBsInteger" + description: The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database. + dataStorageSizeInGBs: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputDataStorageSizeInGBsInteger" + description: The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The new user-friendly name for the Autonomous Database. + dbName: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputDbNameString" + description: The new name of the Autonomous Database. + dbVersion: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputDbVersionString" + description: The Oracle Database software version to use for the Autonomous Database. + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. + dbToolsDetails: + $ref: "#/components/schemas/DatabaseToolList" + description: The list of database management tools to enable for the Autonomous Database. + databaseEdition: + $ref: "#/components/schemas/DatabaseEdition" + description: The Oracle Database edition to apply to the Autonomous Database. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model to apply to the Autonomous Database. + isAutoScalingEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database. + isAutoScalingForStorageEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable automatic scaling of the storage for the Autonomous Database. + isBackupRetentionLocked: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened. + isLocalDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to enable local Oracle Data Guard for the Autonomous Database. + isMtlsConnectionRequired: + $ref: "#/components/schemas/Boolean" + description: Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. + isRefreshableClone: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the Autonomous Database is a refreshable clone. + isDisconnectPeer: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to disconnect the Autonomous Database from its peer database. + backupRetentionPeriodInDays: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputBackupRetentionPeriodInDaysInteger" + description: The retention period, in days, for automatic backups of the Autonomous Database. + byolComputeCountLimit: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputByolComputeCountLimitDouble" + description: The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. + localAdgAutoFailoverMaxDataLossLimit: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputLocalAdgAutoFailoverMaxDataLossLimitInteger" + description: The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database. + autonomousMaintenanceScheduleType: + $ref: "#/components/schemas/AutonomousMaintenanceScheduleType" + description: The maintenance schedule type for the Autonomous Database. + customerContactsToSendToOCI: + $ref: "#/components/schemas/CustomerContacts" + description: The list of customer contacts to receive operational notifications from OCI for the Autonomous Database. + scheduledOperations: + $ref: "#/components/schemas/ScheduledOperationDetailsList" + description: The list of scheduled start and stop times for the Autonomous Database. + longTermBackupSchedule: + $ref: "#/components/schemas/LongTermBackupSchedule" + description: The long-term backup schedule for the Autonomous Database. + openMode: + $ref: "#/components/schemas/OpenMode" + description: The mode in which to open the Autonomous Database, either read-only or read/write. + permissionLevel: + $ref: "#/components/schemas/PermissionLevel" + description: The permission level of the Autonomous Database. + refreshableMode: + $ref: "#/components/schemas/RefreshableMode" + description: The refresh mode of the refreshable clone Autonomous Database. + privateEndpointIp: + $ref: "#/components/schemas/String" + description: The private endpoint IP address for the Autonomous Database. + privateEndpointLabel: + $ref: "#/components/schemas/String" + description: The private endpoint label for the Autonomous Database. + peerDbId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the peer Autonomous Database. + resourcePoolLeaderId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the resource pool leader Autonomous Database. + resourcePoolSummary: + $ref: "#/components/schemas/ResourcePoolSummary" + description: The configuration of the resource pool for the Autonomous Database. + standbyAllowlistedIpsSource: + $ref: "#/components/schemas/StandbyAllowlistedIpsSource" + description: The source of the allowlisted IP addresses for the standby Autonomous Database. + standbyAllowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the standby Autonomous Database. + allowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the Autonomous Database. + autoRefreshFrequencyInSeconds: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputAutoRefreshFrequencyInSecondsInteger" + description: The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed. + autoRefreshPointLagInSeconds: + $ref: "#/components/schemas/UpdateAutonomousDatabaseInputAutoRefreshPointLagInSecondsInteger" + description: The time lag, in seconds, between the refreshable clone and its source Autonomous Database. + timeOfAutoRefreshStart: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts. + encryptionKeyProvider: + $ref: "#/components/schemas/EncryptionKeyProviderInput" + description: The provider of the encryption key to use for the Autonomous Database. + encryptionKeyConfiguration: + $ref: "#/components/schemas/EncryptionKeyConfigurationInput" + description: The configuration of the encryption key to use for the Autonomous Database. + adminPasswordSource: + $ref: "#/components/schemas/AdminPasswordSource" + description: The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret. + adminPasswordSourceConfiguration: + $ref: "#/components/schemas/AdminPasswordSourceConfigurationInput" + description: The configuration of the admin password source for the Autonomous Database. + required: + - autonomousDatabaseId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAutonomousDatabaseOutput" + /UpdateAutonomousDatabaseBackup: + post: + operationId: UpdateAutonomousDatabaseBackup + description: Updates the properties of an Autonomous Database backup. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateAutonomousDatabaseBackup + default: Odb.UpdateAutonomousDatabaseBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database backup to update. + retentionPeriodInDays: + $ref: "#/components/schemas/UpdateAutonomousDatabaseBackupInputRetentionPeriodInDaysInteger" + description: The retention period, in days, for the Autonomous Database backup. + required: + - autonomousDatabaseBackupId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAutonomousDatabaseBackupOutput" + /UpdateCloudExadataInfrastructure: + post: + operationId: UpdateCloudExadataInfrastructure + description: Updates the properties of an Exadata infrastructure resource. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateCloudExadataInfrastructure + default: Odb.UpdateCloudExadataInfrastructure + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + cloudExadataInfrastructureId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exadata infrastructure to update. + maintenanceWindow: + $ref: "#/components/schemas/MaintenanceWindow" + required: + - cloudExadataInfrastructureId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateCloudExadataInfrastructureOutput" + /UpdateExadbVmCluster: + post: + operationId: UpdateExadbVmCluster + description: Updates the specified Exascale VM cluster. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateExadbVmCluster + default: Odb.UpdateExadbVmCluster + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster to update. + dataCollectionOptions: + $ref: "#/components/schemas/DataCollectionOptions" + description: The set of preferences for the various diagnostic collection options for the Exascale VM cluster. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: A new user-friendly name for the Exascale VM cluster. + enabledEcpuCount: + $ref: "#/components/schemas/UpdateExadbVmClusterInputEnabledEcpuCountInteger" + description: The number of ECPUs to enable for the Exascale VM cluster. + gridImageId: + $ref: "#/components/schemas/UpdateExadbVmClusterInputGridImageIdString" + description: The Grid Infrastructure software image ID for the Exascale VM cluster. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model to apply to the Exascale VM cluster. + sshPublicKeys: + $ref: "#/components/schemas/StringList" + description: The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. + systemVersion: + $ref: "#/components/schemas/UpdateExadbVmClusterInputSystemVersionString" + description: The version of the operating system of the image for the Exascale VM cluster. + totalEcpuCount: + $ref: "#/components/schemas/UpdateExadbVmClusterInputTotalEcpuCountInteger" + description: The total number of ECPUs for the Exascale VM cluster. + updateAction: + $ref: "#/components/schemas/UpdateAction" + description: The update action to perform on the Exascale VM cluster. + vmFileSystemStorageTotalSizeInGBs: + $ref: "#/components/schemas/UpdateExadbVmClusterInputVmFileSystemStorageTotalSizeInGBsInteger" + description: The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster. + required: + - exadbVmClusterId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateExadbVmClusterOutput" + /UpdateExascaleDbStorageVault: + post: + operationId: UpdateExascaleDbStorageVault + description: Updates the specified Exascale storage vault. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateExascaleDbStorageVault + default: Odb.UpdateExascaleDbStorageVault + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault to update. + additionalFlashCacheInPercent: + $ref: "#/components/schemas/UpdateExascaleDbStorageVaultInputAdditionalFlashCacheInPercentInteger" + description: The additional flash cache percentage for the Exascale storage vault. + autoscaleLimitInGBs: + $ref: "#/components/schemas/UpdateExascaleDbStorageVaultInputAutoscaleLimitInGBsInteger" + description: The autoscale limit in gigabytes (GB) for the Exascale storage vault. + description: + $ref: "#/components/schemas/UpdateExascaleDbStorageVaultInputDescriptionString" + description: A new description for the Exascale storage vault. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: A new user-friendly name for the Exascale storage vault. + highCapacityDatabaseStorageTotalSizeInGBs: + $ref: "#/components/schemas/UpdateExascaleDbStorageVaultInputHighCapacityDatabaseStorageTotalSizeInGBsInteger" + description: The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault. + isAutoscaleEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether autoscaling is enabled for the Exascale storage vault. + required: + - exascaleDbStorageVaultId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateExascaleDbStorageVaultOutput" + /UpdateOdbNetwork: + post: + operationId: UpdateOdbNetwork + description: Updates properties of a specified ODB network. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateOdbNetwork + default: Odb.UpdateOdbNetwork + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + odbNetworkId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the ODB network to update. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The new user-friendly name of the ODB network. + peeredCidrsToBeAdded: + $ref: "#/components/schemas/StringList" + description: The list of CIDR ranges from the peered VPC that allow access to the ODB network. + peeredCidrsToBeRemoved: + $ref: "#/components/schemas/StringList" + description: The list of CIDR ranges from the peered VPC to remove from the ODB network. + s3Access: + $ref: "#/components/schemas/Access" + description: Specifies the updated configuration for Amazon S3 access from the ODB network. + zeroEtlAccess: + $ref: "#/components/schemas/Access" + description: Specifies the updated configuration for Zero-ETL access from the ODB network. + stsAccess: + $ref: "#/components/schemas/Access" + description: The Amazon Web Services Security Token Service (STS) access configuration for the ODB network. + kmsAccess: + $ref: "#/components/schemas/Access" + description: The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network. + s3PolicyDocument: + $ref: "#/components/schemas/PolicyDocument" + description: Specifies the updated endpoint policy for Amazon S3 access from the ODB network. + stsPolicyDocument: + $ref: "#/components/schemas/PolicyDocument" + description: The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network. + kmsPolicyDocument: + $ref: "#/components/schemas/PolicyDocument" + description: The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network. + crossRegionS3RestoreSourcesToEnable: + $ref: "#/components/schemas/StringList" + description: The cross-Region Amazon S3 restore sources to enable for the ODB network. + crossRegionS3RestoreSourcesToDisable: + $ref: "#/components/schemas/StringList" + description: The cross-Region Amazon S3 restore sources to disable for the ODB network. + required: + - odbNetworkId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateOdbNetworkOutput" + /UpdateOdbPeeringConnection: + post: + operationId: UpdateOdbPeeringConnection + description: Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Odb.UpdateOdbPeeringConnection + default: Odb.UpdateOdbPeeringConnection + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + odbPeeringConnectionId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The identifier of the Oracle Database@Amazon Web Services peering connection to update. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: A new display name for the peering connection. + peerNetworkCidrsToBeAdded: + $ref: "#/components/schemas/PeeredCidrList" + description: A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@Amazon Web Services network. + peerNetworkCidrsToBeRemoved: + $ref: "#/components/schemas/PeeredCidrList" + description: A list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection. + required: + - odbPeeringConnectionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateOdbPeeringConnectionOutput" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false schema: type: string X-Amz-Security-Token: @@ -1851,462 +3557,1919 @@ components: schemas: String: type: string - AcceptMarketplaceRegistrationOutput: + AcceptMarketplaceRegistrationOutput: + type: object + RoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+ + SupportedAwsIntegration: + type: string + enum: + - KmsTde + AssociateIamRoleToResourceInputResourceArnString: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster|exadb-vm-cluster)/[a-z0-9-_]+ + AssociateIamRoleToResourceOutput: + type: object + ResourceIdOrArn: + type: string + minLength: 6 + maxLength: 2048 + pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64}) + AssociateVirtualMachinesToExadbVmClusterInputDesiredNodeCountInteger: + type: integer + minimum: 1 + AssociateVirtualMachinesToExadbVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + exadbVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale VM cluster. + required: + - exadbVmClusterId + ResourceStatus: + type: string + enum: + - AVAILABLE + - FAILED + - PROVISIONING + - TERMINATED + - TERMINATING + - UPDATING + - MAINTENANCE_IN_PROGRESS + ResourceDisplayName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*" + CreateAutonomousDatabaseInputDbNameString: + type: string + minLength: 1 + maxLength: 30 + CreateAutonomousDatabaseInputAdminPasswordString: + type: string + minLength: 12 + maxLength: 30 + CreateAutonomousDatabaseInputComputeCountDouble: + type: number + format: double + minimum: 0.1 + maximum: 512 + CreateAutonomousDatabaseInputDataStorageSizeInTBsInteger: + type: integer + minimum: 1 + maximum: 384 + CreateAutonomousDatabaseInputDataStorageSizeInGBsInteger: + type: integer + minimum: 20 + maximum: 393216 + DbWorkload: + type: string + enum: + - OLTP + - AJD + - APEX + - LH + Boolean: + type: boolean + LicenseModel: + type: string + enum: + - BRING_YOUR_OWN_LICENSE + - LICENSE_INCLUDED + CreateAutonomousDatabaseInputCharacterSetString: + type: string + minLength: 1 + maxLength: 255 + CreateAutonomousDatabaseInputNcharacterSetString: + type: string + minLength: 1 + maxLength: 255 + CreateAutonomousDatabaseInputDbVersionString: + type: string + minLength: 1 + maxLength: 255 + DatabaseEdition: + type: string + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + StandbyAllowlistedIpsSource: + type: string + enum: + - PRIMARY + - SEPARATE + - NOT_APPLICABLE + AutonomousMaintenanceScheduleType: + type: string + enum: + - EARLY + - REGULAR + Integer: + type: integer + CreateAutonomousDatabaseInputByolComputeCountLimitDouble: + type: number + format: double + minimum: 2 + CreateAutonomousDatabaseInputCpuCoreCountInteger: + type: integer + minimum: 1 + maximum: 128 + CustomerContacts: + type: array + items: + $ref: "#/components/schemas/CustomerContact" + CustomerContact: + description: A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure. + type: object + properties: + email: + $ref: "#/components/schemas/CustomerContactEmailString" + description: The email address of the contact. + CustomerContactEmailString: + type: string + minLength: 1 + maxLength: 320 + ResourcePoolSummary: + description: The configuration of a resource pool for an Autonomous Database. + type: object + properties: + isDisabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the resource pool is disabled. + poolSize: + $ref: "#/components/schemas/Integer" + description: The number of Autonomous Databases that the resource pool can contain. + poolStorageSizeInTBs: + $ref: "#/components/schemas/Integer" + description: The total storage size of the resource pool, in terabytes (TB). + availableStorageCapacityInTBs: + $ref: "#/components/schemas/Double" + description: The available storage capacity in the resource pool, in TB. + totalComputeCapacity: + $ref: "#/components/schemas/Integer" + description: The total compute capacity of the resource pool. + availableComputeCapacity: + $ref: "#/components/schemas/Integer" + description: The available compute capacity in the resource pool. + Double: + type: number + format: double + ScheduledOperationDetailsList: + type: array + items: + $ref: "#/components/schemas/ScheduledOperationDetails" + ScheduledOperationDetails: + description: The scheduled start and stop times for an Autonomous Database on a specific day of the week. + type: object + properties: + dayOfWeek: + $ref: "#/components/schemas/DayOfWeek" + description: The day of the week on which the scheduled operation occurs. + scheduledStartTime: + $ref: "#/components/schemas/String" + description: The scheduled start time for the Autonomous Database, in UTC. + scheduledStopTime: + $ref: "#/components/schemas/String" + description: The scheduled stop time for the Autonomous Database, in UTC. + required: + - dayOfWeek + DayOfWeek: + description: An enumeration of days of the week used for scheduling maintenance windows. + type: object + properties: + name: + $ref: "#/components/schemas/DayOfWeekName" + description: The name of the day of the week. + DayOfWeekName: + type: string + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + StringList: + type: array + items: + $ref: "#/components/schemas/String" + TransportableTablespace: + description: The transportable tablespace configuration used when creating an Autonomous Database. + type: object + properties: + ttsBundleUrl: + $ref: "#/components/schemas/String" + description: The URL of the transportable tablespace bundle to use when creating the Autonomous Database. + DatabaseToolList: + type: array + items: + $ref: "#/components/schemas/DatabaseTool" + DatabaseTool: + description: Information about a database management tool for an Autonomous Database. + type: object + properties: + isEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the database management tool is enabled. + name: + $ref: "#/components/schemas/String" + description: The name of the database management tool. + computeCount: + $ref: "#/components/schemas/Double" + description: The compute capacity allocated to the database management tool. + maxIdleTimeInMinutes: + $ref: "#/components/schemas/Integer" + description: The maximum amount of time, in minutes, that the database management tool can be idle before it is shut down. + SourceType: + type: string + enum: + - NONE + - DATABASE + - BACKUP_FROM_ID + - BACKUP_FROM_TIMESTAMP + - CROSS_REGION_DATAGUARD + - CROSS_REGION_DISASTER_RECOVERY + - CLONE_TO_REFRESHABLE + SourceConfiguration: + description: The configuration details for the source used to create an Autonomous Database. This is a union, so only one of the following members can be specified. + type: object + properties: + databaseClone: + $ref: "#/components/schemas/DatabaseCloneConfiguration" + description: The configuration for creating the Autonomous Database as a clone of an existing database. + restoreFromBackup: + $ref: "#/components/schemas/RestoreFromBackupConfiguration" + description: The configuration for creating the Autonomous Database by restoring from a backup. + pointInTimeRestore: + $ref: "#/components/schemas/PointInTimeRestoreConfiguration" + description: The configuration for creating the Autonomous Database by restoring to a point in time. + crossRegionDataGuard: + $ref: "#/components/schemas/CrossRegionDataGuardConfiguration" + description: The configuration for creating the Autonomous Database as a cross-Region Oracle Data Guard peer. + crossRegionDisasterRecovery: + $ref: "#/components/schemas/CrossRegionDisasterRecoveryConfiguration" + description: The configuration for creating the Autonomous Database as a cross-Region disaster recovery peer. + cloneToRefreshable: + $ref: "#/components/schemas/CloneToRefreshableConfiguration" + description: The configuration for creating the Autonomous Database as a refreshable clone. + DatabaseCloneConfiguration: + description: The configuration for creating an Autonomous Database as a clone of an existing database. + type: object + properties: + sourceAutonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the source Autonomous Database to clone. + cloneType: + $ref: "#/components/schemas/CloneType" + description: The type of clone to create, either a full clone, a metadata clone, or a partial clone. + required: + - sourceAutonomousDatabaseId + - cloneType + CloneType: + type: string + enum: + - FULL + - METADATA + - PARTIAL + RestoreFromBackupConfiguration: + description: The configuration for creating an Autonomous Database by restoring from a backup. + type: object + properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database backup to restore from. + cloneType: + $ref: "#/components/schemas/CloneType" + description: The type of clone to create from the backup. + cloneTableSpaceList: + $ref: "#/components/schemas/IntegerList" + description: The list of tablespace identifiers to clone from the backup. + required: + - autonomousDatabaseBackupId + - cloneType + IntegerList: + type: array + items: + $ref: "#/components/schemas/Integer" + PointInTimeRestoreConfiguration: + description: The configuration for creating an Autonomous Database by restoring to a point in time. + type: object + properties: + sourceAutonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the source Autonomous Database to restore from. + cloneType: + $ref: "#/components/schemas/CloneType" + description: The type of clone to create from the point-in-time restore. + timestamp: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time to which to restore the Autonomous Database. + useLatestAvailableBackupTimestamp: + $ref: "#/components/schemas/Boolean" + description: Indicates whether to use the latest available backup timestamp for the restore. + cloneTableSpaceList: + $ref: "#/components/schemas/IntegerList" + description: The list of tablespace identifiers to clone from the point-in-time restore. + required: + - sourceAutonomousDatabaseId + - cloneType + SyntheticTimestamp_date_time: + type: string + format: date-time + CrossRegionDataGuardConfiguration: + description: The configuration for creating an Autonomous Database as a cross-Region Oracle Data Guard peer. + type: object + properties: + sourceAutonomousDatabaseArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region Oracle Data Guard configuration. + required: + - sourceAutonomousDatabaseArn + Arn: + type: string + minLength: 20 + maxLength: 2048 + CrossRegionDisasterRecoveryConfiguration: + description: The configuration for creating an Autonomous Database as a cross-Region disaster recovery peer. + type: object + properties: + sourceAutonomousDatabaseArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region disaster recovery configuration. + remoteDisasterRecoveryType: + $ref: "#/components/schemas/DisasterRecoveryType" + description: The type of remote disaster recovery to configure, either Autonomous Data Guard or backup-based. + isReplicateAutomaticBackups: + $ref: "#/components/schemas/Boolean" + description: Indicates whether automatic backups are replicated to the disaster recovery database. + required: + - sourceAutonomousDatabaseArn + - remoteDisasterRecoveryType + DisasterRecoveryType: + type: string + enum: + - ADG + - BACKUP_BASED + CloneToRefreshableConfiguration: + description: The configuration for creating an Autonomous Database as a refreshable clone. + type: object + properties: + sourceAutonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the source Autonomous Database to create the refreshable clone from. + refreshableMode: + $ref: "#/components/schemas/RefreshableMode" + description: The refresh mode of the refreshable clone, either automatic or manual. + autoRefreshFrequencyInSeconds: + $ref: "#/components/schemas/CloneToRefreshableConfigurationAutoRefreshFrequencyInSecondsInteger" + description: The frequency, in seconds, at which the refreshable clone is automatically refreshed. + autoRefreshPointLagInSeconds: + $ref: "#/components/schemas/CloneToRefreshableConfigurationAutoRefreshPointLagInSecondsInteger" + description: The time lag, in seconds, between the refreshable clone and its source database. + timeOfAutoRefreshStart: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time at which the automatic refresh of the refreshable clone starts. + openMode: + $ref: "#/components/schemas/OpenMode" + description: The mode in which to open the refreshable clone, either read-only or read/write. + cloneType: + $ref: "#/components/schemas/CloneType" + description: The type of clone to create. + required: + - sourceAutonomousDatabaseId + RefreshableMode: + type: string + enum: + - AUTOMATIC + - MANUAL + CloneToRefreshableConfigurationAutoRefreshFrequencyInSecondsInteger: + type: integer + minimum: 3600 + maximum: 604800 + CloneToRefreshableConfigurationAutoRefreshPointLagInSecondsInteger: + type: integer + minimum: 0 + maximum: 604800 + OpenMode: + type: string + enum: + - READ_ONLY + - READ_WRITE + EncryptionKeyProviderInput: + type: string + enum: + - ORACLE_MANAGED + - AWS_KMS + EncryptionKeyConfigurationInput: + description: The configuration of the encryption key to use for an Autonomous Database. This is a union, so only one of the following members can be specified. + type: object + properties: + awsEncryptionKey: + $ref: "#/components/schemas/AwsEncryptionKeyConfigurationInput" + description: The configuration of the Amazon Web Services Key Management Service (KMS) encryption key to use. + AwsEncryptionKeyConfigurationInput: + description: The configuration of the Amazon Web Services Key Management Service (KMS) encryption key to use for an Autonomous Database. + type: object + properties: + iamRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key. + externalIdType: + $ref: "#/components/schemas/ExternalIdType" + description: The type of external identifier associated with the encryption key. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyIdOrArn" + description: The identifier or ARN of the Amazon Web Services KMS key to use for encryption. + ExternalIdType: + type: string + enum: + - database_ocid + - compartment_ocid + - tenant_ocid + KmsKeyIdOrArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[a-zA-Z0-9_:./-]+" + AdminPasswordSource: + description: The source of the admin password for an Autonomous Database. + type: string + enum: + - CUSTOMER_MANAGED_AWS_SECRET + - API_REQUEST_PARAMETER + AdminPasswordSourceConfigurationInput: + description: The input configuration for the admin password source. This is a union, so only one of the following members can be specified. + type: object + properties: + customerManagedAwsSecret: + $ref: "#/components/schemas/CustomerManagedAwsSecretConfigurationInput" + description: The configuration for using a customer-managed Amazon Web Services Secrets Manager secret as the admin password source. + CustomerManagedAwsSecretConfigurationInput: + description: The input configuration for a customer-managed Amazon Web Services Secrets Manager secret used to supply a password. + type: object + properties: + secretId: + $ref: "#/components/schemas/SecretIdOrArn" + description: The identifier or ARN of the Amazon Web Services Secrets Manager secret that contains the password. + iamRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that OCI assumes to retrieve the secret value. + externalIdType: + $ref: "#/components/schemas/ExternalIdType" + description: The type of Oracle Cloud Identifier (OCID) used as the external ID when assuming the IAM role. The valid values depend on the operation. For the CreateAutonomousDatabase operation, only compartment_ocid and tenant_ocid are allowed. For the UpdateAutonomousDatabase and CreateAutonomousDatabaseWallet operations, database_ocid, compartment_ocid, and tenant_ocid are all allowed. + SecretIdOrArn: + description: The identifier or Amazon Resource Name (ARN) of an Amazon Web Services Secrets Manager secret. + type: string + minLength: 1 + maxLength: 2048 + CreateAutonomousDatabaseInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + RequestTagMap: + type: object + properties: {} + CreateAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was created. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database that was created. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database, if applicable. + required: + - autonomousDatabaseId + AutonomousDatabaseResourceStatus: + type: string + enum: + - AVAILABLE + - FAILED + - PROVISIONING + - TERMINATED + - TERMINATING + - UPDATING + - MAINTENANCE_IN_PROGRESS + - STOPPING + - STOPPED + - STARTING + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + CreateAutonomousDatabaseBackupInputRetentionPeriodInDaysInteger: + type: integer + minimum: 90 + maximum: 3650 + CreateAutonomousDatabaseBackupInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateAutonomousDatabaseBackupOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database backup that was created. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Autonomous Database backup. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database backup, if applicable. + autonomousDatabaseBackupId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database backup that was created. + required: + - autonomousDatabaseBackupId + WalletType: + type: string + enum: + - REGIONAL + - INSTANCE + CreateAutonomousDatabaseWalletInputPasswordString: + type: string + minLength: 8 + WalletPasswordSource: + description: The source of the password for an Autonomous Database wallet. + type: string + enum: + - CUSTOMER_MANAGED_AWS_SECRET + - API_REQUEST_PARAMETER + WalletPasswordSourceConfigurationInput: + description: The input configuration for the wallet password source. This is a union, so only one of the following members can be specified. + type: object + properties: + customerManagedAwsSecret: + $ref: "#/components/schemas/CustomerManagedAwsSecretConfigurationInput" + description: The configuration for using a customer-managed Amazon Web Services Secrets Manager secret as the wallet password source. + CreateAutonomousDatabaseWalletInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateAutonomousDatabaseWalletOutput: + type: object + properties: + autonomousDatabaseWalletFile: + $ref: "#/components/schemas/AutonomousDatabaseWalletFile" + description: The generated wallet file for the Autonomous Database, returned as a compressed archive. + required: + - autonomousDatabaseWalletFile + AutonomousDatabaseWalletFile: + type: string + format: byte + CreateCloudAutonomousVmClusterInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudAutonomousVmClusterInputAutonomousDataStorageSizeInTBsDouble: + type: number + format: double + minimum: 0 + CreateCloudAutonomousVmClusterInputCpuCoreCountPerNodeInteger: + type: integer + minimum: 0 + CreateCloudAutonomousVmClusterInputDescriptionString: + type: string + minLength: 1 + maxLength: 400 + MaintenanceWindow: + description: The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. + type: object + properties: + customActionTimeoutInMins: + $ref: "#/components/schemas/MaintenanceWindowCustomActionTimeoutInMinsInteger" + description: The custom action timeout in minutes for the maintenance window. + daysOfWeek: + $ref: "#/components/schemas/DaysOfWeek" + description: The days of the week when maintenance can be performed. + hoursOfDay: + $ref: "#/components/schemas/HoursOfDay" + description: The hours of the day when maintenance can be performed. + isCustomActionTimeoutEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether custom action timeout is enabled for the maintenance window. + leadTimeInWeeks: + $ref: "#/components/schemas/MaintenanceWindowLeadTimeInWeeksInteger" + description: The lead time in weeks before the maintenance window. + months: + $ref: "#/components/schemas/Months" + description: The months when maintenance can be performed. + patchingMode: + $ref: "#/components/schemas/PatchingModeType" + description: The patching mode for the maintenance window. + preference: + $ref: "#/components/schemas/PreferenceType" + description: The preference for the maintenance window scheduling. + skipRu: + $ref: "#/components/schemas/Boolean" + description: Indicates whether to skip release updates during maintenance. + weeksOfMonth: + $ref: "#/components/schemas/WeeksOfMonth" + description: The weeks of the month when maintenance can be performed. + MaintenanceWindowCustomActionTimeoutInMinsInteger: + type: integer + minimum: 15 + maximum: 120 + DaysOfWeek: + type: array + items: + $ref: "#/components/schemas/DayOfWeek" + HoursOfDay: + type: array + items: + $ref: "#/components/schemas/Integer" + MaintenanceWindowLeadTimeInWeeksInteger: + type: integer + minimum: 1 + maximum: 4 + Months: + type: array + items: + $ref: "#/components/schemas/Month" + Month: + description: An enumeration of months used for scheduling maintenance windows. + type: object + properties: + name: + $ref: "#/components/schemas/MonthName" + description: The name of the month. + MonthName: + type: string + enum: + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + PatchingModeType: + type: string + enum: + - ROLLING + - NONROLLING + PreferenceType: + type: string + enum: + - NO_PREFERENCE + - CUSTOM_PREFERENCE + WeeksOfMonth: + type: array + items: + $ref: "#/components/schemas/Integer" + CreateCloudAutonomousVmClusterInputMemoryPerOracleComputeUnitInGBsInteger: + type: integer + minimum: 0 + CreateCloudAutonomousVmClusterInputScanListenerPortNonTlsInteger: + type: integer + minimum: 1024 + maximum: 8999 + CreateCloudAutonomousVmClusterInputScanListenerPortTlsInteger: + type: integer + minimum: 1024 + maximum: 8999 + CreateCloudAutonomousVmClusterInputTimeZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateCloudAutonomousVmClusterInputTotalContainerDatabasesInteger: + type: integer + minimum: 0 + CreateCloudAutonomousVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The display name of the created Autonomous VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Autonomous VM cluster creation process. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous VM cluster creation process, if applicable. + cloudAutonomousVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created Autonomous VM cluster. + required: + - cloudAutonomousVmClusterId + CreateCloudExadataInfrastructureInputShapeString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudExadataInfrastructureInputAvailabilityZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateCloudExadataInfrastructureInputAvailabilityZoneIdString: + type: string + minLength: 1 + maxLength: 255 + CreateCloudExadataInfrastructureInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudExadataInfrastructureInputDatabaseServerTypeString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudExadataInfrastructureInputStorageServerTypeString: + type: string + minLength: 1 + maxLength: 255 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudExadataInfrastructureOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exadata infrastructure. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exadata infrastructure. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exadata infrastructure. + cloudExadataInfrastructureId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exadata infrastructure. + required: + - cloudExadataInfrastructureId + CreateCloudVmClusterInputCpuCoreCountInteger: + type: integer + minimum: 0 + maximum: 10000 + CreateCloudVmClusterInputGiVersionString: + type: string + minLength: 1 + maxLength: 255 + Hostname: + type: string + minLength: 1 + maxLength: 12 + pattern: "[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]" + ClusterName: + type: string + minLength: 1 + maxLength: 11 + pattern: "[a-zA-Z][a-zA-Z0-9-]*" + DataCollectionOptions: + description: Information about the data collection options enabled for a VM cluster. + type: object + properties: + isDiagnosticsEventsEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether diagnostic collection is enabled for the VM cluster. + isHealthMonitoringEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether health monitoring is enabled for the VM cluster. + isIncidentLogsEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether incident logs are enabled for the cloud VM cluster. + CreateCloudVmClusterInputSystemVersionString: + type: string + minLength: 1 + maxLength: 255 + CreateCloudVmClusterInputTimeZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateCloudVmClusterInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateCloudVmClusterInputScanListenerPortTcpInteger: + type: integer + minimum: 1024 + maximum: 8999 + CreateCloudVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the VM cluster. + cloudVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier for the VM cluster. + required: + - cloudVmClusterId + CreateExadbVmClusterInputEnabledEcpuCountInteger: + type: integer + minimum: 0 + CreateExadbVmClusterInputGridImageIdString: + type: string + minLength: 1 + maxLength: 255 + CreateExadbVmClusterInputNodeCountInteger: + type: integer + minimum: 1 + CreateExadbVmClusterInputShapeString: + type: string + minLength: 1 + maxLength: 255 + CreateExadbVmClusterInputTotalEcpuCountInteger: + type: integer + minimum: 2 + CreateExadbVmClusterInputVmFileSystemStorageTotalSizeInGBsInteger: + type: integer + minimum: 0 + CreateExadbVmClusterInputScanListenerPortTcpInteger: + type: integer + minimum: 1024 + maximum: 8999 + CreateExadbVmClusterInputScanListenerPortTcpSslInteger: + type: integer + minimum: 1024 + maximum: 8999 + ShapeAttribute: + type: string + enum: + - SMART_STORAGE + - BLOCK_STORAGE + CreateExadbVmClusterInputSystemVersionString: + type: string + minLength: 1 + maxLength: 255 + CreateExadbVmClusterInputTimeZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateExadbVmClusterInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateExadbVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + exadbVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale VM cluster. + required: + - exadbVmClusterId + CreateExascaleDbStorageVaultInputHighCapacityDatabaseStorageTotalSizeInGBsInteger: + type: integer + minimum: 0 + CreateExascaleDbStorageVaultInputAdditionalFlashCacheInPercentInteger: + type: integer + minimum: 0 + CreateExascaleDbStorageVaultInputAutoscaleLimitInGBsInteger: + type: integer + minimum: 0 + CreateExascaleDbStorageVaultInputAvailabilityZoneIdString: + type: string + minLength: 1 + maxLength: 255 + CreateExascaleDbStorageVaultInputAvailabilityZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateExascaleDbStorageVaultInputDescriptionString: + type: string + minLength: 1 + maxLength: 400 + CreateExascaleDbStorageVaultInputTimeZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateExascaleDbStorageVaultInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateExascaleDbStorageVaultOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale storage vault. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale storage vault. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale storage vault. + exascaleDbStorageVaultId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale storage vault. + required: + - exascaleDbStorageVaultId + CreateOdbNetworkInputAvailabilityZoneString: + type: string + minLength: 1 + maxLength: 255 + CreateOdbNetworkInputAvailabilityZoneIdString: + type: string + minLength: 1 + maxLength: 255 + CreateOdbNetworkInputClientSubnetCidrString: + type: string + minLength: 1 + maxLength: 43 + CreateOdbNetworkInputBackupSubnetCidrString: + type: string + minLength: 1 + maxLength: 43 + CreateOdbNetworkInputCustomDomainNameString: + type: string + minLength: 1 + maxLength: 255 + CreateOdbNetworkInputDefaultDnsPrefixString: + type: string + minLength: 1 + maxLength: 15 + pattern: "[a-zA-Z][a-zA-Z0-9]*" + CreateOdbNetworkInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + Access: + type: string + enum: + - ENABLED + - DISABLED + PolicyDocument: + type: string + minLength: 3 + maxLength: 20480 + CreateOdbNetworkOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the ODB network. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the ODB network. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the ODB network. + odbNetworkId: + $ref: "#/components/schemas/String" + description: The unique identifier of the ODB network. + required: + - odbNetworkId + PeeredCidrList: + type: array + items: + $ref: "#/components/schemas/PeeredCidr" + PeeredCidr: + type: string + minLength: 1 + maxLength: 18 + pattern: (?:(?:\d|[01]?\d\d|2[0-4]\d|25[0-5])\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d|\d)\/(?:[1-2][0-9]|3[0-2]|[1-9]) + PeerNetworkRouteTableIdList: + type: array + items: + $ref: "#/components/schemas/PeerNetworkRouteTableId" + PeerNetworkRouteTableId: + type: string + pattern: rtb-[a-z0-9]{8,17} + CreateOdbPeeringConnectionInputClientTokenString: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9_\\/.=-]+" + CreateOdbPeeringConnectionOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The display name of the ODB peering connection. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The status of the ODB peering connection. + statusReason: + $ref: "#/components/schemas/String" + description: The reason for the current status of the ODB peering connection. + odbPeeringConnectionId: + $ref: "#/components/schemas/String" + description: The unique identifier of the ODB peering connection. + required: + - odbPeeringConnectionId + DeleteAutonomousDatabaseOutput: + type: object + ResourceId: + type: string + minLength: 6 + maxLength: 64 + pattern: "[a-zA-Z0-9_~.-]+" + DeleteAutonomousDatabaseBackupOutput: + type: object + DeleteCloudAutonomousVmClusterOutput: + type: object + DeleteCloudExadataInfrastructureOutput: + type: object + DeleteCloudVmClusterOutput: type: object - RoleArn: - type: string - minLength: 20 - maxLength: 2048 - pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+ - SupportedAwsIntegration: - type: string - enum: - - KmsTde - AssociateIamRoleToResourceInputResourceArnString: + DeleteExadbVmClusterOutput: + type: object + DeleteExascaleDbStorageVaultOutput: + type: object + DeleteOdbNetworkOutput: + type: object + DeleteOdbPeeringConnectionOutput: + type: object + DisassociateIamRoleFromResourceInputResourceArnString: type: string minLength: 20 maxLength: 2048 - pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster)/[a-z0-9-_]+ - AssociateIamRoleToResourceOutput: + pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster|exadb-vm-cluster)/[a-z0-9-_]+ + DisassociateIamRoleFromResourceOutput: type: object - ResourceIdOrArn: - type: string - minLength: 6 - maxLength: 2048 - pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64}) - ResourceDisplayName: - type: string - minLength: 1 - maxLength: 255 - pattern: "[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*" - CreateCloudAutonomousVmClusterInputClientTokenString: - type: string - minLength: 8 - maxLength: 64 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudAutonomousVmClusterInputAutonomousDataStorageSizeInTBsDouble: - type: number - format: double - minimum: 0 - CreateCloudAutonomousVmClusterInputCpuCoreCountPerNodeInteger: - type: integer - minimum: 0 - StringList: + ResourceIdList: type: array items: - $ref: "#/components/schemas/String" - CreateCloudAutonomousVmClusterInputDescriptionString: - type: string - minLength: 1 - maxLength: 400 - Boolean: - type: boolean - LicenseModel: + $ref: "#/components/schemas/ResourceId" + DisassociateVirtualMachinesFromExadbVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + exadbVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale VM cluster. + required: + - exadbVmClusterId + ResourceArn: type: string - enum: - - BRING_YOUR_OWN_LICENSE - - LICENSE_INCLUDED - MaintenanceWindow: - description: The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. + minLength: 20 + maxLength: 2048 + pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64} + FailoverAutonomousDatabaseOutput: type: object properties: - customActionTimeoutInMins: - $ref: "#/components/schemas/MaintenanceWindowCustomActionTimeoutInMinsInteger" - description: The custom action timeout in minutes for the maintenance window. - daysOfWeek: - $ref: "#/components/schemas/DaysOfWeek" - description: The days of the week when maintenance can be performed. - hoursOfDay: - $ref: "#/components/schemas/HoursOfDay" - description: The hours of the day when maintenance can be performed. - isCustomActionTimeoutEnabled: - $ref: "#/components/schemas/Boolean" - description: Indicates whether custom action timeout is enabled for the maintenance window. - leadTimeInWeeks: - $ref: "#/components/schemas/MaintenanceWindowLeadTimeInWeeksInteger" - description: The lead time in weeks before the maintenance window. - months: - $ref: "#/components/schemas/Months" - description: The months when maintenance can be performed. - patchingMode: - $ref: "#/components/schemas/PatchingModeType" - description: The patching mode for the maintenance window. - preference: - $ref: "#/components/schemas/PreferenceType" - description: The preference for the maintenance window scheduling. - skipRu: - $ref: "#/components/schemas/Boolean" - description: Indicates whether to skip release updates during maintenance. - weeksOfMonth: - $ref: "#/components/schemas/WeeksOfMonth" - description: The weeks of the month when maintenance can be performed. - MaintenanceWindowCustomActionTimeoutInMinsInteger: - type: integer - minimum: 15 - maximum: 120 - DaysOfWeek: - type: array - items: - $ref: "#/components/schemas/DayOfWeek" - DayOfWeek: - description: An enumeration of days of the week used for scheduling maintenance windows. + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was failed over. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the failover operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the failover operation. + required: + - autonomousDatabaseId + GetAutonomousDatabaseOutput: type: object properties: - name: - $ref: "#/components/schemas/DayOfWeekName" - description: The name of the day of the week. - DayOfWeekName: - type: string - enum: - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - HoursOfDay: - type: array - items: - $ref: "#/components/schemas/Integer" - Integer: - type: integer - MaintenanceWindowLeadTimeInWeeksInteger: - type: integer - minimum: 1 - maximum: 4 - Months: - type: array - items: - $ref: "#/components/schemas/Month" - Month: - description: An enumeration of months used for scheduling maintenance windows. + autonomousDatabase: + $ref: "#/components/schemas/AutonomousDatabase" + description: The details of the requested Autonomous Database. + required: + - autonomousDatabase + AutonomousDatabase: + description: Information about an Autonomous Database. type: object properties: - name: - $ref: "#/components/schemas/MonthName" - description: The name of the month. - MonthName: - type: string - enum: - - JANUARY - - FEBRUARY - - MARCH - - APRIL - - MAY - - JUNE - - JULY - - AUGUST - - SEPTEMBER - - OCTOBER - - NOVEMBER - - DECEMBER - PatchingModeType: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database. + autonomousDatabaseArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Autonomous Database. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database. + percentProgress: + $ref: "#/components/schemas/Float" + description: The progress of the current operation on the Autonomous Database, as a percentage. + ocid: + $ref: "#/components/schemas/String" + description: The Oracle Cloud Identifier (OCID) of the Autonomous Database. + ociUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the OCI console page for the Autonomous Database. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + dbName: + $ref: "#/components/schemas/String" + description: The name of the Autonomous Database. + sourceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the source from which the Autonomous Database was created. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database, if applicable. + databaseType: + $ref: "#/components/schemas/DatabaseType" + description: The type of the Autonomous Database, either a regular database or a clone. + dbVersion: + $ref: "#/components/schemas/String" + description: The Oracle Database software version of the Autonomous Database. + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. + characterSet: + $ref: "#/components/schemas/String" + description: The character set of the Autonomous Database. + ncharacterSet: + $ref: "#/components/schemas/String" + description: The national character set of the Autonomous Database. + databaseEdition: + $ref: "#/components/schemas/DatabaseEdition" + description: The Oracle Database edition of the Autonomous Database. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model that applies to the Autonomous Database. + openMode: + $ref: "#/components/schemas/OpenMode" + description: The mode in which the Autonomous Database is open, either read-only or read/write. + permissionLevel: + $ref: "#/components/schemas/PermissionLevel" + description: The permission level of the Autonomous Database. + isMtlsConnectionRequired: + $ref: "#/components/schemas/Boolean" + description: Indicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. + autonomousMaintenanceScheduleType: + $ref: "#/components/schemas/AutonomousMaintenanceScheduleType" + description: The maintenance schedule type for the Autonomous Database. + netServicesArchitecture: + $ref: "#/components/schemas/NetServicesArchitecture" + description: The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared. + availableUpgradeVersions: + $ref: "#/components/schemas/StringList" + description: The list of Oracle Database software versions to which the Autonomous Database can be upgraded. + byolComputeCountLimit: + $ref: "#/components/schemas/Integer" + description: The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. + connectionStringDetails: + $ref: "#/components/schemas/AutonomousDatabaseConnectionStrings" + description: The connection string details for the Autonomous Database. + serviceConsoleUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the Oracle service console for the Autonomous Database. + sqlWebDeveloperUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle SQL Developer Web for the Autonomous Database. + customerContacts: + $ref: "#/components/schemas/CustomerContacts" + description: The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database. + apexDetails: + $ref: "#/components/schemas/AutonomousDatabaseApex" + description: The Oracle Application Express (APEX) details for the Autonomous Database. + standbyDb: + $ref: "#/components/schemas/DatabaseStandbySummary" + description: The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration. + localStandbyDb: + $ref: "#/components/schemas/DatabaseStandbySummary" + description: The details of the local standby Autonomous Database in an Oracle Data Guard configuration. + dataSafeStatus: + $ref: "#/components/schemas/DataSafeStatus" + description: The status of the Oracle Data Safe registration for the Autonomous Database. + databaseManagementStatus: + $ref: "#/components/schemas/DatabaseManagementStatus" + description: The status of Oracle Database Management for the Autonomous Database. + operationsInsightsStatus: + $ref: "#/components/schemas/OperationsInsightsStatus" + description: The status of Oracle Operations Insights for the Autonomous Database. + availabilityZone: + $ref: "#/components/schemas/String" + description: The Availability Zone where the Autonomous Database is located. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Availability Zone where the Autonomous Database is located. + maintenanceTargetComponent: + $ref: "#/components/schemas/String" + description: The component on the Autonomous Database that the current maintenance is being applied to. + connectionUrls: + $ref: "#/components/schemas/AutonomousDatabaseConnectionUrls" + description: The connection URLs for accessing tools and services for the Autonomous Database. + dbToolsDetails: + $ref: "#/components/schemas/DatabaseToolList" + description: The list of database management tools enabled for the Autonomous Database. + scheduledOperations: + $ref: "#/components/schemas/ScheduledOperationDetailsList" + description: The list of scheduled start and stop times for the Autonomous Database. + resourcePoolLeaderId: + $ref: "#/components/schemas/String" + description: The unique identifier of the resource pool leader Autonomous Database. + computeCount: + $ref: "#/components/schemas/Float" + description: The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database. + computeModel: + $ref: "#/components/schemas/ComputeModel" + description: The compute model of the Autonomous Database, either ECPU or OCPU. + cpuCoreCount: + $ref: "#/components/schemas/Integer" + description: The number of CPU cores allocated to the Autonomous Database. + memoryPerOracleComputeUnitInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of memory allocated per Oracle Compute Unit, in GB. + provisionableCpus: + $ref: "#/components/schemas/IntegerList" + description: The list of CPU core counts that you can provision for the Autonomous Database. + isAutoScalingEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database. + dataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The size, in terabytes (TB), of the data volume allocated for the Autonomous Database. + dataStorageSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The size, in gigabytes (GB), of the data volume allocated for the Autonomous Database. + usedDataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The amount of data storage currently in use by the Autonomous Database, in TB. + usedDataStorageSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of data storage currently in use by the Autonomous Database, in GB. + actualUsedDataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The actual amount of data storage currently in use by the Autonomous Database, in TB. + allocatedStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The amount of storage currently allocated to the Autonomous Database, in TB. + inMemoryAreaInGBs: + $ref: "#/components/schemas/Integer" + description: The size of the in-memory area of the Autonomous Database, in GB. + isAutoScalingForStorageEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether automatic scaling of the storage is enabled for the Autonomous Database. + odbNetworkId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the ODB network associated with the Autonomous Database. + odbNetworkArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the ODB network associated with the Autonomous Database. + privateEndpoint: + $ref: "#/components/schemas/String" + description: The private endpoint for the Autonomous Database. + privateEndpointIp: + $ref: "#/components/schemas/String" + description: The private endpoint IP address for the Autonomous Database. + privateEndpointLabel: + $ref: "#/components/schemas/String" + description: The private endpoint label for the Autonomous Database. + allowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the Autonomous Database. + standbyAllowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the standby Autonomous Database. + standbyAllowlistedIpsSource: + $ref: "#/components/schemas/StandbyAllowlistedIpsSource" + description: The source of the allowlisted IP addresses for the standby Autonomous Database. + isLocalDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether local Oracle Data Guard is enabled for the Autonomous Database. + isRemoteDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database. + localDisasterRecoveryType: + $ref: "#/components/schemas/DisasterRecoveryType" + description: The type of local disaster recovery configured for the Autonomous Database. + role: + $ref: "#/components/schemas/DataGuardRole" + description: The Oracle Data Guard role of the Autonomous Database. + peerDbIds: + $ref: "#/components/schemas/StringList" + description: The list of unique identifiers of the peer Autonomous Databases. + failedDataRecoveryInSeconds: + $ref: "#/components/schemas/Integer" + description: The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database. + localAdgAutoFailoverMaxDataLossLimit: + $ref: "#/components/schemas/Integer" + description: The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database. + remoteDisasterRecoveryConfiguration: + $ref: "#/components/schemas/DisasterRecoveryConfiguration" + description: The configuration of the remote disaster recovery for the Autonomous Database. + isRefreshableClone: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the Autonomous Database is a refreshable clone. + refreshableMode: + $ref: "#/components/schemas/RefreshableMode" + description: The refresh mode of the refreshable clone Autonomous Database. + refreshableStatus: + $ref: "#/components/schemas/RefreshableStatus" + description: The refresh status of the refreshable clone Autonomous Database. + autoRefreshFrequencyInSeconds: + $ref: "#/components/schemas/Integer" + description: The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed. + autoRefreshPointLagInSeconds: + $ref: "#/components/schemas/Integer" + description: The time lag, in seconds, between the refreshable clone and its source Autonomous Database. + isReconnectCloneEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled. + cloneTableSpaceList: + $ref: "#/components/schemas/IntegerList" + description: The list of tablespace identifiers to clone for the Autonomous Database. + backupRetentionPeriodInDays: + $ref: "#/components/schemas/Integer" + description: The retention period, in days, for automatic backups of the Autonomous Database. + longTermBackupSchedule: + $ref: "#/components/schemas/LongTermBackupSchedule" + description: The long-term backup schedule for the Autonomous Database. + isBackupRetentionLocked: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the backup retention period of the Autonomous Database is locked. + totalBackupStorageSizeInGBs: + $ref: "#/components/schemas/Double" + description: The total amount of backup storage used by the Autonomous Database, in GB. + resourcePoolSummary: + $ref: "#/components/schemas/ResourcePoolSummary" + description: The configuration of the resource pool for the Autonomous Database. + encryptionSummary: + $ref: "#/components/schemas/EncryptionSummary" + description: The encryption configuration for the Autonomous Database. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database was created. + timeOfLastBackup: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last backup of the Autonomous Database. + timeMaintenanceBegin: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the Autonomous Database begins. + timeMaintenanceEnd: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the Autonomous Database ends. + timeLocalDataGuardEnabled: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when local Oracle Data Guard was enabled for the Autonomous Database. + timeDataGuardRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Oracle Data Guard role of the Autonomous Database last changed. + timeOfLastSwitchover: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last switchover operation for the Autonomous Database. + timeOfLastFailover: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last failover operation for the Autonomous Database. + timeOfLastRefresh: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last refresh of the refreshable clone Autonomous Database. + timeOfLastRefreshPoint: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time as of which the data in the refreshable clone Autonomous Database is current. + timeOfNextRefresh: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the next scheduled refresh of the refreshable clone Autonomous Database. + timeOfAutoRefreshStart: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts. + timeDeletionOfFreeAutonomousDatabase: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted. + timeReclamationOfFreeAutonomousDatabase: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity. + timeDisasterRecoveryRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the disaster recovery role of the Autonomous Database last changed. + timeUntilReconnectCloneEnabled: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed. + nextLongTermBackupTimeStamp: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the next scheduled long-term backup of the Autonomous Database. + timeUndeleted: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database was restored after deletion. + adminPasswordSourceSummary: + $ref: "#/components/schemas/AdminPasswordSourceSummary" + description: The summary of the admin password source configuration for the Autonomous Database. + Float: + type: number + format: float + DatabaseType: type: string enum: - - ROLLING - - NONROLLING - PreferenceType: + - REGULAR + - CLONE + PermissionLevel: type: string enum: - - NO_PREFERENCE - - CUSTOM_PREFERENCE - WeeksOfMonth: + - RESTRICTED + - UNRESTRICTED + NetServicesArchitecture: + type: string + enum: + - DEDICATED + - SHARED + AutonomousDatabaseConnectionStrings: + description: The connection strings used to connect to an Autonomous Database. + type: object + properties: + allConnectionStrings: + type: object + properties: {} + description: The list of all connection strings that you can use to connect to the Autonomous Database. + dedicated: + $ref: "#/components/schemas/String" + description: The connection string for connecting to the Autonomous Database with a dedicated service. + high: + $ref: "#/components/schemas/String" + description: The connection string for the high-priority database service. + medium: + $ref: "#/components/schemas/String" + description: The connection string for the medium-priority database service. + low: + $ref: "#/components/schemas/String" + description: The connection string for the low-priority database service. + profiles: + $ref: "#/components/schemas/DatabaseConnectionStringProfileList" + description: The list of connection string profiles for the Autonomous Database. + DatabaseConnectionStringProfileList: type: array items: - $ref: "#/components/schemas/Integer" - CreateCloudAutonomousVmClusterInputMemoryPerOracleComputeUnitInGBsInteger: - type: integer - minimum: 0 - CreateCloudAutonomousVmClusterInputScanListenerPortNonTlsInteger: - type: integer - minimum: 1024 - maximum: 8999 - CreateCloudAutonomousVmClusterInputScanListenerPortTlsInteger: - type: integer - minimum: 1024 - maximum: 8999 - RequestTagMap: - type: object - properties: {} - CreateCloudAutonomousVmClusterInputTimeZoneString: - type: string - minLength: 1 - maxLength: 255 - CreateCloudAutonomousVmClusterInputTotalContainerDatabasesInteger: - type: integer - minimum: 0 - CreateCloudAutonomousVmClusterOutput: + $ref: "#/components/schemas/DatabaseConnectionStringProfile" + DatabaseConnectionStringProfile: + description: A connection string profile for an Autonomous Database. type: object properties: + consumerGroup: + $ref: "#/components/schemas/String" + description: The consumer group associated with the connection string profile. displayName: $ref: "#/components/schemas/String" - description: The display name of the created Autonomous VM cluster. + description: The user-friendly name of the connection string profile. + hostFormat: + $ref: "#/components/schemas/String" + description: The host name format used in the connection string. + isRegional: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the connection string profile is regional. + protocol: + $ref: "#/components/schemas/String" + description: The protocol used by the connection string profile. + sessionMode: + $ref: "#/components/schemas/String" + description: The session mode of the connection string profile. + syntaxFormat: + $ref: "#/components/schemas/String" + description: The syntax format of the connection string profile. + tlsAuthentication: + $ref: "#/components/schemas/String" + description: The TLS authentication method used by the connection string profile. + value: + $ref: "#/components/schemas/String" + description: The connection string value of the profile. + AutonomousDatabaseApex: + description: The Oracle Application Express (APEX) details for an Autonomous Database. + type: object + properties: + apexVersion: + $ref: "#/components/schemas/String" + description: The Oracle Application Express (APEX) version of the Autonomous Database. + ordsVersion: + $ref: "#/components/schemas/String" + description: The Oracle REST Data Services (ORDS) version of the Autonomous Database. + DatabaseStandbySummary: + description: A summary of a standby Autonomous Database in an Oracle Data Guard configuration. + type: object + properties: + availabilityDomain: + $ref: "#/components/schemas/String" + description: The availability domain of the standby Autonomous Database. + lagTimeInSeconds: + $ref: "#/components/schemas/Integer" + description: The time lag, in seconds, between the standby database and the primary database. status: - $ref: "#/components/schemas/ResourceStatus" - description: The current status of the Autonomous VM cluster creation process. + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the standby Autonomous Database. statusReason: $ref: "#/components/schemas/String" - description: Additional information about the current status of the Autonomous VM cluster creation process, if applicable. - cloudAutonomousVmClusterId: + description: Additional information about the current status of the standby Autonomous Database, if applicable. + maintenanceTargetComponent: $ref: "#/components/schemas/String" - description: The unique identifier of the created Autonomous VM cluster. - required: - - cloudAutonomousVmClusterId - ResourceStatus: + description: The component on the standby Autonomous Database that the current maintenance is being applied to. + timeDataGuardRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Oracle Data Guard role of the standby database last changed. + timeDisasterRecoveryRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the disaster recovery role of the standby database last changed. + timeMaintenanceBegin: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the standby database begins. + timeMaintenanceEnd: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the standby database ends. + DataSafeStatus: type: string enum: - - AVAILABLE + - REGISTERING + - REGISTERED + - DEREGISTERING + - NOT_REGISTERED - FAILED - - PROVISIONING - - TERMINATED - - TERMINATING - - UPDATING - - MAINTENANCE_IN_PROGRESS - CreateCloudExadataInfrastructureInputShapeString: - type: string - minLength: 1 - maxLength: 255 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudExadataInfrastructureInputAvailabilityZoneString: - type: string - minLength: 1 - maxLength: 255 - CreateCloudExadataInfrastructureInputAvailabilityZoneIdString: - type: string - minLength: 1 - maxLength: 255 - CustomerContacts: - type: array - items: - $ref: "#/components/schemas/CustomerContact" - CustomerContact: - description: A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure. - type: object - properties: - email: - $ref: "#/components/schemas/CustomerContactEmailString" - description: The email address of the contact. - CustomerContactEmailString: - type: string - minLength: 1 - maxLength: 320 - CreateCloudExadataInfrastructureInputClientTokenString: - type: string - minLength: 8 - maxLength: 64 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudExadataInfrastructureInputDatabaseServerTypeString: + DatabaseManagementStatus: type: string - minLength: 1 - maxLength: 255 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudExadataInfrastructureInputStorageServerTypeString: + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + OperationsInsightsStatus: type: string - minLength: 1 - maxLength: 255 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudExadataInfrastructureOutput: + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + AutonomousDatabaseConnectionUrls: + description: The connection URLs for accessing tools and services for an Autonomous Database. type: object properties: - displayName: + apexUrl: $ref: "#/components/schemas/String" - description: The user-friendly name for the Exadata infrastructure. - status: - $ref: "#/components/schemas/ResourceStatus" - description: The current status of the Exadata infrastructure. - statusReason: + description: The URL for accessing Oracle Application Express (APEX) for the Autonomous Database. + databaseTransformsUrl: $ref: "#/components/schemas/String" - description: Additional information about the status of the Exadata infrastructure. - cloudExadataInfrastructureId: + description: The URL for accessing Oracle Database Transforms for the Autonomous Database. + graphStudioUrl: $ref: "#/components/schemas/String" - description: The unique identifier of the Exadata infrastructure. - required: - - cloudExadataInfrastructureId - CreateCloudVmClusterInputCpuCoreCountInteger: - type: integer - minimum: 0 - maximum: 10000 - CreateCloudVmClusterInputGiVersionString: - type: string - minLength: 1 - maxLength: 255 - CreateCloudVmClusterInputHostnameString: + description: The URL for accessing Oracle Graph Studio for the Autonomous Database. + machineLearningNotebookUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the Oracle Machine Learning notebook for the Autonomous Database. + machineLearningUserManagementUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle Machine Learning user management for the Autonomous Database. + mongoDbUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the MongoDB API for the Autonomous Database. + ordsUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle REST Data Services (ORDS) for the Autonomous Database. + spatialStudioUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle Spatial Studio for the Autonomous Database. + sqlDevWebUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle SQL Developer Web for the Autonomous Database. + ComputeModel: type: string - minLength: 1 - maxLength: 12 - pattern: "[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]" - CreateCloudVmClusterInputClusterNameString: + enum: + - ECPU + - OCPU + DataGuardRole: type: string - minLength: 1 - maxLength: 11 - pattern: "[a-zA-Z][a-zA-Z0-9-]*" - DataCollectionOptions: - description: Information about the data collection options enabled for a VM cluster. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + DisasterRecoveryConfiguration: + description: The disaster recovery configuration for an Autonomous Database. type: object properties: - isDiagnosticsEventsEnabled: + disasterRecoveryType: + $ref: "#/components/schemas/DisasterRecoveryType" + description: The type of disaster recovery configured for the Autonomous Database. + isReplicateAutomaticBackups: $ref: "#/components/schemas/Boolean" - description: Indicates whether diagnostic collection is enabled for the VM cluster. - isHealthMonitoringEnabled: - $ref: "#/components/schemas/Boolean" - description: Indicates whether health monitoring is enabled for the VM cluster. - isIncidentLogsEnabled: + description: Indicates whether automatic backups are replicated to the disaster recovery database. + isSnapshotStandby: $ref: "#/components/schemas/Boolean" - description: Indicates whether incident logs are enabled for the cloud VM cluster. - Double: - type: number - format: double - CreateCloudVmClusterInputSystemVersionString: - type: string - minLength: 1 - maxLength: 255 - CreateCloudVmClusterInputTimeZoneString: + description: Indicates whether the standby database is a snapshot standby. + timeSnapshotStandbyEnabledTill: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time until which the snapshot standby database remains enabled. + RefreshableStatus: type: string - minLength: 1 - maxLength: 255 - CreateCloudVmClusterInputClientTokenString: + enum: + - REFRESHING + - NOT_REFRESHING + LongTermBackupSchedule: + description: The long-term backup schedule for an Autonomous Database. + type: object + properties: + isDisabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the long-term backup schedule is disabled. + repeatCadence: + $ref: "#/components/schemas/RepeatCadence" + description: The cadence at which long-term backups are taken. + retentionPeriodInDays: + $ref: "#/components/schemas/LongTermBackupScheduleRetentionPeriodInDaysInteger" + description: The retention period, in days, for long-term backups. + timeOfBackup: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time at which the long-term backup is taken. + RepeatCadence: type: string - minLength: 8 - maxLength: 64 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateCloudVmClusterInputScanListenerPortTcpInteger: + enum: + - ONE_TIME + - WEEKLY + - MONTHLY + - YEARLY + LongTermBackupScheduleRetentionPeriodInDaysInteger: type: integer - minimum: 1024 - maximum: 8999 - CreateCloudVmClusterOutput: + minimum: 90 + maximum: 3650 + EncryptionSummary: + description: The encryption configuration for an Autonomous Database. type: object properties: - displayName: - $ref: "#/components/schemas/String" - description: The user-friendly name for the VM cluster. - status: - $ref: "#/components/schemas/ResourceStatus" - description: The current status of the VM cluster. - statusReason: - $ref: "#/components/schemas/String" - description: Additional information about the status of the VM cluster. - cloudVmClusterId: - $ref: "#/components/schemas/String" - description: The unique identifier for the VM cluster. - required: - - cloudVmClusterId - CreateOdbNetworkInputAvailabilityZoneString: + encryptionKeyProvider: + $ref: "#/components/schemas/EncryptionKeyProvider" + description: The provider of the encryption key used for the Autonomous Database. + encryptionKeyConfiguration: + $ref: "#/components/schemas/EncryptionKeyConfiguration" + description: The configuration of the encryption key used for the Autonomous Database. + EncryptionKeyProvider: type: string - minLength: 1 - maxLength: 255 - CreateOdbNetworkInputAvailabilityZoneIdString: + enum: + - ORACLE_MANAGED + - AWS_KMS + - OKV + - OCI + EncryptionKeyConfiguration: + description: The configuration of the encryption key used for an Autonomous Database. This is a union, so only one of the following members can be specified. + type: object + properties: + awsEncryptionKey: + $ref: "#/components/schemas/AwsEncryptionKeyConfiguration" + description: The configuration of the Amazon Web Services Key Management Service (KMS) encryption key. + ociEncryptionKey: + $ref: "#/components/schemas/OciEncryptionKeyConfiguration" + description: The configuration of the Oracle Cloud Infrastructure (OCI) Vault encryption key. + okvEncryptionKey: + $ref: "#/components/schemas/OkvEncryptionKeyConfiguration" + description: The configuration of the Oracle Key Vault (OKV) encryption key. + AwsEncryptionKeyConfiguration: + description: The configuration of the Amazon Web Services Key Management Service (KMS) encryption key used for an Autonomous Database. + type: object + properties: + iamRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key. + externalIdType: + $ref: "#/components/schemas/ExternalIdType" + description: The type of external identifier associated with the encryption key. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyIdOrArn" + description: The identifier or ARN of the Amazon Web Services KMS key used for encryption. + OciEncryptionKeyConfiguration: + description: The configuration of the Oracle Cloud Infrastructure (OCI) Vault encryption key used for an Autonomous Database. + type: object + properties: + kmsKeyId: + $ref: "#/components/schemas/OciEncryptionKeyConfigurationKmsKeyIdString" + description: The Oracle Cloud Identifier (OCID) of the OCI Vault key to use for encryption. + vaultId: + $ref: "#/components/schemas/OciEncryptionKeyConfigurationVaultIdString" + description: The Oracle Cloud Identifier (OCID) of the OCI Vault that contains the encryption key. + required: + - kmsKeyId + - vaultId + OciEncryptionKeyConfigurationKmsKeyIdString: type: string minLength: 1 maxLength: 255 - CreateOdbNetworkInputClientSubnetCidrString: - type: string - minLength: 1 - maxLength: 43 - CreateOdbNetworkInputBackupSubnetCidrString: - type: string - minLength: 1 - maxLength: 43 - CreateOdbNetworkInputCustomDomainNameString: + OciEncryptionKeyConfigurationVaultIdString: type: string minLength: 1 maxLength: 255 - CreateOdbNetworkInputDefaultDnsPrefixString: - type: string - minLength: 1 - maxLength: 15 - pattern: "[a-zA-Z][a-zA-Z0-9]*" - CreateOdbNetworkInputClientTokenString: - type: string - minLength: 8 - maxLength: 64 - pattern: "[a-zA-Z0-9_\\/.=-]+" - Access: - type: string - enum: - - ENABLED - - DISABLED - PolicyDocument: - type: string - minLength: 3 - maxLength: 20480 - CreateOdbNetworkOutput: + OkvEncryptionKeyConfiguration: + description: The configuration of the Oracle Key Vault (OKV) encryption key used for an Autonomous Database. type: object properties: - displayName: + certificateDirectoryName: $ref: "#/components/schemas/String" - description: The user-friendly name of the ODB network. - status: - $ref: "#/components/schemas/ResourceStatus" - description: The current status of the ODB network. - statusReason: + description: The name of the directory that contains the Oracle Key Vault (OKV) certificate. + certificateId: $ref: "#/components/schemas/String" - description: Additional information about the status of the ODB network. - odbNetworkId: + description: The identifier of the Oracle Key Vault (OKV) certificate. + directoryName: $ref: "#/components/schemas/String" - description: The unique identifier of the ODB network. + description: The name of the directory where the Oracle Key Vault (OKV) configuration is stored. + okvKmsKey: + $ref: "#/components/schemas/String" + description: The identifier of the Oracle Key Vault (OKV) key to use for encryption. + okvUri: + $ref: "#/components/schemas/String" + description: The URI of the Oracle Key Vault (OKV) server. required: - - odbNetworkId - PeeredCidrList: - type: array - items: - $ref: "#/components/schemas/PeeredCidr" - PeeredCidr: - type: string - minLength: 1 - maxLength: 18 - pattern: (?:(?:\d|[01]?\d\d|2[0-4]\d|25[0-5])\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d|\d)\/(?:[1-2][0-9]|3[0-2]|[1-9]) - PeerNetworkRouteTableIdList: - type: array - items: - $ref: "#/components/schemas/PeerNetworkRouteTableId" - PeerNetworkRouteTableId: - type: string - pattern: rtb-[a-z0-9]{8,17} - CreateOdbPeeringConnectionInputClientTokenString: - type: string - minLength: 8 - maxLength: 64 - pattern: "[a-zA-Z0-9_\\/.=-]+" - CreateOdbPeeringConnectionOutput: + - certificateDirectoryName + - directoryName + - okvKmsKey + - okvUri + AdminPasswordSourceSummary: + description: A summary of the admin password source configuration for an Autonomous Database. + type: object + properties: + adminPasswordSource: + $ref: "#/components/schemas/AdminPasswordSource" + description: The source of the admin password for the Autonomous Database. + adminPasswordSourceConfiguration: + $ref: "#/components/schemas/AdminPasswordSourceConfiguration" + description: The configuration of the admin password source for the Autonomous Database. + AdminPasswordSourceConfiguration: + description: The configuration of the admin password source. This is a union, so only one of the following members can be specified. + type: object + properties: + customerManagedAwsSecret: + $ref: "#/components/schemas/CustomerManagedAwsSecretConfiguration" + description: The configuration for a customer-managed Amazon Web Services Secrets Manager secret used as the admin password source. + CustomerManagedAwsSecretConfiguration: + description: The configuration of a customer-managed Amazon Web Services Secrets Manager secret used to supply a password. + type: object + properties: + iamRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that OCI assumes to retrieve the secret value. + secretId: + $ref: "#/components/schemas/SecretIdOrArn" + description: The identifier or ARN of the Amazon Web Services Secrets Manager secret that contains the password. + externalIdType: + $ref: "#/components/schemas/ExternalIdType" + description: The type of Oracle Cloud Identifier (OCID) used as the external ID when assuming the IAM role. + GetAutonomousDatabaseBackupOutput: + type: object + properties: + autonomousDatabaseBackup: + $ref: "#/components/schemas/AutonomousDatabaseBackup" + description: The details of the requested Autonomous Database backup. + AutonomousDatabaseBackup: + description: Information about an Autonomous Database backup. type: object properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database backup. + autonomousDatabaseBackupArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Autonomous Database backup. + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database that the backup was created from. + ocid: + $ref: "#/components/schemas/String" + description: The Oracle Cloud Identifier (OCID) of the Autonomous Database backup. displayName: $ref: "#/components/schemas/String" - description: The display name of the ODB peering connection. + description: The user-friendly name of the Autonomous Database backup. + dbVersion: + $ref: "#/components/schemas/String" + description: The Oracle Database software version of the Autonomous Database backup. status: - $ref: "#/components/schemas/ResourceStatus" - description: The status of the ODB peering connection. + $ref: "#/components/schemas/AutonomousDatabaseBackupStatus" + description: The current status of the Autonomous Database backup. statusReason: $ref: "#/components/schemas/String" - description: The reason for the current status of the ODB peering connection. - odbPeeringConnectionId: - $ref: "#/components/schemas/String" - description: The unique identifier of the ODB peering connection. - required: - - odbPeeringConnectionId - ResourceId: + description: Additional information about the current status of the Autonomous Database backup, if applicable. + isAutomatic: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the backup was created automatically. + retentionPeriodInDays: + $ref: "#/components/schemas/Integer" + description: The retention period, in days, for the Autonomous Database backup. + sizeInTBs: + $ref: "#/components/schemas/Double" + description: The size of the Autonomous Database backup, in terabytes (TB). + timeAvailableTill: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time until which the Autonomous Database backup is available for restore. + timeStarted: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database backup started. + timeEnded: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database backup ended. + type_: + $ref: "#/components/schemas/AutonomousDatabaseBackupType" + description: The type of the Autonomous Database backup. + AutonomousDatabaseBackupStatus: type: string - minLength: 6 - maxLength: 64 - pattern: "[a-zA-Z0-9_~.-]+" - DeleteCloudAutonomousVmClusterOutput: - type: object - DeleteCloudExadataInfrastructureOutput: - type: object - DeleteCloudVmClusterOutput: - type: object - DeleteOdbNetworkOutput: + enum: + - ACTIVE + - CREATING + - UPDATING + - DELETING + - FAILED + AutonomousDatabaseBackupType: + type: string + enum: + - INCREMENTAL + - FULL + - LONGTERM + - VIRTUAL_FULL + - CUMULATIVE_INCREMENTAL + - ROLL_FORWARD_IMAGE_COPY + GetAutonomousDatabaseWalletDetailsOutput: type: object - DeleteOdbPeeringConnectionOutput: + properties: + autonomousDatabaseWalletDetails: + $ref: "#/components/schemas/AutonomousDatabaseWalletDetails" + description: The wallet details for the Autonomous Database. + required: + - autonomousDatabaseWalletDetails + AutonomousDatabaseWalletDetails: + description: The wallet details for an Autonomous Database. type: object - DisassociateIamRoleFromResourceInputResourceArnString: + properties: + status: + $ref: "#/components/schemas/AutonomousDatabaseWalletStatus" + description: The current status of the Autonomous Database wallet. + timeRotated: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database wallet was last rotated. + passwordSourceSummary: + $ref: "#/components/schemas/WalletPasswordSourceSummary" + description: The summary of the password source configuration for the Autonomous Database wallet. + AutonomousDatabaseWalletStatus: type: string - minLength: 20 - maxLength: 2048 - pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster)/[a-z0-9-_]+ - DisassociateIamRoleFromResourceOutput: + enum: + - ACTIVE + - UPDATING + WalletPasswordSourceSummary: + description: A summary of the password source configuration for an Autonomous Database wallet. + type: object + properties: + passwordSource: + $ref: "#/components/schemas/WalletPasswordSource" + description: The source of the password for the Autonomous Database wallet. + passwordSourceConfiguration: + $ref: "#/components/schemas/WalletPasswordSourceConfiguration" + description: The configuration of the password source for the Autonomous Database wallet. + WalletPasswordSourceConfiguration: + description: The configuration of the wallet password source. This is a union, so only one of the following members can be specified. type: object + properties: + customerManagedAwsSecret: + $ref: "#/components/schemas/CustomerManagedAwsSecretConfiguration" + description: The configuration for a customer-managed Amazon Web Services Secrets Manager secret used as the wallet password source. GetCloudAutonomousVmClusterOutput: type: object properties: @@ -2475,22 +5638,6 @@ components: description: The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster. required: - cloudAutonomousVmClusterId - ResourceArn: - type: string - minLength: 20 - maxLength: 2048 - pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64} - Float: - type: number - format: float - ComputeModel: - type: string - enum: - - ECPU - - OCPU - SyntheticTimestamp_date_time: - type: string - format: date-time IamRoleList: type: array items: @@ -2788,7 +5935,7 @@ components: description: The domain of the VM cluster. scanDnsName: $ref: "#/components/schemas/String" - description: The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. + description: The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. scanDnsRecordId: $ref: "#/components/schemas/String" description: The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster. @@ -2931,7 +6078,7 @@ components: description: Number of CPU cores enabled on the DB node. dbNodeStorageSizeInGBs: $ref: "#/components/schemas/Integer" - description: The amount of local node storage, in gigabytes (GBs), that's allocated on the DB node. + description: The amount of local node storage, in gigabytes (GB), that's allocated on the DB node. dbServerId: $ref: "#/components/schemas/ResourceId" description: The unique identifier of the Db server that is associated with the DB node. @@ -3076,25 +6223,281 @@ components: description: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. type: object properties: - estimatedPatchDuration: + estimatedPatchDuration: + $ref: "#/components/schemas/Integer" + description: Estimated time, in minutes, to patch one database server. + patchingStatus: + $ref: "#/components/schemas/DbServerPatchingStatus" + description: The status of the patching operation. Possible values are SCHEDULED, MAINTENANCE_IN_PROGRESS, FAILED, and COMPLETE. + timePatchingEnded: + $ref: "#/components/schemas/String" + description: The time when the patching operation ended. + timePatchingStarted: + $ref: "#/components/schemas/String" + description: The time when the patching operation started. + DbServerPatchingStatus: + type: string + enum: + - COMPLETE + - FAILED + - MAINTENANCE_IN_PROGRESS + - SCHEDULED + GetExadbVmClusterOutput: + type: object + properties: + exadbVmCluster: + $ref: "#/components/schemas/ExadbVmCluster" + description: The Exascale VM cluster. + required: + - exadbVmCluster + ExadbVmCluster: + description: Information about an Exascale VM cluster. + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster. + clusterName: + $ref: "#/components/schemas/ClusterName" + description: The name of the Grid Infrastructure (GI) cluster. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Exascale VM cluster was created. + dataCollectionOptions: + $ref: "#/components/schemas/DataCollectionOptions" + description: The set of diagnostic collection options enabled for the Exascale VM cluster. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The user-friendly name for the Exascale VM cluster. + domain: + $ref: "#/components/schemas/String" + description: The domain of the Exascale VM cluster. + enabledEcpuCount: + $ref: "#/components/schemas/Integer" + description: The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster. + exadbVmClusterArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale VM cluster. + exascaleDbStorageVaultArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster. + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault associated with this Exascale VM cluster. + giVersion: + $ref: "#/components/schemas/String" + description: The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster. + gridImageId: + $ref: "#/components/schemas/String" + description: The Grid Infrastructure software image ID for the Exascale VM cluster. + gridImageType: + $ref: "#/components/schemas/GridImageType" + description: The type of Grid Infrastructure image for the Exascale VM cluster. + hostname: + $ref: "#/components/schemas/Hostname" + description: The host name for the Exascale VM cluster. + iamRoles: + $ref: "#/components/schemas/IamRoleList" + description: The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale VM cluster. + iormConfigCache: + $ref: "#/components/schemas/ExadataIormConfig" + description: The I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster. + lastUpdateHistoryEntryId: + $ref: "#/components/schemas/String" + description: The Oracle Cloud ID (OCID) of the last maintenance update history entry. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model applied to the Exascale VM cluster. + listenerPort: + $ref: "#/components/schemas/Integer" + description: The port number configured for the listener on the Exascale VM cluster. + memorySizeInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster. + nodeCount: + $ref: "#/components/schemas/Integer" + description: The number of nodes in the Exascale VM cluster. + ocid: + $ref: "#/components/schemas/String" + description: The OCID of the Exascale VM cluster. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the OCI resource anchor for the Exascale VM cluster. + ociUrl: + $ref: "#/components/schemas/String" + description: The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI). + odbNetworkArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster. + odbNetworkId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the ODB network for the Exascale VM cluster. + percentProgress: + $ref: "#/components/schemas/Float" + description: The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage. + scanDnsName: + $ref: "#/components/schemas/String" + description: The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the Exascale VM cluster. + scanDnsRecordId: + $ref: "#/components/schemas/String" + description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster. + scanIpIds: + $ref: "#/components/schemas/StringList" + description: The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster. + scanListenerPortTcp: + $ref: "#/components/schemas/Integer" + description: The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster. + scanListenerPortTcpSsl: + $ref: "#/components/schemas/Integer" + description: The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster. + shape: + $ref: "#/components/schemas/String" + description: The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster. + shapeAttribute: + $ref: "#/components/schemas/ShapeAttribute" + description: The shape attribute for the Exascale VM cluster. + snapshotFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The snapshot file system storage details for the Exascale VM cluster. + sshPublicKeys: + $ref: "#/components/schemas/StringList" + description: The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + systemVersion: + $ref: "#/components/schemas/String" + description: The operating system version of the image chosen for the Exascale VM cluster. + timeZone: + $ref: "#/components/schemas/String" + description: The time zone of the Exascale VM cluster. + totalEcpuCount: + $ref: "#/components/schemas/Integer" + description: The total number of ECPUs for the Exascale VM cluster. + totalFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The total file system storage details for the Exascale VM cluster. + vipIds: + $ref: "#/components/schemas/StringList" + description: The virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster. + vmFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The VM file system storage details for the Exascale VM cluster. + required: + - exadbVmClusterId + GridImageType: + type: string + enum: + - RELEASE_UPDATE + - CUSTOM_IMAGE + ExadbVmClusterStorageDetails: + description: Storage details for an Exascale VM cluster. + type: object + properties: + totalSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The total storage size, in gigabytes (GB). + GetExascaleDbStorageVaultOutput: + type: object + properties: + exascaleDbStorageVault: + $ref: "#/components/schemas/ExascaleDbStorageVault" + description: The Exascale storage vault. + required: + - exascaleDbStorageVault + ExascaleDbStorageVault: + description: Information about an Exascale storage vault. + type: object + properties: + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault. + additionalFlashCacheInPercent: + $ref: "#/components/schemas/Integer" + description: The additional flash cache percentage for the Exascale storage vault. + attachedShapeAttributes: + $ref: "#/components/schemas/ShapeAttributeList" + description: The list of shape attributes attached to the Exascale storage vault. + autoscaleLimitInGBs: + $ref: "#/components/schemas/Integer" + description: The autoscale limit in gigabytes (GB) for the Exascale storage vault. + availabilityZone: + $ref: "#/components/schemas/String" + description: The Availability Zone for the Exascale storage vault. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The Availability Zone ID for the Exascale storage vault. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Exascale storage vault was created. + description: + $ref: "#/components/schemas/String" + description: The description of the Exascale storage vault. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale storage vault. + vmClusterArns: + $ref: "#/components/schemas/ResourceArnList" + description: The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault. + vmClusterCount: + $ref: "#/components/schemas/Integer" + description: The number of VM clusters associated with this Exascale storage vault. + vmClusterIds: + $ref: "#/components/schemas/ResourceIdList" + description: The list of unique identifiers of the VM clusters associated with this Exascale storage vault. + exascaleDbStorageVaultArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale storage vault. + highCapacityDatabaseStorage: + $ref: "#/components/schemas/ExascaleDbStorageDetails" + description: The high-capacity database storage details for the Exascale storage vault. + isAutoscaleEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether autoscaling is enabled for the Exascale storage vault. + ocid: + $ref: "#/components/schemas/String" + description: The OCID of the Exascale storage vault. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the OCI resource anchor for the Exascale storage vault. + ociUrl: + $ref: "#/components/schemas/String" + description: The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI). + percentProgress: + $ref: "#/components/schemas/Float" + description: The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale storage vault. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale storage vault. + timeZone: + $ref: "#/components/schemas/String" + description: The time zone of the Exascale storage vault. + required: + - exascaleDbStorageVaultId + ShapeAttributeList: + type: array + items: + $ref: "#/components/schemas/ShapeAttribute" + ResourceArnList: + type: array + items: + $ref: "#/components/schemas/ResourceArn" + ExascaleDbStorageDetails: + description: The storage details for an Exascale storage vault. + type: object + properties: + availableSizeInGBs: $ref: "#/components/schemas/Integer" - description: Estimated time, in minutes, to patch one database server. - patchingStatus: - $ref: "#/components/schemas/DbServerPatchingStatus" - description: The status of the patching operation. Possible values are SCHEDULED, MAINTENANCE_IN_PROGRESS, FAILED, and COMPLETE. - timePatchingEnded: - $ref: "#/components/schemas/String" - description: The time when the patching operation ended. - timePatchingStarted: - $ref: "#/components/schemas/String" - description: The time when the patching operation started. - DbServerPatchingStatus: - type: string - enum: - - COMPLETE - - FAILED - - MAINTENANCE_IN_PROGRESS - - SCHEDULED + description: The available storage size, in gigabytes (GB). + totalSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The total storage size, in gigabytes (GB). GetOciOnboardingStatusOutput: type: object properties: @@ -3109,6 +6512,18 @@ components: ociIdentityDomain: $ref: "#/components/schemas/OciIdentityDomain" description: The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response. + autonomousDatabaseOciIntegrationIamRoles: + $ref: "#/components/schemas/OciIamRoleList" + description: The list of Amazon Web Services Identity and Access Management (IAM) service roles used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI). + linkedOciTenancyId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Oracle Cloud Infrastructure (OCI) tenancy that is linked to your Amazon Web Services account. + linkedOciCompartmentId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Oracle Cloud Infrastructure (OCI) compartment that is linked to your Amazon Web Services account. + subscriptionErrors: + $ref: "#/components/schemas/SubscriptionErrors" + description: The list of errors that occurred during the subscription process for your Amazon Web Services account, if any. OciOnboardingStatus: type: string enum: @@ -3146,6 +6561,51 @@ components: accountSetupCloudFormationUrl: $ref: "#/components/schemas/String" description: The Amazon Web Services CloudFormation URL for setting up the account integration with the OCI identity domain. + OciIamRoleList: + type: array + items: + $ref: "#/components/schemas/OciIamRole" + OciIamRole: + description: Information about an Amazon Web Services Identity and Access Management (IAM) service role used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI). + type: object + properties: + iamRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role. + awsIntegration: + $ref: "#/components/schemas/OciAwsIntegration" + description: The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role. + status: + $ref: "#/components/schemas/OciIamRoleStatus" + description: The current lifecycle status of the IAM service role. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the IAM service role, if applicable. + OciAwsIntegration: + type: string + enum: + - KmsTde + - SecretsManager + OciIamRoleStatus: + description: The lifecycle status of an Amazon Web Services Identity and Access Management (IAM) service role used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI). + type: string + enum: + - PROVISIONING + - AVAILABLE + - PROVISION_FAILED + - TERMINATING + - TERMINATE_FAILED + SubscriptionErrors: + type: array + items: + $ref: "#/components/schemas/SubscriptionError" + SubscriptionError: + description: Information about an error that occurred during the subscription process. + type: object + properties: + errorMessage: + $ref: "#/components/schemas/String" + description: A human-readable message that describes the subscription error. GetOdbNetworkOutput: type: object properties: @@ -3414,10 +6874,6 @@ components: status: $ref: "#/components/schemas/ManagedResourceStatus" description: The current status of the cross-Region Amazon S3 restore access configuration. - ResourceIdList: - type: array - items: - $ref: "#/components/schemas/ResourceId" GetOdbPeeringConnectionOutput: type: object properties: @@ -3464,6 +6920,546 @@ components: - odbPeeringConnectionId InitializeServiceOutput: type: object + ListAutonomousDatabaseBackupsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabaseBackupsInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListAutonomousDatabaseBackupsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabaseBackups: + $ref: "#/components/schemas/AutonomousDatabaseBackupList" + description: The list of Autonomous Database backups along with their properties. + required: + - autonomousDatabaseBackups + AutonomousDatabaseBackupList: + type: array + items: + $ref: "#/components/schemas/AutonomousDatabaseBackupSummary" + AutonomousDatabaseBackupSummary: + description: A summary of an Autonomous Database backup. + type: object + properties: + autonomousDatabaseBackupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database backup. + autonomousDatabaseBackupArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Autonomous Database backup. + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the Autonomous Database that the backup was created from. + ocid: + $ref: "#/components/schemas/String" + description: The Oracle Cloud Identifier (OCID) of the Autonomous Database backup. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database backup. + dbVersion: + $ref: "#/components/schemas/String" + description: The Oracle Database software version of the Autonomous Database backup. + status: + $ref: "#/components/schemas/AutonomousDatabaseBackupStatus" + description: The current status of the Autonomous Database backup. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database backup, if applicable. + isAutomatic: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the backup was created automatically. + retentionPeriodInDays: + $ref: "#/components/schemas/Integer" + description: The retention period, in days, for the Autonomous Database backup. + sizeInTBs: + $ref: "#/components/schemas/Double" + description: The size of the Autonomous Database backup, in terabytes (TB). + timeAvailableTill: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time until which the Autonomous Database backup is available for restore. + timeStarted: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database backup started. + timeEnded: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database backup ended. + type_: + $ref: "#/components/schemas/AutonomousDatabaseBackupType" + description: The type of the Autonomous Database backup. + ListAutonomousDatabaseCharacterSetsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabaseCharacterSetsInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + characterSetType: + type: string + enum: + - DATABASE + - NATIONAL + ListAutonomousDatabaseCharacterSetsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabaseCharacterSets: + $ref: "#/components/schemas/AutonomousDatabaseCharacterSetList" + description: The list of available Autonomous Database character sets. + required: + - autonomousDatabaseCharacterSets + AutonomousDatabaseCharacterSetList: + type: array + items: + $ref: "#/components/schemas/AutonomousDatabaseCharacterSetSummary" + AutonomousDatabaseCharacterSetSummary: + description: A summary of an available character set for Autonomous Databases. + type: object + properties: + characterSet: + $ref: "#/components/schemas/String" + description: The name of the character set. + ListAutonomousDatabaseClonesInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabaseClonesInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListAutonomousDatabaseClonesOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabaseClones: + $ref: "#/components/schemas/AutonomousDatabaseList" + description: The list of Autonomous Database clones along with their properties. + required: + - autonomousDatabaseClones + AutonomousDatabaseList: + type: array + items: + $ref: "#/components/schemas/AutonomousDatabaseSummary" + AutonomousDatabaseSummary: + description: A summary of an Autonomous Database. + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Autonomous Database. + autonomousDatabaseArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Autonomous Database. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database. + percentProgress: + $ref: "#/components/schemas/Float" + description: The progress of the current operation on the Autonomous Database, as a percentage. + ocid: + $ref: "#/components/schemas/String" + description: The Oracle Cloud Identifier (OCID) of the Autonomous Database. + ociUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the OCI console page for the Autonomous Database. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + dbName: + $ref: "#/components/schemas/String" + description: The name of the Autonomous Database. + sourceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the source from which the Autonomous Database was created. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database, if applicable. + databaseType: + $ref: "#/components/schemas/DatabaseType" + description: The type of the Autonomous Database, either a regular database or a clone. + dbVersion: + $ref: "#/components/schemas/String" + description: The Oracle Database software version of the Autonomous Database. + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. + characterSet: + $ref: "#/components/schemas/String" + description: The character set of the Autonomous Database. + ncharacterSet: + $ref: "#/components/schemas/String" + description: The national character set of the Autonomous Database. + databaseEdition: + $ref: "#/components/schemas/DatabaseEdition" + description: The Oracle Database edition of the Autonomous Database. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model that applies to the Autonomous Database. + openMode: + $ref: "#/components/schemas/OpenMode" + description: The mode in which the Autonomous Database is open, either read-only or read/write. + permissionLevel: + $ref: "#/components/schemas/PermissionLevel" + description: The permission level of the Autonomous Database. + isMtlsConnectionRequired: + $ref: "#/components/schemas/Boolean" + description: Indicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. + autonomousMaintenanceScheduleType: + $ref: "#/components/schemas/AutonomousMaintenanceScheduleType" + description: The maintenance schedule type for the Autonomous Database. + netServicesArchitecture: + $ref: "#/components/schemas/NetServicesArchitecture" + description: The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared. + availableUpgradeVersions: + $ref: "#/components/schemas/StringList" + description: The list of Oracle Database software versions to which the Autonomous Database can be upgraded. + byolComputeCountLimit: + $ref: "#/components/schemas/Integer" + description: The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. + connectionStringDetails: + $ref: "#/components/schemas/AutonomousDatabaseConnectionStrings" + description: The connection string details for the Autonomous Database. + serviceConsoleUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing the Oracle service console for the Autonomous Database. + sqlWebDeveloperUrl: + $ref: "#/components/schemas/String" + description: The URL for accessing Oracle SQL Developer Web for the Autonomous Database. + customerContacts: + $ref: "#/components/schemas/CustomerContacts" + description: The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database. + apexDetails: + $ref: "#/components/schemas/AutonomousDatabaseApex" + description: The Oracle Application Express (APEX) details for the Autonomous Database. + standbyDb: + $ref: "#/components/schemas/DatabaseStandbySummary" + description: The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration. + localStandbyDb: + $ref: "#/components/schemas/DatabaseStandbySummary" + description: The details of the local standby Autonomous Database in an Oracle Data Guard configuration. + dataSafeStatus: + $ref: "#/components/schemas/DataSafeStatus" + description: The status of the Oracle Data Safe registration for the Autonomous Database. + databaseManagementStatus: + $ref: "#/components/schemas/DatabaseManagementStatus" + description: The status of Oracle Database Management for the Autonomous Database. + operationsInsightsStatus: + $ref: "#/components/schemas/OperationsInsightsStatus" + description: The status of Oracle Operations Insights for the Autonomous Database. + availabilityZone: + $ref: "#/components/schemas/String" + description: The Availability Zone where the Autonomous Database is located. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Availability Zone where the Autonomous Database is located. + maintenanceTargetComponent: + $ref: "#/components/schemas/String" + description: The component on the Autonomous Database that the current maintenance is being applied to. + connectionUrls: + $ref: "#/components/schemas/AutonomousDatabaseConnectionUrls" + description: The connection URLs for accessing tools and services for the Autonomous Database. + dbToolsDetails: + $ref: "#/components/schemas/DatabaseToolList" + description: The list of database management tools enabled for the Autonomous Database. + scheduledOperations: + $ref: "#/components/schemas/ScheduledOperationDetailsList" + description: The list of scheduled start and stop times for the Autonomous Database. + resourcePoolLeaderId: + $ref: "#/components/schemas/String" + description: The unique identifier of the resource pool leader Autonomous Database. + computeCount: + $ref: "#/components/schemas/Float" + description: The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database. + computeModel: + $ref: "#/components/schemas/ComputeModel" + description: The compute model of the Autonomous Database, either ECPU or OCPU. + cpuCoreCount: + $ref: "#/components/schemas/Integer" + description: The number of CPU cores allocated to the Autonomous Database. + memoryPerOracleComputeUnitInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of memory allocated per Oracle Compute Unit, in GB. + provisionableCpus: + $ref: "#/components/schemas/IntegerList" + description: The list of CPU core counts that you can provision for the Autonomous Database. + isAutoScalingEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database. + dataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The size, in terabytes (TB), of the data volume allocated for the Autonomous Database. + dataStorageSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The size, in gigabytes (GB), of the data volume allocated for the Autonomous Database. + usedDataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The amount of data storage currently in use by the Autonomous Database, in TB. + usedDataStorageSizeInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of data storage currently in use by the Autonomous Database, in GB. + actualUsedDataStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The actual amount of data storage currently in use by the Autonomous Database, in TB. + allocatedStorageSizeInTBs: + $ref: "#/components/schemas/Double" + description: The amount of storage currently allocated to the Autonomous Database, in TB. + inMemoryAreaInGBs: + $ref: "#/components/schemas/Integer" + description: The size of the in-memory area of the Autonomous Database, in GB. + isAutoScalingForStorageEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether automatic scaling of the storage is enabled for the Autonomous Database. + odbNetworkId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the ODB network associated with the Autonomous Database. + odbNetworkArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the ODB network associated with the Autonomous Database. + privateEndpoint: + $ref: "#/components/schemas/String" + description: The private endpoint for the Autonomous Database. + privateEndpointIp: + $ref: "#/components/schemas/String" + description: The private endpoint IP address for the Autonomous Database. + privateEndpointLabel: + $ref: "#/components/schemas/String" + description: The private endpoint label for the Autonomous Database. + allowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the Autonomous Database. + standbyAllowlistedIps: + $ref: "#/components/schemas/StringList" + description: The list of IP addresses that are allowed to access the standby Autonomous Database. + standbyAllowlistedIpsSource: + $ref: "#/components/schemas/StandbyAllowlistedIpsSource" + description: The source of the allowlisted IP addresses for the standby Autonomous Database. + isLocalDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether local Oracle Data Guard is enabled for the Autonomous Database. + isRemoteDataGuardEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database. + localDisasterRecoveryType: + $ref: "#/components/schemas/DisasterRecoveryType" + description: The type of local disaster recovery configured for the Autonomous Database. + role: + $ref: "#/components/schemas/DataGuardRole" + description: The Oracle Data Guard role of the Autonomous Database. + peerDbIds: + $ref: "#/components/schemas/StringList" + description: The list of unique identifiers of the peer Autonomous Databases. + failedDataRecoveryInSeconds: + $ref: "#/components/schemas/Integer" + description: The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database. + localAdgAutoFailoverMaxDataLossLimit: + $ref: "#/components/schemas/Integer" + description: The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database. + remoteDisasterRecoveryConfiguration: + $ref: "#/components/schemas/DisasterRecoveryConfiguration" + description: The configuration of the remote disaster recovery for the Autonomous Database. + isRefreshableClone: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the Autonomous Database is a refreshable clone. + refreshableMode: + $ref: "#/components/schemas/RefreshableMode" + description: The refresh mode of the refreshable clone Autonomous Database. + refreshableStatus: + $ref: "#/components/schemas/RefreshableStatus" + description: The refresh status of the refreshable clone Autonomous Database. + autoRefreshFrequencyInSeconds: + $ref: "#/components/schemas/Integer" + description: The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed. + autoRefreshPointLagInSeconds: + $ref: "#/components/schemas/Integer" + description: The time lag, in seconds, between the refreshable clone and its source Autonomous Database. + isReconnectCloneEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled. + cloneTableSpaceList: + $ref: "#/components/schemas/IntegerList" + description: The list of tablespace identifiers to clone for the Autonomous Database. + backupRetentionPeriodInDays: + $ref: "#/components/schemas/Integer" + description: The retention period, in days, for automatic backups of the Autonomous Database. + longTermBackupSchedule: + $ref: "#/components/schemas/LongTermBackupSchedule" + description: The long-term backup schedule for the Autonomous Database. + isBackupRetentionLocked: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the backup retention period of the Autonomous Database is locked. + totalBackupStorageSizeInGBs: + $ref: "#/components/schemas/Double" + description: The total amount of backup storage used by the Autonomous Database, in GB. + resourcePoolSummary: + $ref: "#/components/schemas/ResourcePoolSummary" + description: The configuration of the resource pool for the Autonomous Database. + encryptionSummary: + $ref: "#/components/schemas/EncryptionSummary" + description: The encryption configuration for the Autonomous Database. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database was created. + timeOfLastBackup: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last backup of the Autonomous Database. + timeMaintenanceBegin: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the Autonomous Database begins. + timeMaintenanceEnd: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the next maintenance of the Autonomous Database ends. + timeLocalDataGuardEnabled: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when local Oracle Data Guard was enabled for the Autonomous Database. + timeDataGuardRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Oracle Data Guard role of the Autonomous Database last changed. + timeOfLastSwitchover: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last switchover operation for the Autonomous Database. + timeOfLastFailover: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last failover operation for the Autonomous Database. + timeOfLastRefresh: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the last refresh of the refreshable clone Autonomous Database. + timeOfLastRefreshPoint: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time as of which the data in the refreshable clone Autonomous Database is current. + timeOfNextRefresh: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the next scheduled refresh of the refreshable clone Autonomous Database. + timeOfAutoRefreshStart: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts. + timeDeletionOfFreeAutonomousDatabase: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted. + timeReclamationOfFreeAutonomousDatabase: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity. + timeDisasterRecoveryRoleChanged: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the disaster recovery role of the Autonomous Database last changed. + timeUntilReconnectCloneEnabled: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed. + nextLongTermBackupTimeStamp: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time of the next scheduled long-term backup of the Autonomous Database. + timeUndeleted: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Autonomous Database was restored after deletion. + adminPasswordSourceSummary: + $ref: "#/components/schemas/AdminPasswordSourceSummary" + description: The summary of the admin password source configuration for the Autonomous Database. + ListAutonomousDatabasePeersInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabasePeersInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListAutonomousDatabasePeersOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabasePeers: + $ref: "#/components/schemas/AutonomousDatabasePeerList" + description: The list of peer databases for the Autonomous Database. + required: + - autonomousDatabasePeers + AutonomousDatabasePeerList: + type: array + items: + $ref: "#/components/schemas/AutonomousDatabasePeerSummary" + AutonomousDatabasePeerSummary: + description: A summary of a peer database of an Autonomous Database. + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the peer Autonomous Database. + autonomousDatabaseArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the peer Autonomous Database. + ocid: + $ref: "#/components/schemas/String" + description: The Oracle Cloud Identifier (OCID) of the peer Autonomous Database. + region: + $ref: "#/components/schemas/String" + description: The Amazon Web Services Region where the peer Autonomous Database is located. + ListAutonomousDatabaseVersionsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabaseVersionsInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListAutonomousDatabaseVersionsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabaseVersions: + $ref: "#/components/schemas/AutonomousDatabaseVersionList" + description: The list of available Autonomous Database software versions. + required: + - autonomousDatabaseVersions + AutonomousDatabaseVersionList: + type: array + items: + $ref: "#/components/schemas/AutonomousDatabaseVersionSummary" + AutonomousDatabaseVersionSummary: + description: A summary of an available Oracle Database software version for Autonomous Databases. + type: object + properties: + dbWorkload: + $ref: "#/components/schemas/DbWorkload" + description: The intended use of the Autonomous Database that the version supports, such as transaction processing, data warehouse, JSON database, or APEX. + details: + $ref: "#/components/schemas/String" + description: Additional details about the Autonomous Database software version. + version: + $ref: "#/components/schemas/String" + description: The Oracle Database software version. + ListAutonomousDatabasesInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListAutonomousDatabasesInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListAutonomousDatabasesOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + autonomousDatabases: + $ref: "#/components/schemas/AutonomousDatabaseList" + description: The list of Autonomous Databases along with their properties. + required: + - autonomousDatabases ListAutonomousVirtualMachinesInputMaxResultsInteger: type: integer minimum: 1 @@ -3969,7 +7965,7 @@ components: description: The domain of the VM cluster. scanDnsName: $ref: "#/components/schemas/String" - description: The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. + description: The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. scanDnsRecordId: $ref: "#/components/schemas/String" description: The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster. @@ -4209,116 +8205,430 @@ components: type: integer minimum: 1 maximum: 1000 - ListDbSystemShapesInputNextTokenString: + ListDbSystemShapesInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListDbSystemShapesInputAvailabilityZoneString: + type: string + minLength: 1 + maxLength: 255 + ListDbSystemShapesInputAvailabilityZoneIdString: + type: string + minLength: 1 + maxLength: 255 + ListDbSystemShapesInputShapeFamilyString: + type: string + minLength: 1 + maxLength: 255 + ListDbSystemShapesOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + dbSystemShapes: + $ref: "#/components/schemas/DbSystemShapeList" + description: The list of shapes and their properties. + required: + - dbSystemShapes + DbSystemShapeList: + type: array + items: + $ref: "#/components/schemas/DbSystemShapeSummary" + DbSystemShapeSummary: + description: Information about a hardware system model (shape) that's available for an Exadata infrastructure. The shape determines resources, such as CPU cores, memory, and storage, to allocate to the Exadata infrastructure. + type: object + properties: + availableCoreCount: + $ref: "#/components/schemas/Integer" + description: The maximum number of CPU cores that can be enabled for the shape. + availableCoreCountPerNode: + $ref: "#/components/schemas/Integer" + description: The maximum number of CPU cores per DB node that can be enabled for the shape. + availableDataStorageInTBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of data storage, in terabytes (TB), that can be enabled for the shape. + availableDataStoragePerServerInTBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of data storage, in terabytes (TB), that's available per storage server for the shape. + availableDbNodePerNodeInGBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of DB node storage, in gigabytes (GB), that's available per DB node for the shape. + availableDbNodeStorageInGBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of DB node storage, in gigabytes (GB), that can be enabled for the shape. + availableMemoryInGBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of memory, in gigabytes (GB), that can be enabled for the shape. + availableMemoryPerNodeInGBs: + $ref: "#/components/schemas/Integer" + description: The maximum amount of memory, in gigabytes (GB), that's available per DB node for the shape. + coreCountIncrement: + $ref: "#/components/schemas/Integer" + description: The discrete number by which the CPU core count for the shape can be increased or decreased. + maxStorageCount: + $ref: "#/components/schemas/Integer" + description: The maximum number of Exadata storage servers that's available for the shape. + maximumNodeCount: + $ref: "#/components/schemas/Integer" + description: The maximum number of compute servers that is available for the shape. + minCoreCountPerNode: + $ref: "#/components/schemas/Integer" + description: The minimum number of CPU cores that can be enabled per node for the shape. + minDataStorageInTBs: + $ref: "#/components/schemas/Integer" + description: The minimum amount of data storage, in terabytes (TB), that must be allocated for the shape. + minDbNodeStoragePerNodeInGBs: + $ref: "#/components/schemas/Integer" + description: The minimum amount of DB node storage, in gigabytes (GB), that must be allocated per DB node for the shape. + minMemoryPerNodeInGBs: + $ref: "#/components/schemas/Integer" + description: The minimum amount of memory, in gigabytes (GB), that must be allocated per DB node for the shape. + minStorageCount: + $ref: "#/components/schemas/Integer" + description: The minimum number of Exadata storage servers that are available for the shape. + minimumCoreCount: + $ref: "#/components/schemas/Integer" + description: The minimum number of CPU cores that can be enabled for the shape. + minimumNodeCount: + $ref: "#/components/schemas/Integer" + description: The minimum number of compute servers that are available for the shape. + runtimeMinimumCoreCount: + $ref: "#/components/schemas/Integer" + description: The runtime minimum number of CPU cores that can be enabled for the shape. + shapeFamily: + $ref: "#/components/schemas/String" + description: The family of the shape. + shapeType: + $ref: "#/components/schemas/ShapeType" + description: The shape type. This property is determined by the CPU hardware. + shapeAttributes: + $ref: "#/components/schemas/ShapeAttributeList" + description: If provided and applicable, return DB System shape parameters based on the shape attribute provided. + name: + $ref: "#/components/schemas/String" + description: The name of the shape. + computeModel: + $ref: "#/components/schemas/ComputeModel" + description: "The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled." + areServerTypesSupported: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the hardware system model supports configurable database and server storage types. + ShapeType: + type: string + enum: + - AMD + - INTEL + - INTEL_FLEX_X9 + - AMPERE_FLEX_A1 + ListExadbVmClustersInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListExadbVmClustersInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListExadbVmClustersOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + exadbVmClusters: + $ref: "#/components/schemas/ExadbVmClusterList" + description: The list of Exascale VM clusters. + required: + - exadbVmClusters + ExadbVmClusterList: + type: array + items: + $ref: "#/components/schemas/ExadbVmClusterSummary" + ExadbVmClusterSummary: + description: Summary information about an Exascale VM cluster. + type: object + properties: + exadbVmClusterId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale VM cluster. + clusterName: + $ref: "#/components/schemas/ClusterName" + description: The name of the Grid Infrastructure (GI) cluster. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Exascale VM cluster was created. + dataCollectionOptions: + $ref: "#/components/schemas/DataCollectionOptions" + description: The set of diagnostic collection options enabled for the Exascale VM cluster. + displayName: + $ref: "#/components/schemas/ResourceDisplayName" + description: The user-friendly name for the Exascale VM cluster. + domain: + $ref: "#/components/schemas/String" + description: The domain of the Exascale VM cluster. + enabledEcpuCount: + $ref: "#/components/schemas/Integer" + description: The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster. + exadbVmClusterArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale VM cluster. + exascaleDbStorageVaultArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster. + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault associated with this Exascale VM cluster. + giVersion: + $ref: "#/components/schemas/String" + description: The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster. + gridImageId: + $ref: "#/components/schemas/String" + description: The Grid Infrastructure software image ID for the Exascale VM cluster. + gridImageType: + $ref: "#/components/schemas/GridImageType" + description: The type of Grid Infrastructure image for the Exascale VM cluster. + hostname: + $ref: "#/components/schemas/Hostname" + description: The host name for the Exascale VM cluster. + iamRoles: + $ref: "#/components/schemas/IamRoleList" + description: The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale VM cluster. + iormConfigCache: + $ref: "#/components/schemas/ExadataIormConfig" + description: The I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster. + lastUpdateHistoryEntryId: + $ref: "#/components/schemas/String" + description: The Oracle Cloud ID (OCID) of the last maintenance update history entry. + licenseModel: + $ref: "#/components/schemas/LicenseModel" + description: The Oracle license model applied to the Exascale VM cluster. + listenerPort: + $ref: "#/components/schemas/Integer" + description: The port number configured for the listener on the Exascale VM cluster. + memorySizeInGBs: + $ref: "#/components/schemas/Integer" + description: The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster. + nodeCount: + $ref: "#/components/schemas/Integer" + description: The number of nodes in the Exascale VM cluster. + ocid: + $ref: "#/components/schemas/String" + description: The OCID of the Exascale VM cluster. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the OCI resource anchor for the Exascale VM cluster. + ociUrl: + $ref: "#/components/schemas/String" + description: The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI). + odbNetworkArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster. + odbNetworkId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the ODB network for the Exascale VM cluster. + percentProgress: + $ref: "#/components/schemas/Float" + description: The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage. + scanDnsName: + $ref: "#/components/schemas/String" + description: The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the Exascale VM cluster. + scanDnsRecordId: + $ref: "#/components/schemas/String" + description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster. + scanIpIds: + $ref: "#/components/schemas/StringList" + description: The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster. + scanListenerPortTcp: + $ref: "#/components/schemas/Integer" + description: The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster. + scanListenerPortTcpSsl: + $ref: "#/components/schemas/Integer" + description: The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster. + shape: + $ref: "#/components/schemas/String" + description: The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster. + shapeAttribute: + $ref: "#/components/schemas/ShapeAttribute" + description: The shape attribute for the Exascale VM cluster. + snapshotFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The snapshot file system storage details for the Exascale VM cluster. + sshPublicKeys: + $ref: "#/components/schemas/StringList" + description: The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + systemVersion: + $ref: "#/components/schemas/String" + description: The operating system version of the image chosen for the Exascale VM cluster. + timeZone: + $ref: "#/components/schemas/String" + description: The time zone of the Exascale VM cluster. + totalEcpuCount: + $ref: "#/components/schemas/Integer" + description: The total number of ECPUs for the Exascale VM cluster. + totalFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The total file system storage details for the Exascale VM cluster. + vipIds: + $ref: "#/components/schemas/StringList" + description: The virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster. + vmFileSystemStorage: + $ref: "#/components/schemas/ExadbVmClusterStorageDetails" + description: The VM file system storage details for the Exascale VM cluster. + required: + - exadbVmClusterId + ListExascaleDbStorageVaultsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListExascaleDbStorageVaultsInputNextTokenString: + type: string + minLength: 1 + maxLength: 8192 + ListExascaleDbStorageVaultsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. + exascaleDbStorageVaults: + $ref: "#/components/schemas/ExascaleDbStorageVaultList" + description: The list of Exascale storage vaults. + required: + - exascaleDbStorageVaults + ExascaleDbStorageVaultList: + type: array + items: + $ref: "#/components/schemas/ExascaleDbStorageVaultSummary" + ExascaleDbStorageVaultSummary: + description: Summary information about an Exascale storage vault. + type: object + properties: + exascaleDbStorageVaultId: + $ref: "#/components/schemas/ResourceIdOrArn" + description: The unique identifier of the Exascale storage vault. + additionalFlashCacheInPercent: + $ref: "#/components/schemas/Integer" + description: The additional flash cache percentage for the Exascale storage vault. + attachedShapeAttributes: + $ref: "#/components/schemas/ShapeAttributeList" + description: The list of shape attributes attached to the Exascale storage vault. + autoscaleLimitInGBs: + $ref: "#/components/schemas/Integer" + description: The autoscale limit in gigabytes (GB) for the Exascale storage vault. + availabilityZone: + $ref: "#/components/schemas/String" + description: The Availability Zone for the Exascale storage vault. + availabilityZoneId: + $ref: "#/components/schemas/String" + description: The Availability Zone ID for the Exascale storage vault. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the Exascale storage vault was created. + description: + $ref: "#/components/schemas/String" + description: The description of the Exascale storage vault. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale storage vault. + vmClusterArns: + $ref: "#/components/schemas/ResourceArnList" + description: The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault. + vmClusterCount: + $ref: "#/components/schemas/Integer" + description: The number of VM clusters associated with this Exascale storage vault. + vmClusterIds: + $ref: "#/components/schemas/ResourceIdList" + description: The list of unique identifiers of the VM clusters associated with this Exascale storage vault. + exascaleDbStorageVaultArn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the Exascale storage vault. + highCapacityDatabaseStorage: + $ref: "#/components/schemas/ExascaleDbStorageDetails" + description: The high-capacity database storage details for the Exascale storage vault. + isAutoscaleEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether autoscaling is enabled for the Exascale storage vault. + ocid: + $ref: "#/components/schemas/String" + description: The OCID of the Exascale storage vault. + ociResourceAnchorName: + $ref: "#/components/schemas/String" + description: The name of the OCI resource anchor for the Exascale storage vault. + ociUrl: + $ref: "#/components/schemas/String" + description: The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI). + percentProgress: + $ref: "#/components/schemas/Float" + description: The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale storage vault. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale storage vault. + timeZone: + $ref: "#/components/schemas/String" + description: The time zone of the Exascale storage vault. + required: + - exascaleDbStorageVaultId + ListGiMinorVersionsInputGiVersionString: + type: string + minLength: 1 + maxLength: 255 + ListGiMinorVersionsInputMaxResultsInteger: + type: integer + minimum: 1 + maximum: 1000 + ListGiMinorVersionsInputNextTokenString: type: string minLength: 1 maxLength: 8192 - ListDbSystemShapesInputAvailabilityZoneString: + ListGiMinorVersionsInputShapeFamilyString: type: string minLength: 1 maxLength: 255 - ListDbSystemShapesInputAvailabilityZoneIdString: + ListGiMinorVersionsInputAvailabilityZoneString: type: string minLength: 1 maxLength: 255 - ListDbSystemShapesOutput: + ListGiMinorVersionsInputAvailabilityZoneIdString: + type: string + minLength: 1 + maxLength: 255 + ListGiMinorVersionsOutput: type: object properties: nextToken: $ref: "#/components/schemas/String" description: The token to include in another request to get the next page of items. This value is null when there are no more items to return. - dbSystemShapes: - $ref: "#/components/schemas/DbSystemShapeList" - description: The list of shapes and their properties. + giMinorVersions: + $ref: "#/components/schemas/GiMinorVersionList" + description: The list of GI minor versions. required: - - dbSystemShapes - DbSystemShapeList: + - giMinorVersions + GiMinorVersionList: type: array items: - $ref: "#/components/schemas/DbSystemShapeSummary" - DbSystemShapeSummary: - description: Information about a hardware system model (shape) that's available for an Exadata infrastructure. The shape determines resources, such as CPU cores, memory, and storage, to allocate to the Exadata infrastructure. + $ref: "#/components/schemas/GiMinorVersionSummary" + GiMinorVersionSummary: + description: Summary information about an Oracle Grid Infrastructure (GI) minor version. type: object properties: - availableCoreCount: - $ref: "#/components/schemas/Integer" - description: The maximum number of CPU cores that can be enabled for the shape. - availableCoreCountPerNode: - $ref: "#/components/schemas/Integer" - description: The maximum number of CPU cores per DB node that can be enabled for the shape. - availableDataStorageInTBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of data storage, in terabytes (TB), that can be enabled for the shape. - availableDataStoragePerServerInTBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of data storage, in terabytes (TB), that's available per storage server for the shape. - availableDbNodePerNodeInGBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of DB node storage, in gigabytes (GB), that's available per DB node for the shape. - availableDbNodeStorageInGBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of DB node storage, in gigabytes (GB), that can be enabled for the shape. - availableMemoryInGBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of memory, in gigabytes (GB), that can be enabled for the shape. - availableMemoryPerNodeInGBs: - $ref: "#/components/schemas/Integer" - description: The maximum amount of memory, in gigabytes (GB), that's available per DB node for the shape. - coreCountIncrement: - $ref: "#/components/schemas/Integer" - description: The discrete number by which the CPU core count for the shape can be increased or decreased. - maxStorageCount: - $ref: "#/components/schemas/Integer" - description: The maximum number of Exadata storage servers that's available for the shape. - maximumNodeCount: - $ref: "#/components/schemas/Integer" - description: The maximum number of compute servers that is available for the shape. - minCoreCountPerNode: - $ref: "#/components/schemas/Integer" - description: The minimum number of CPU cores that can be enabled per node for the shape. - minDataStorageInTBs: - $ref: "#/components/schemas/Integer" - description: The minimum amount of data storage, in terabytes (TB), that must be allocated for the shape. - minDbNodeStoragePerNodeInGBs: - $ref: "#/components/schemas/Integer" - description: The minimum amount of DB node storage, in gigabytes (GB), that must be allocated per DB node for the shape. - minMemoryPerNodeInGBs: - $ref: "#/components/schemas/Integer" - description: The minimum amount of memory, in gigabytes (GB), that must be allocated per DB node for the shape. - minStorageCount: - $ref: "#/components/schemas/Integer" - description: The minimum number of Exadata storage servers that are available for the shape. - minimumCoreCount: - $ref: "#/components/schemas/Integer" - description: The minimum number of CPU cores that can be enabled for the shape. - minimumNodeCount: - $ref: "#/components/schemas/Integer" - description: The minimum number of compute servers that are available for the shape. - runtimeMinimumCoreCount: - $ref: "#/components/schemas/Integer" - description: The runtime minimum number of CPU cores that can be enabled for the shape. - shapeFamily: + version: $ref: "#/components/schemas/String" - description: The family of the shape. - shapeType: - $ref: "#/components/schemas/ShapeType" - description: The shape type. This property is determined by the CPU hardware. - name: + description: The GI minor version. + gridImageId: $ref: "#/components/schemas/String" - description: The name of the shape. - computeModel: - $ref: "#/components/schemas/ComputeModel" - description: "The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled." - areServerTypesSupported: - $ref: "#/components/schemas/Boolean" - description: Indicates whether the hardware system model supports configurable database and server storage types. - ShapeType: - type: string - enum: - - AMD - - INTEL - - INTEL_FLEX_X9 - - AMPERE_FLEX_A1 + description: The Grid Infrastructure software image ID for this minor version. + required: + - version ListGiVersionsInputMaxResultsInteger: type: integer minimum: 1 @@ -4593,6 +8903,23 @@ components: type: object properties: {} description: The list of tags applied to the resource. + RebootAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was rebooted. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the reboot operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the reboot operation. + required: + - autonomousDatabaseId RebootDbNodeOutput: type: object properties: @@ -4607,6 +8934,57 @@ components: description: Additional information about the status of the DB node after the reboot operation. required: - dbNodeId + RestoreAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was restored. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the restore operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the restore operation. + required: + - autonomousDatabaseId + ShrinkAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was shrunk. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the shrink operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the shrink operation. + required: + - autonomousDatabaseId + StartAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was started. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the start operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the start operation. + required: + - autonomousDatabaseId StartDbNodeOutput: type: object properties: @@ -4621,6 +8999,23 @@ components: description: Additional information about the status of the DB node after the start operation. required: - dbNodeId + StopAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was stopped. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the stop operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the stop operation. + required: + - autonomousDatabaseId StopDbNodeOutput: type: object properties: @@ -4635,6 +9030,23 @@ components: description: Additional information about the status of the DB node after the stop operation. required: - dbNodeId + SwitchoverAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was switched over. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database after the switchover operation. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Autonomous Database after the switchover operation. + required: + - autonomousDatabaseId TagResourceResponse: type: object TagKeys: @@ -4647,6 +9059,93 @@ components: maxLength: 128 UntagResourceResponse: type: object + UpdateAutonomousDatabaseInputAdminPasswordString: + type: string + minLength: 12 + maxLength: 30 + UpdateAutonomousDatabaseInputComputeCountDouble: + type: number + format: double + minimum: 0.1 + maximum: 512 + UpdateAutonomousDatabaseInputCpuCoreCountInteger: + type: integer + minimum: 1 + maximum: 128 + UpdateAutonomousDatabaseInputDataStorageSizeInTBsInteger: + type: integer + minimum: 1 + maximum: 384 + UpdateAutonomousDatabaseInputDataStorageSizeInGBsInteger: + type: integer + minimum: 20 + maximum: 393216 + UpdateAutonomousDatabaseInputDbNameString: + type: string + minLength: 1 + maxLength: 30 + UpdateAutonomousDatabaseInputDbVersionString: + type: string + minLength: 1 + maxLength: 255 + UpdateAutonomousDatabaseInputBackupRetentionPeriodInDaysInteger: + type: integer + minimum: 1 + maximum: 60 + UpdateAutonomousDatabaseInputByolComputeCountLimitDouble: + type: number + format: double + minimum: 2 + UpdateAutonomousDatabaseInputLocalAdgAutoFailoverMaxDataLossLimitInteger: + type: integer + minimum: 0 + maximum: 3600 + UpdateAutonomousDatabaseInputAutoRefreshFrequencyInSecondsInteger: + type: integer + minimum: 3600 + maximum: 604800 + UpdateAutonomousDatabaseInputAutoRefreshPointLagInSecondsInteger: + type: integer + minimum: 0 + maximum: 604800 + UpdateAutonomousDatabaseOutput: + type: object + properties: + autonomousDatabaseId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database that was updated. + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database that was updated. + status: + $ref: "#/components/schemas/AutonomousDatabaseResourceStatus" + description: The current status of the Autonomous Database. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database, if applicable. + required: + - autonomousDatabaseId + UpdateAutonomousDatabaseBackupInputRetentionPeriodInDaysInteger: + type: integer + minimum: 90 + maximum: 3650 + UpdateAutonomousDatabaseBackupOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name of the Autonomous Database backup. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Autonomous Database backup. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the current status of the Autonomous Database backup, if applicable. + autonomousDatabaseBackupId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Autonomous Database backup that was updated. + required: + - autonomousDatabaseBackupId UpdateCloudExadataInfrastructureOutput: type: object properties: @@ -4664,6 +9163,77 @@ components: description: The unique identifier of the updated Exadata infrastructure. required: - cloudExadataInfrastructureId + UpdateExadbVmClusterInputEnabledEcpuCountInteger: + type: integer + minimum: 0 + UpdateExadbVmClusterInputGridImageIdString: + type: string + minLength: 1 + maxLength: 255 + UpdateExadbVmClusterInputSystemVersionString: + type: string + minLength: 1 + maxLength: 255 + UpdateExadbVmClusterInputTotalEcpuCountInteger: + type: integer + minimum: 2 + UpdateAction: + type: string + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + UpdateExadbVmClusterInputVmFileSystemStorageTotalSizeInGBsInteger: + type: integer + minimum: 0 + UpdateExadbVmClusterOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale VM cluster. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale VM cluster. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale VM cluster. + exadbVmClusterId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale VM cluster. + required: + - exadbVmClusterId + UpdateExascaleDbStorageVaultInputAdditionalFlashCacheInPercentInteger: + type: integer + minimum: 0 + UpdateExascaleDbStorageVaultInputAutoscaleLimitInGBsInteger: + type: integer + minimum: 0 + UpdateExascaleDbStorageVaultInputDescriptionString: + type: string + minLength: 1 + maxLength: 400 + UpdateExascaleDbStorageVaultInputHighCapacityDatabaseStorageTotalSizeInGBsInteger: + type: integer + minimum: 0 + UpdateExascaleDbStorageVaultOutput: + type: object + properties: + displayName: + $ref: "#/components/schemas/String" + description: The user-friendly name for the Exascale storage vault. + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Exascale storage vault. + statusReason: + $ref: "#/components/schemas/String" + description: Additional information about the status of the Exascale storage vault. + exascaleDbStorageVaultId: + $ref: "#/components/schemas/String" + description: The unique identifier of the Exascale storage vault. + required: + - exascaleDbStorageVaultId UpdateOdbNetworkOutput: type: object properties: @@ -4704,9 +9274,405 @@ components: name: iam_role_to_resources title: iam_role_to_resources methods: - associate_iam_role_to_resource: + associate_iam_role_to_resource: + operation: + $ref: "#/paths/~1AssociateIamRoleToResource/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/iam_role_to_resources/methods/associate_iam_role_to_resource" + delete: [] + exadb_vm_clusters: + id: aws.odb.exadb_vm_clusters + name: exadb_vm_clusters + title: exadb_vm_clusters + methods: + associate_virtual_machines_to_exadb_vm_cluster: + operation: + $ref: "#/paths/~1AssociateVirtualMachinesToExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + create_exadb_vm_cluster: + operation: + $ref: "#/paths/~1CreateExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_exadb_vm_cluster: + operation: + $ref: "#/paths/~1DeleteExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + disassociate_virtual_machines_from_exadb_vm_cluster: + operation: + $ref: "#/paths/~1DisassociateVirtualMachinesFromExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_exadb_vm_cluster: + operation: + $ref: "#/paths/~1GetExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.exadbVmCluster + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_exadb_vm_clusters: + operation: + $ref: "#/paths/~1ListExadbVmClusters/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.exadbVmClusters + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_exadb_vm_cluster: + operation: + $ref: "#/paths/~1UpdateExadbVmCluster/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/get_exadb_vm_cluster" + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/list_exadb_vm_clusters" + insert: + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/create_exadb_vm_cluster" + update: + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/associate_virtual_machines_to_exadb_vm_cluster" + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/disassociate_virtual_machines_from_exadb_vm_cluster" + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/update_exadb_vm_cluster" + delete: + - $ref: "#/components/x-stackQL-resources/exadb_vm_clusters/methods/delete_exadb_vm_cluster" + autonomous_databases: + id: aws.odb.autonomous_databases + name: autonomous_databases + title: autonomous_databases + methods: + create_autonomous_database: + operation: + $ref: "#/paths/~1CreateAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + create_autonomous_database_wallet: + operation: + $ref: "#/paths/~1CreateAutonomousDatabaseWallet/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_autonomous_database: + operation: + $ref: "#/paths/~1DeleteAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + failover_autonomous_database: + operation: + $ref: "#/paths/~1FailoverAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_autonomous_database: + operation: + $ref: "#/paths/~1GetAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabase + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_autonomous_databases: + operation: + $ref: "#/paths/~1ListAutonomousDatabases/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabases + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + reboot_autonomous_database: + operation: + $ref: "#/paths/~1RebootAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + restore_autonomous_database: + operation: + $ref: "#/paths/~1RestoreAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + shrink_autonomous_database: + operation: + $ref: "#/paths/~1ShrinkAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + start_autonomous_database: + operation: + $ref: "#/paths/~1StartAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + stop_autonomous_database: + operation: + $ref: "#/paths/~1StopAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + switchover_autonomous_database: + operation: + $ref: "#/paths/~1SwitchoverAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + update_autonomous_database: + operation: + $ref: "#/paths/~1UpdateAutonomousDatabase/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/get_autonomous_database" + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/list_autonomous_databases" + insert: + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/create_autonomous_database_wallet" + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/create_autonomous_database" + update: + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/update_autonomous_database" + delete: + - $ref: "#/components/x-stackQL-resources/autonomous_databases/methods/delete_autonomous_database" + autonomous_database_backups: + id: aws.odb.autonomous_database_backups + name: autonomous_database_backups + title: autonomous_database_backups + methods: + create_autonomous_database_backup: + operation: + $ref: "#/paths/~1CreateAutonomousDatabaseBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_autonomous_database_backup: operation: - $ref: "#/paths/~1AssociateIamRoleToResource/post" + $ref: "#/paths/~1DeleteAutonomousDatabaseBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_autonomous_database_backup: + operation: + $ref: "#/paths/~1GetAutonomousDatabaseBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseBackup + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_autonomous_database_backups: + operation: + $ref: "#/paths/~1ListAutonomousDatabaseBackups/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseBackups + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_autonomous_database_backup: + operation: + $ref: "#/paths/~1UpdateAutonomousDatabaseBackup/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4718,11 +9684,15 @@ components: requestBodyTranslate: algorithm: naive sqlVerbs: - select: [] - insert: [] + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_backups/methods/get_autonomous_database_backup" + - $ref: "#/components/x-stackQL-resources/autonomous_database_backups/methods/list_autonomous_database_backups" + insert: + - $ref: "#/components/x-stackQL-resources/autonomous_database_backups/methods/create_autonomous_database_backup" update: - - $ref: "#/components/x-stackQL-resources/iam_role_to_resources/methods/associate_iam_role_to_resource" - delete: [] + - $ref: "#/components/x-stackQL-resources/autonomous_database_backups/methods/update_autonomous_database_backup" + delete: + - $ref: "#/components/x-stackQL-resources/autonomous_database_backups/methods/delete_autonomous_database_backup" cloud_autonomous_vm_clusters: id: aws.odb.cloud_autonomous_vm_clusters name: cloud_autonomous_vm_clusters @@ -5001,6 +9971,95 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/cloud_vm_clusters/methods/delete_cloud_vm_cluster" + exascale_db_storage_vaults: + id: aws.odb.exascale_db_storage_vaults + name: exascale_db_storage_vaults + title: exascale_db_storage_vaults + methods: + create_exascale_db_storage_vault: + operation: + $ref: "#/paths/~1CreateExascaleDbStorageVault/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_exascale_db_storage_vault: + operation: + $ref: "#/paths/~1DeleteExascaleDbStorageVault/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_exascale_db_storage_vault: + operation: + $ref: "#/paths/~1GetExascaleDbStorageVault/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.exascaleDbStorageVault + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_exascale_db_storage_vaults: + operation: + $ref: "#/paths/~1ListExascaleDbStorageVaults/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.exascaleDbStorageVaults + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_exascale_db_storage_vault: + operation: + $ref: "#/paths/~1UpdateExascaleDbStorageVault/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/get_exascale_db_storage_vault" + - $ref: "#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/list_exascale_db_storage_vaults" + insert: + - $ref: "#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/create_exascale_db_storage_vault" + update: + - $ref: "#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/update_exascale_db_storage_vault" + delete: + - $ref: "#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/delete_exascale_db_storage_vault" odb_networks: id: aws.odb.odb_networks name: odb_networks @@ -5203,6 +10262,31 @@ components: update: - $ref: "#/components/x-stackQL-resources/iam_role_from_resources/methods/disassociate_iam_role_from_resource" delete: [] + autonomous_database_wallet_details: + id: aws.odb.autonomous_database_wallet_details + name: autonomous_database_wallet_details + title: autonomous_database_wallet_details + methods: + get_autonomous_database_wallet_details: + operation: + $ref: "#/paths/~1GetAutonomousDatabaseWalletDetails/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseWalletDetails + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_wallet_details/methods/get_autonomous_database_wallet_details" + insert: [] + update: [] + delete: [] cloud_exadata_infrastructure_unallocated_resources: id: aws.odb.cloud_exadata_infrastructure_unallocated_resources name: cloud_exadata_infrastructure_unallocated_resources @@ -5346,6 +10430,134 @@ components: insert: [] update: [] delete: [] + autonomous_database_character_sets: + id: aws.odb.autonomous_database_character_sets + name: autonomous_database_character_sets + title: autonomous_database_character_sets + methods: + list_autonomous_database_character_sets: + operation: + $ref: "#/paths/~1ListAutonomousDatabaseCharacterSets/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseCharacterSets + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_character_sets/methods/list_autonomous_database_character_sets" + insert: [] + update: [] + delete: [] + autonomous_database_clones: + id: aws.odb.autonomous_database_clones + name: autonomous_database_clones + title: autonomous_database_clones + methods: + list_autonomous_database_clones: + operation: + $ref: "#/paths/~1ListAutonomousDatabaseClones/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseClones + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_clones/methods/list_autonomous_database_clones" + insert: [] + update: [] + delete: [] + autonomous_database_peers: + id: aws.odb.autonomous_database_peers + name: autonomous_database_peers + title: autonomous_database_peers + methods: + list_autonomous_database_peers: + operation: + $ref: "#/paths/~1ListAutonomousDatabasePeers/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabasePeers + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_peers/methods/list_autonomous_database_peers" + insert: [] + update: [] + delete: [] + autonomous_database_versions: + id: aws.odb.autonomous_database_versions + name: autonomous_database_versions + title: autonomous_database_versions + methods: + list_autonomous_database_versions: + operation: + $ref: "#/paths/~1ListAutonomousDatabaseVersions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.autonomousDatabaseVersions + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/autonomous_database_versions/methods/list_autonomous_database_versions" + insert: [] + update: [] + delete: [] autonomous_virtual_machines: id: aws.odb.autonomous_virtual_machines name: autonomous_virtual_machines @@ -5410,6 +10622,38 @@ components: insert: [] update: [] delete: [] + gi_minor_versions: + id: aws.odb.gi_minor_versions + name: gi_minor_versions + title: gi_minor_versions + methods: + list_gi_minor_versions: + operation: + $ref: "#/paths/~1ListGiMinorVersions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.giMinorVersions + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/gi_minor_versions/methods/list_gi_minor_versions" + insert: [] + update: [] + delete: [] gi_versions: id: aws.odb.gi_versions name: gi_versions diff --git a/providers/src/aws/v00.00.00000/services/omics.yaml b/providers/src/aws/v00.00.00000/services/omics.yaml index 8218aa12..69a367c8 100644 --- a/providers/src/aws/v00.00.00000/services/omics.yaml +++ b/providers/src/aws/v00.00.00000/services/omics.yaml @@ -2637,8 +2637,12 @@ paths: $ref: "#/components/schemas/WorkflowVersionName" networkingMode: $ref: "#/components/schemas/NetworkingMode" + scratchStorageMode: + $ref: "#/components/schemas/ScratchStorageMode" configurationName: $ref: "#/components/schemas/ConfigurationName" + engineSettings: + $ref: "#/components/schemas/EngineSettings" required: - roleArn - outputUri @@ -4863,6 +4867,12 @@ components: configurationName: $ref: "#/components/schemas/ConfigurationName" description: Optional configuration name to use for the workflow run. + engineSettings: + $ref: "#/components/schemas/EngineSettings" + description: Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles). + scratchStorageMode: + $ref: "#/components/schemas/ScratchStorageMode" + description: Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL. required: - workflowId - roleArn @@ -4927,6 +4937,15 @@ components: enum: - RESTRICTED - VPC + EngineSettings: + type: object + ScratchStorageMode: + type: string + enum: + - LOCAL + - SHARED + minLength: 1 + maxLength: 64 SubmissionSummary: description: A summary of the submissions in a batch. type: object @@ -5831,12 +5850,18 @@ components: networkingMode: $ref: "#/components/schemas/NetworkingMode" description: Configuration for run networking behavior. If absent, this will default to RESTRICTED. + scratchStorageMode: + $ref: "#/components/schemas/ScratchStorageMode" + description: Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If absent, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL. configuration: $ref: "#/components/schemas/ConfigurationDetails" description: Configuration details for the workflow run. vpcConfig: $ref: "#/components/schemas/VpcConfigResponse" description: VPC configuration for the workflow run. + engineSettings: + $ref: "#/components/schemas/EngineSettings" + description: The engine-specific settings for the workflow run. RunArn: type: string minLength: 1 @@ -6062,6 +6087,9 @@ components: imageDetails: $ref: "#/components/schemas/ImageDetails" description: Details about the container image that this task uses. + uuid: + $ref: "#/components/schemas/TaskUuid" + description: The universally unique identifier (UUID) for the workflow task. TaskStatus: type: string enum: @@ -6122,6 +6150,11 @@ components: minLength: 1 maxLength: 128 pattern: sha[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+ + TaskUuid: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" GetS3AccessPolicyResponse: type: object properties: @@ -6448,6 +6481,13 @@ components: readmePath: $ref: "#/components/schemas/ReadmePath" description: The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + profiles: + $ref: "#/components/schemas/WorkflowProfileList" + description: The list of Nextflow profiles that are available for this workflow. Profiles allow you to select predefined configuration settings at runtime. + profileParameterTemplates: + type: object + properties: {} + description: A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile. GetWorkflowResponseStorageCapacityInteger: type: integer minimum: 0 @@ -6482,6 +6522,12 @@ components: providerEndpoint: $ref: "#/components/schemas/String" description: The endpoint URL of the source code repository provider. + WorkflowProfileList: + type: array + items: + $ref: "#/components/schemas/WorkflowProfileName" + WorkflowProfileName: + type: string GetWorkflowVersionResponse: type: object properties: @@ -6560,6 +6606,13 @@ components: readmePath: $ref: "#/components/schemas/ReadmePath" description: The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + profiles: + $ref: "#/components/schemas/WorkflowProfileList" + description: The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime. + profileParameterTemplates: + type: object + properties: {} + description: A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile. GetWorkflowVersionResponseStorageCapacityInteger: type: integer minimum: 0 @@ -7664,6 +7717,9 @@ components: instanceType: $ref: "#/components/schemas/TaskInstanceType" description: The instance type for a task. + uuid: + $ref: "#/components/schemas/TaskUuid" + description: The universally unique identifier (UUID) for the workflow task. TaskListItemCpusInteger: type: integer minimum: 1 @@ -7738,6 +7794,9 @@ components: workflowVersionName: $ref: "#/components/schemas/WorkflowVersionName" description: The name of the workflow version. + workflowName: + $ref: "#/components/schemas/WorkflowName" + description: The name of the workflow. RunListItemPriorityInteger: type: integer minimum: 0 @@ -8524,6 +8583,9 @@ components: type: object properties: {} description: Per-run AWS tags. Merged with defaultRunSetting.runTags; values in this object take precedence when keys overlap. + engineSettings: + $ref: "#/components/schemas/EngineSettings" + description: Per-run engine-specific settings. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles). Overrides defaultRunSetting.engineSettings for this run. required: - runSettingId InlineSettingPriorityInteger: diff --git a/providers/src/aws/v00.00.00000/services/opensearch.yaml b/providers/src/aws/v00.00.00000/services/opensearch.yaml index 6b32c237..b99e842a 100644 --- a/providers/src/aws/v00.00.00000/services/opensearch.yaml +++ b/providers/src/aws/v00.00.00000/services/opensearch.yaml @@ -216,6 +216,41 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociatePackagesResponse" + /2021-01-01/opensearch/application/{id}/attachDataSource: + post: + operationId: AttachDataSource + description: Attaches a data source to an OpenSearch application. The data source can be an Amazon OpenSearch Service domain or an Amazon OpenSearch Serverless collection. If both the application and data source are in the ACTIVE state, the attachment completes immediately and returns a status of ATTACHED. If either resource is not yet active, the operation stores the request and returns a status of PENDING. A background process then completes the attachment when both resources become active. Pending attachments that are not completed within 24 hours are marked as FAILED. This operation is idempotent. If a data source is already attached or pending for the same application, the existing attachment is returned. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/Id" + description: The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + dataSourceArn: + $ref: "#/components/schemas/ARN" + workspaceId: + $ref: "#/components/schemas/String" + workspaceConfiguration: + $ref: "#/components/schemas/WorkspaceConfigurationInput" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - dataSourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AttachDataSourceResponse" /2021-01-01/opensearch/domain/{domain_name}/authorizeVpcEndpointAccess: post: operationId: AuthorizeVpcEndpointAccess @@ -389,6 +424,10 @@ paths: $ref: "#/components/schemas/DeploymentStrategyOptions" AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseRequestOptions" + UseCase: + $ref: "#/components/schemas/DomainUseCase" + EngineMode: + $ref: "#/components/schemas/EngineMode" required: - DomainName responses: @@ -602,6 +641,8 @@ paths: $ref: "#/components/schemas/DataSources" appConfigs: $ref: "#/components/schemas/AppConfigs" + iamIdentityCenterOptions: + $ref: "#/components/schemas/IamIdentityCenterOptionsInput" responses: "200": description: Success @@ -968,6 +1009,35 @@ paths: application/json: schema: $ref: "#/components/schemas/DeregisterCapabilityResponse" + /2021-01-01/opensearch/application/{id}/describeDataSourceAttachment: + post: + operationId: DescribeDataSourceAttachment + description: Returns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment record exists for the specified application and data source combination. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/Id" + description: The unique identifier or name of the OpenSearch application. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + dataSourceArn: + $ref: "#/components/schemas/ARN" + required: + - dataSourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeDataSourceAttachmentResponse" /2021-01-01/opensearch/domain/{domain_name}/autoTunes: get: operationId: DescribeDomainAutoTunes @@ -1101,6 +1171,10 @@ paths: $ref: "#/components/schemas/DeploymentStrategyOptions" AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseRequestOptions" + UseCase: + $ref: "#/components/schemas/DomainUseCase" + EngineMode: + $ref: "#/components/schemas/EngineMode" responses: "200": description: Success @@ -1413,6 +1487,35 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeVpcEndpointsResponse" + /2021-01-01/opensearch/application/{id}/detachDataSource: + post: + operationId: DetachDataSource + description: Removes a data source from an OpenSearch application. The application must be in the ACTIVE state. This operation removes the data source saved object from the application and deletes the attachment record. Throws a ConflictException if the specified data source has a PENDING attachment, and a ResourceNotFoundException if the data source is not currently attached to the application. + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/Id" + description: The unique identifier or name of the OpenSearch application to detach the data source from. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + dataSourceArn: + $ref: "#/components/schemas/ARN" + required: + - dataSourceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DetachDataSourceResponse" /2021-01-01/packages/dissociate/{package_id}/{domain_name}: post: operationId: DissociatePackage @@ -1596,6 +1699,24 @@ paths: application/json: schema: $ref: "#/components/schemas/StartDomainMaintenanceResponse" + /2021-01-01/opensearch/app-migrations/{migration_id}: + get: + operationId: GetMigration + description: Retrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed. + parameters: + - name: migration_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The unique identifier of the migration job to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetMigrationResponse" /2021-01-01/packages/{package_id}/history: get: operationId: GetPackageVersionHistory @@ -1674,6 +1795,37 @@ paths: application/json: schema: $ref: "#/components/schemas/GetUpgradeStatusResponse" + /2021-01-01/opensearch/insight-feedback: + post: + operationId: InsightFeedback + description: Submits feedback for an existing insight in an Amazon OpenSearch Service domain. Allows users to provide a thumbs up or thumbs down rating and optional text feedback for a specific insight. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Entity: + $ref: "#/components/schemas/InsightFeedbackEntity" + InsightId: + $ref: "#/components/schemas/GUID" + Thumbs: + $ref: "#/components/schemas/InsightFeedbackThumbs" + FeedbackText: + $ref: "#/components/schemas/InsightFeedbackText" + required: + - Entity + - InsightId + - Thumbs + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/InsightFeedbackResponse" /2021-01-01/opensearch/list-applications: get: operationId: ListApplications @@ -1702,6 +1854,35 @@ paths: application/json: schema: $ref: "#/components/schemas/ListApplicationsResponse" + /2021-01-01/opensearch/application/{id}/listDataSourceAttachments: + post: + operationId: ListDataSourceAttachments + description: Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED). + parameters: + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/Id" + description: The unique identifier or name of the OpenSearch application to list attachments for. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + maxResults: + $ref: "#/components/schemas/Integer" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDataSourceAttachmentsResponse" /2021-01-01/opensearch/domain/{domain_name}/domainMaintenances: get: operationId: ListDomainMaintenances @@ -1871,6 +2052,69 @@ paths: application/json: schema: $ref: "#/components/schemas/ListInstanceTypeDetailsResponse" + /2021-01-01/opensearch/app-migrations: + get: + operationId: ListMigrations + description: Lists migration jobs for an Amazon OpenSearch Service application. You can filter results by migration status. Use pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: applicationId + in: query + required: true + schema: + $ref: "#/components/schemas/ApplicationId" + description: The unique identifier of the OpenSearch application to list migrations for. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: Filters the results by migration status. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/Integer" + description: The maximum number of results to return in a single call. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call to retrieve the next set of results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListMigrationsResponse" + post: + operationId: StartMigration + description: Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + applicationId: + $ref: "#/components/schemas/ApplicationId" + migrationOptions: + $ref: "#/components/schemas/MigrationOptions" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - applicationId + - migrationOptions + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartMigrationResponse" /2021-01-01/domain/{domain_name}/packages: get: operationId: ListPackagesForDomain @@ -2792,6 +3036,48 @@ components: type: array items: $ref: "#/components/schemas/DomainPackageDetails" + Id: + type: string + pattern: "[a-z0-9]{3,30}" + WorkspaceConfigurationInput: + description: Configuration for creating a new workspace when attaching a data source to an OpenSearch application. The workspace is created after the data source is successfully attached. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the workspace to create. Must be between 1 and 40 characters and can contain alphanumeric characters, parentheses, brackets, hyphens, underscores, and spaces. + workspaceType: + $ref: "#/components/schemas/String" + description: The type of workspace to create, which determines the use-case features enabled for the workspace. Valid values are OBSERVABILITY, SECURITY_ANALYTICS, and SEARCH. + required: + - name + - workspaceType + ClientToken: + type: string + minLength: 1 + maxLength: 64 + AttachDataSourceResponse: + type: object + properties: + attachmentId: + $ref: "#/components/schemas/String" + description: The unique identifier assigned to the data source attachment. + id: + $ref: "#/components/schemas/Id" + description: The unique identifier of the OpenSearch application. + arn: + $ref: "#/components/schemas/ARN" + dataSourceArn: + $ref: "#/components/schemas/ARN" + status: + $ref: "#/components/schemas/DataSourceAttachmentStatus" + description: The status of the data source attachment. Valid values are PENDING (waiting for resources to become active), ATTACHED (successfully attached), and FAILED (attachment timed out or encountered a non-retryable error). + DataSourceAttachmentStatus: + type: string + enum: + - PENDING + - ATTACHED + - FAILED AWSAccount: type: string pattern: ^[0-9]+$ @@ -2922,10 +3208,6 @@ components: DeploymentCloseDateTimeStamp: type: string format: date-time - ClientToken: - type: string - minLength: 1 - maxLength: 64 ApplicationName: type: string minLength: 3 @@ -3015,9 +3297,6 @@ components: kmsKeyArn: $ref: "#/components/schemas/KmsKeyArn" description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. - Id: - type: string - pattern: "[a-z0-9]{3,30}" IamIdentityCenterOptions: description: Configuration settings for IAM Identity Center in an OpenSearch application. type: object @@ -3515,7 +3794,7 @@ components: type: string minLength: 0 maxLength: 2048 - pattern: ^$|^https://(?!(?:10|127|169\.254|192\.168|172\.(?:1[6-9]|2[0-9]|3[01]))\.)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\.[a-zA-Z]{2,}(?::[0-9]{1,5})?(?:/[a-zA-Z0-9\-._~%!$&'()*+,;=:']*)?$ + pattern: ^$|^https://(?!(?:10|127|169\.254|192\.168|172\.(?:1[6-9]|2[0-9]|3[01]))\.)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\.[a-zA-Z]{2,}(?::[0-9]{1,5})?(?:/[a-zA-Z0-9\-._~%!$&'()*+,;=:'@]*(?:/[a-zA-Z0-9\-._~%!$&'()*+,;=:'@]*)*)?(?:\?[a-zA-Z0-9\-._~%!$&'()*+,;=:'/@?]+)?$ IAMFederationOptionsInput: description: Input parameters for configuring IAM identity federation settings. type: object @@ -3753,6 +4032,20 @@ components: description: The timestamp at which the automated snapshot pause should end. The maximum allowed duration between StartTime and EndTime is 3 days. required: - Enabled + DomainUseCase: + description: The primary use case for the domain, which determines the default configuration and the engine modes that are available. Valid values are SEARCH (full-text search, e-commerce, content discovery, and hybrid and semantic search), VECTOR (k-NN and semantic search, and retrieval-augmented generation), OBSERVABILITY (logs, metrics, traces, and dashboards), and MIXED (a combination of search and analytics). If you don't specify a use case, MIXED is used. + type: string + enum: + - SEARCH + - VECTOR + - OBSERVABILITY + - MIXED + EngineMode: + description: The engine mode for the domain. Valid values are GENERAL (the standard OpenSearch engine) and OPTIMIZED. If you don't specify an engine mode, GENERAL is used. OPTIMIZED requires OpenSearch 3.5 or later, OpenSearch Optimized instance types (OR1, OR2, OM2, or OI2) for the data tier, and is available only for the OBSERVABILITY use cases. The engine mode can't be changed after the domain is created. + type: string + enum: + - GENERAL + - OPTIMIZED CreateDomainResponse: description: The result of a CreateDomain operation. Contains the status of the newly created domain. type: object @@ -3875,6 +4168,12 @@ components: AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseOptions" description: The current status of the domain's automated snapshot pause options. + UseCase: + $ref: "#/components/schemas/DomainUseCase" + description: The primary use case for the domain. + EngineMode: + $ref: "#/components/schemas/EngineMode" + description: The engine mode for the domain. required: - DomainId - DomainName @@ -4653,6 +4952,22 @@ components: - update_failed - deleting - delete_failed + DescribeDataSourceAttachmentResponse: + type: object + properties: + attachmentId: + $ref: "#/components/schemas/String" + description: The unique identifier assigned to the data source attachment. + id: + $ref: "#/components/schemas/Id" + description: The unique identifier of the OpenSearch application. + arn: + $ref: "#/components/schemas/ARN" + dataSourceArn: + $ref: "#/components/schemas/ARN" + status: + $ref: "#/components/schemas/DataSourceAttachmentStatus" + description: The status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED. DescribeDomainResponse: description: Contains the status of the domain specified in the request. type: object @@ -4905,6 +5220,12 @@ components: AutomatedSnapshotPauseOptions: $ref: "#/components/schemas/AutomatedSnapshotPauseOptionsStatus" description: Specifies AutomatedSnapshotPauseOptions for the domain. + UseCase: + $ref: "#/components/schemas/UseCaseStatus" + description: The use case configured for the domain. + EngineMode: + $ref: "#/components/schemas/EngineModeStatus" + description: The engine mode configured for the domain. VersionStatus: description: The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain. type: object @@ -5244,6 +5565,32 @@ components: required: - Options - Status + UseCaseStatus: + description: The status of the use case for the domain. + type: object + properties: + Options: + $ref: "#/components/schemas/DomainUseCase" + description: The use case configured for the domain. + Status: + $ref: "#/components/schemas/OptionStatus" + description: The current status of the use case for the domain. + required: + - Options + - Status + EngineModeStatus: + description: The status of the engine mode for the domain. + type: object + properties: + Options: + $ref: "#/components/schemas/EngineMode" + description: The engine mode configured for the domain. + Status: + $ref: "#/components/schemas/OptionStatus" + description: The current status of the engine mode for the domain. + required: + - Options + - Status DescribeDomainHealthResponse: description: The result of a DescribeDomainHealth request. Contains health information for the requested domain. type: object @@ -5848,6 +6195,16 @@ components: enum: - ENDPOINT_NOT_FOUND - SERVER_ERROR + DetachDataSourceResponse: + type: object + properties: + id: + $ref: "#/components/schemas/Id" + description: The unique identifier of the OpenSearch application. + arn: + $ref: "#/components/schemas/ARN" + dataSourceArn: + $ref: "#/components/schemas/ARN" DissociatePackageResponse: description: Container for the response returned by an DissociatePackage operation. type: object @@ -6081,6 +6438,55 @@ components: description: The JSON schema of the index including mappings, settings, and semantic enrichment configuration. required: - IndexSchema + GetMigrationResponse: + type: object + properties: + migrationId: + $ref: "#/components/schemas/String" + description: The unique identifier of the migration job. + status: + $ref: "#/components/schemas/String" + description: The current status of the migration job. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED. + applicationId: + $ref: "#/components/schemas/ApplicationId" + description: The unique identifier of the OpenSearch application associated with the migration. + source: + $ref: "#/components/schemas/MigrationSource" + description: The source configuration for the migration, including the data source ARN. + exportedCount: + $ref: "#/components/schemas/Integer" + description: The number of saved objects exported from the source data source. + importedCount: + $ref: "#/components/schemas/Integer" + description: The number of saved objects successfully imported into the target workspace. + error: + $ref: "#/components/schemas/MigrationError" + description: Error details if the migration failed or completed with errors. + createdAt: + $ref: "#/components/schemas/UpdateTimestamp" + description: The date and time when the migration job was created. + updatedAt: + $ref: "#/components/schemas/UpdateTimestamp" + description: The date and time when the migration job was last updated. + MigrationSource: + description: The source configuration for a migration, specifying the data source from which to export saved objects. + type: object + properties: + datasourceArn: + $ref: "#/components/schemas/ARN" + description: The Amazon Resource Name (ARN) of the data source to migrate saved objects from. + required: + - datasourceArn + MigrationError: + description: Contains error details for a migration that failed or completed with errors. + type: object + properties: + code: + $ref: "#/components/schemas/String" + description: The error code identifying the type of failure. + message: + $ref: "#/components/schemas/String" + description: A human-readable description of the error. GetPackageVersionHistoryResponse: description: Container for response returned by GetPackageVersionHistory operation. type: object @@ -6207,6 +6613,48 @@ components: UpgradeName: $ref: "#/components/schemas/UpgradeName" description: A string that describes the update. + InsightFeedbackEntity: + description: Specifies the entity for which to submit insight feedback. An entity represents an Amazon OpenSearch Service domain. + type: object + properties: + Type: + $ref: "#/components/schemas/InsightFeedbackEntityType" + description: The type of the entity. Possible values are DomainName. + Value: + $ref: "#/components/schemas/InsightEntityValue" + description: The value of the entity, such as a domain name. + required: + - Type + - Value + InsightFeedbackEntityType: + description: The type of entity for which to submit insight feedback. Possible values are DomainName. + type: string + enum: + - DomainName + InsightFeedbackThumbs: + description: The thumbs up or thumbs down feedback for an insight. Possible values are Up and Down. + type: string + enum: + - Up + - Down + InsightFeedbackText: + description: Optional text feedback providing additional details about an insight. Maximum length is 1000 characters. + type: string + minLength: 0 + maxLength: 1000 + InsightFeedbackResponse: + description: The result of an InsightFeedback request. Contains the status of the feedback submission. + type: object + properties: + Status: + $ref: "#/components/schemas/InsightResponseStatus" + description: The status of the feedback submission. Possible values are SUCCESS and ERROR. + InsightResponseStatus: + description: The status of an insight response. Possible values are SUCCESS and ERROR. + type: string + enum: + - SUCCESS + - ERROR ApplicationStatuses: type: array items: @@ -6247,6 +6695,31 @@ components: lastUpdatedAt: $ref: "#/components/schemas/Timestamp" description: The timestamp of the last update to an OpenSearch application. + ListDataSourceAttachmentsResponse: + type: object + properties: + attachments: + $ref: "#/components/schemas/DataSourceAttachmentSummaryList" + description: A list of data source attachment summaries for the specified application. + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent call to retrieve the next set of results. + DataSourceAttachmentSummaryList: + type: array + items: + $ref: "#/components/schemas/DataSourceAttachmentSummary" + DataSourceAttachmentSummary: + description: Summary information about a data source attachment, including its identifier, data source ARN, and current status. + type: object + properties: + attachmentId: + $ref: "#/components/schemas/String" + description: The unique identifier assigned to the data source attachment. + dataSourceArn: + $ref: "#/components/schemas/ARN" + status: + $ref: "#/components/schemas/DataSourceAttachmentStatus" + description: The current status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED. ListDataSourcesResponse: description: The result of a ListDataSources operation. type: object @@ -6531,6 +7004,50 @@ components: type: array items: $ref: "#/components/schemas/AvailabilityZone" + ListMigrationsResponse: + type: object + properties: + migrations: + $ref: "#/components/schemas/MigrationSummaryList" + description: A list of migration job summaries for the specified application. + nextToken: + $ref: "#/components/schemas/String" + description: The pagination token to use in a subsequent call to retrieve the next set of results. + MigrationSummaryList: + type: array + items: + $ref: "#/components/schemas/MigrationSummary" + MigrationSummary: + description: A summary of a migration job, including its status and progress. + type: object + properties: + migrationId: + $ref: "#/components/schemas/String" + description: The unique identifier of the migration job. + status: + $ref: "#/components/schemas/String" + description: The current status of the migration job. + applicationId: + $ref: "#/components/schemas/ApplicationId" + description: The unique identifier of the OpenSearch application associated with the migration. + source: + $ref: "#/components/schemas/MigrationSource" + description: The source configuration for the migration. + exportedCount: + $ref: "#/components/schemas/Integer" + description: The number of saved objects exported from the source data source. + importedCount: + $ref: "#/components/schemas/Integer" + description: The number of saved objects successfully imported into the target workspace. + error: + $ref: "#/components/schemas/MigrationError" + description: Error details if the migration failed or completed with errors. + createdAt: + $ref: "#/components/schemas/UpdateTimestamp" + description: The date and time when the migration job was created. + updatedAt: + $ref: "#/components/schemas/UpdateTimestamp" + description: The date and time when the migration job was last updated. ListPackagesForDomainResponse: description: Container for the response parameters to the ListPackagesForDomain operation. type: object @@ -6768,6 +7285,80 @@ components: MaintenanceId: $ref: "#/components/schemas/RequestId" description: The request ID of requested action. + MigrationOptions: + description: The configuration options for a saved objects migration job. + type: object + properties: + source: + $ref: "#/components/schemas/MigrationSource" + description: The data source from which to export saved objects. + workspace: + $ref: "#/components/schemas/MigrationWorkspace" + description: The target workspace configuration for importing saved objects. You can specify an existing workspace or request creation of a new workspace. + exportOptions: + $ref: "#/components/schemas/ExportOptions" + description: Options to filter the scope of saved objects to export from the source. + conflictResolution: + $ref: "#/components/schemas/String" + description: The strategy for resolving conflicts when saved objects already exist in the target workspace. Valid values are CREATE_NEW_COPIES, which creates new objects with unique IDs, and overwrite, which replaces existing objects. + required: + - source + - workspace + MigrationWorkspace: + description: The target workspace configuration for a migration. You can specify an existing workspace by ID or request creation of a new workspace. + type: object + properties: + workspaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of an existing workspace to use as the migration target. Specify either this parameter or createWorkspace. + createWorkspace: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to create a new workspace as the migration target. If true, you must also specify name. + name: + $ref: "#/components/schemas/String" + description: The name of the new workspace to create. Required when createWorkspace is true. + type_: + $ref: "#/components/schemas/String" + description: The type of the new workspace to create. + ExportOptions: + description: Options to filter the scope of saved objects to export during a migration. + type: object + properties: + types: + $ref: "#/components/schemas/StringList" + description: A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query. + objects: + $ref: "#/components/schemas/SavedObjectIdentifierList" + description: A list of specific saved objects to include in the migration, identified by type and ID. + includeReferencesDeep: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to include all objects referenced by the exported objects, recursively. + SavedObjectIdentifierList: + type: array + items: + $ref: "#/components/schemas/SavedObjectIdentifier" + SavedObjectIdentifier: + description: Identifies a specific saved object by its type and unique identifier. + type: object + properties: + type_: + $ref: "#/components/schemas/String" + description: The type of the saved object, such as dashboard, visualization, index-pattern, search, or query. + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the saved object. + required: + - type_ + - id + StartMigrationResponse: + type: object + properties: + migrationId: + $ref: "#/components/schemas/String" + description: The unique identifier of the migration job. + status: + $ref: "#/components/schemas/String" + description: The initial status of the migration job. The status is PENDING when a migration is first created. ScheduleAt: type: string enum: @@ -6933,6 +7524,17 @@ components: response: openAPIDocKey: "200" mediaType: application/json + attach_data_source: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1application~1{id}~1attachDataSource/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive delete_data_source: operation: $ref: "#/paths/~12021-01-01~1opensearch~1domain~1{domain_name}~1dataSource~1{data_source_name}/delete" @@ -6956,6 +7558,17 @@ components: config: requestBodyTranslate: algorithm: naive + detach_data_source: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1application~1{id}~1detachDataSource/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/data_sources/methods/get_data_source" @@ -6964,6 +7577,7 @@ components: update: - $ref: "#/components/x-stackQL-resources/data_sources/methods/update_data_source" - $ref: "#/components/x-stackQL-resources/data_sources/methods/add_data_source" + - $ref: "#/components/x-stackQL-resources/data_sources/methods/attach_data_source" delete: - $ref: "#/components/x-stackQL-resources/data_sources/methods/delete_data_source" direct_query_data_sources: @@ -7412,6 +8026,17 @@ components: responseToken: key: $.nextToken location: body + start_migration: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1app-migrations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/applications/methods/get_application" @@ -7638,6 +8263,40 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/capabilities/methods/deregister_capability" + data_source_attachments: + id: aws.opensearch.data_source_attachments + name: data_source_attachments + title: data_source_attachments + methods: + describe_data_source_attachment: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1application~1{id}~1describeDataSourceAttachment/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_data_source_attachments: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1application~1{id}~1listDataSourceAttachments/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/data_source_attachments/methods/describe_data_source_attachment" + - $ref: "#/components/x-stackQL-resources/data_source_attachments/methods/list_data_source_attachments" + insert: [] + update: [] + delete: [] domain_auto_tunes: id: aws.opensearch.domain_auto_tunes name: domain_auto_tunes @@ -7888,6 +8547,32 @@ components: insert: [] update: [] delete: [] + migrations: + id: aws.opensearch.migrations + name: migrations + title: migrations + methods: + get_migration: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1app-migrations~1{migration_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_migrations: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1app-migrations/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/migrations/methods/get_migration" + - $ref: "#/components/x-stackQL-resources/migrations/methods/list_migrations" + insert: [] + update: [] + delete: [] package_version_histories: id: aws.opensearch.package_version_histories name: package_version_histories @@ -7943,6 +8628,39 @@ components: insert: [] update: [] delete: [] + insights: + id: aws.opensearch.insights + name: insights + title: insights + methods: + insight_feedback: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1insight-feedback/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_insights: + operation: + $ref: "#/paths/~12021-01-01~1opensearch~1insights/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/insights/methods/list_insights" + insert: [] + update: [] + delete: [] domain_maintenances: id: aws.opensearch.domain_maintenances name: domain_maintenances @@ -8000,28 +8718,6 @@ components: insert: [] update: [] delete: [] - insights: - id: aws.opensearch.insights - name: insights - title: insights - methods: - list_insights: - operation: - $ref: "#/paths/~12021-01-01~1opensearch~1insights/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/insights/methods/list_insights" - insert: [] - update: [] - delete: [] instance_type_details: id: aws.opensearch.instance_type_details name: instance_type_details diff --git a/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml b/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml index 4c296322..5d5b39d6 100644 --- a/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml +++ b/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml @@ -277,6 +277,9 @@ paths: encryptionConfig: $ref: "#/components/schemas/EncryptionConfig" description: Encryption settings for the collection. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted. clientToken: $ref: "#/components/schemas/ClientToken" description: Unique, case-sensitive identifier to ensure idempotency of the request. @@ -325,6 +328,9 @@ paths: capacityLimits: $ref: "#/components/schemas/CollectionGroupCapacityLimits" description: The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group. + generation: + $ref: "#/components/schemas/ServerlessGeneration" + description: The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN. clientToken: $ref: "#/components/schemas/ClientToken" description: Unique, case-sensitive identifier to ensure idempotency of the request. @@ -1560,6 +1566,9 @@ paths: vectorOptions: $ref: "#/components/schemas/VectorOptions" description: Configuration options for vector search capabilities in the collection. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted. clientToken: $ref: "#/components/schemas/ClientToken" description: Unique, case-sensitive identifier to ensure idempotency of the request. @@ -1915,7 +1924,7 @@ components: CollectionName: type: string minLength: 3 - maxLength: 32 + maxLength: 64 pattern: "[a-z][a-z0-9-]+" BatchGetCollectionResponse: type: object @@ -1958,6 +1967,9 @@ components: standbyReplicas: $ref: "#/components/schemas/StandbyReplicas" description: Details about an OpenSearch Serverless collection. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether deletion protection is ENABLED or DISABLED for the collection. vectorOptions: $ref: "#/components/schemas/VectorOptions" description: Configuration options for vector search capabilities in the collection. @@ -2007,6 +2019,12 @@ components: enum: - ENABLED - DISABLED + DeletionProtection: + description: Indicates whether deletion protection is ENABLED or DISABLED for the collection. When deletion protection is ENABLED, the collection cannot be deleted. + type: string + enum: + - ENABLED + - DISABLED VectorOptions: description: Configuration options for vector search capabilities in an OpenSearch Serverless collection. type: object @@ -2115,9 +2133,15 @@ components: capacityLimits: $ref: "#/components/schemas/CollectionGroupCapacityLimits" description: The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). + currentCapacity: + $ref: "#/components/schemas/CurrentCapacity" + description: Current search and indexing capacity for the collection group. numberOfCollections: $ref: "#/components/schemas/Integer" description: The number of collections associated with the collection group. + generation: + $ref: "#/components/schemas/ServerlessGeneration" + description: The generation of Amazon OpenSearch Serverless for the collection group. Tags: type: array items: @@ -2148,27 +2172,70 @@ components: type: object properties: maxIndexingCapacityInOCU: - $ref: "#/components/schemas/CollectionGroupIndexingCapacityValue" + $ref: "#/components/schemas/CollectionGroupMaxIndexingCapacityValue" description: The maximum indexing capacity for collections in the group. maxSearchCapacityInOCU: - $ref: "#/components/schemas/CollectionGroupSearchCapacityValue" + $ref: "#/components/schemas/CollectionGroupMaxSearchCapacityValue" description: The maximum search capacity for collections in the group. minIndexingCapacityInOCU: - $ref: "#/components/schemas/CollectionGroupIndexingCapacityValue" + $ref: "#/components/schemas/CollectionGroupMinIndexingCapacityValue" description: The minimum indexing capacity for collections in the group. minSearchCapacityInOCU: - $ref: "#/components/schemas/CollectionGroupSearchCapacityValue" + $ref: "#/components/schemas/CollectionGroupMinSearchCapacityValue" description: The minimum search capacity for collections in the group. - CollectionGroupIndexingCapacityValue: + CollectionGroupMaxIndexingCapacityValue: type: number format: float minimum: 1 - CollectionGroupSearchCapacityValue: + CollectionGroupMaxSearchCapacityValue: type: number format: float minimum: 1 + CollectionGroupMinIndexingCapacityValue: + type: number + format: float + minimum: 0 + CollectionGroupMinSearchCapacityValue: + type: number + format: float + minimum: 0 + CurrentCapacity: + description: Current search and indexing capacity for an OpenSearch Serverless collection group. Measured in OpenSearch Compute Units (OCUs). + type: object + properties: + search: + $ref: "#/components/schemas/CapacityDetails" + description: The search capacity for the collection group. + indexing: + $ref: "#/components/schemas/CapacityDetails" + description: The indexing capacity for the collection group. + CapacityDetails: + description: Capacity details for an OpenSearch Serverless collection group, including the current capacity and autoscaling status. + type: object + properties: + capacityInOcu: + $ref: "#/components/schemas/Float" + description: The current capacity in OpenSearch Compute Units (OCUs). + autoscalingStatus: + $ref: "#/components/schemas/AutoscalingStatus" + description: The current autoscaling status for the collection group. + Float: + type: number + format: float + AutoscalingStatus: + description: "The autoscaling status of an OpenSearch Serverless collection group: ACTION_SCALING_UP, ACTION_SCALING_DOWN, or NO_ACTION." + type: string + enum: + - ACTION_SCALING_UP + - ACTION_SCALING_DOWN + - NO_ACTION Integer: type: integer + ServerlessGeneration: + type: string + enum: + - CLASSIC + - NEXTGEN CollectionGroupErrorDetails: type: array items: @@ -2212,7 +2279,7 @@ components: - retention ResourceName: type: string - pattern: index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\-_a-z;0-9&$%]*) + pattern: index/[a-z][a-z0-9-]{3,63}/([a-z;0-9&$%][+.~=\-_a-z;0-9&$%]*) BatchGetEffectiveLifecyclePolicyResponse: type: object properties: @@ -2569,6 +2636,9 @@ components: standbyReplicas: $ref: "#/components/schemas/StandbyReplicas" description: Creates details about an OpenSearch Serverless collection. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether deletion protection is ENABLED or DISABLED for the collection. vectorOptions: $ref: "#/components/schemas/VectorOptions" description: Configuration options for vector search capabilities in the collection. @@ -2619,6 +2689,9 @@ components: capacityLimits: $ref: "#/components/schemas/CollectionGroupCapacityLimits" description: The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). + generation: + $ref: "#/components/schemas/ServerlessGeneration" + description: The generation of Amazon OpenSearch Serverless for the collection group. IndexName: type: string IndexSchema: @@ -2886,6 +2959,9 @@ components: status: $ref: "#/components/schemas/CollectionStatus" description: The current status of the collection. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether deletion protection is ENABLED or DISABLED for the collection. DeleteCollectionGroupResponse: type: object DeleteIndexResponse: @@ -3097,6 +3173,9 @@ components: description: The Epoch time when the collection group was created. capacityLimits: $ref: "#/components/schemas/CollectionGroupCapacityLimits" + generation: + $ref: "#/components/schemas/ServerlessGeneration" + description: The generation of Amazon OpenSearch Serverless for the collection group. CollectionFilters: description: A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections. type: object @@ -3384,6 +3463,9 @@ components: lastModifiedDate: $ref: "#/components/schemas/Long" description: The date and time when the collection was last modified. + deletionProtection: + $ref: "#/components/schemas/DeletionProtection" + description: Indicates whether deletion protection is ENABLED or DISABLED for the collection. UpdateCollectionGroupRequestDescriptionString: type: string minLength: 0 @@ -3419,6 +3501,9 @@ components: lastModifiedDate: $ref: "#/components/schemas/Long" description: The date and time when the collection group was last modified. + generation: + $ref: "#/components/schemas/ServerlessGeneration" + description: The generation of Amazon OpenSearch Serverless for the collection group. UpdateIndexResponse: type: object UpdateLifecyclePolicyResponse: diff --git a/providers/src/aws/v00.00.00000/services/organizations.yaml b/providers/src/aws/v00.00.00000/services/organizations.yaml index 46cd5251..fab1386f 100644 --- a/providers/src/aws/v00.00.00000/services/organizations.yaml +++ b/providers/src/aws/v00.00.00000/services/organizations.yaml @@ -21,7 +21,7 @@ paths: /AcceptHandshake: post: operationId: AcceptHandshake - description: "Accepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted. Only the management account can accept the following handshakes: Enable all features final confirmation (APPROVE_ALL_FEATURES) Billing transfer (TRANSFER_RESPONSIBILITY) For more information, see Enabling all features and Responding to a billing transfer invitation in the Organizations User Guide. Only a member account can accept the following handshakes: Invitation to join (INVITE) Approve all features request (ENABLE_ALL_FEATURES) For more information, see Responding to invitations and Enabling all features in the Organizations User Guide." + description: "Accepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted. Only the management account can accept the following handshakes: Enable all features final confirmation (APPROVE_ALL_FEATURES) Billing transfer (TRANSFER_RESPONSIBILITY) For more information, see Enabling all features and Responding to a billing transfer invitation in the Organizations User Guide. Only a member account can accept the following handshakes: Invitation to join (INVITE) Approve all features request (ENABLE_ALL_FEATURES) For more information, see Responding to invitations and Enabling all features in the Organizations User Guide. When a handshake is accepted, Organizations logs membership events in CloudTrail, available only in the management account's event history. If the account was standalone and joined a new organization, an AccountJoinedOrganization event is logged with joinedMethod:INVITED and joinedTime fields. If the account departed one organization and joined another, both an AccountDepartedOrganization event with departureMethod:LEFT and departureTime and an AccountJoinedOrganization event with joinedMethod:INVITED and joinedTime are logged in their respective management accounts. When a billing transfer (TRANSFER_RESPONSIBILITY) handshake is accepted, Organizations publishes a ResponsibilityTransferAccepted service event to CloudTrail. Each affected account receives this event, including upstream participants such as distributors in a chained transfer. For an example log entry, see Example log entries: AcceptResponsibilityTransfer in the Organizations User Guide." parameters: - name: X-Amz-Target in: header @@ -120,7 +120,7 @@ paths: /CloseAccount: post: operationId: CloseAccount - description: "Closes an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following: Use the AccountId that you sent in the CloseAccount request to provide as a parameter to the DescribeAccount operation. While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED. Check the CloudTrail log for the CloseAccountResult event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. Resources remaining within the account after closing will be automatically deleted after 90 days. During this 90-day period, the resources won't be available unless you contact Amazon Web Services Support to reopen the account. After 90 days, you can't reopen an account. You might still receive a bill after account closure. Within a rolling 30 day period you can close the higher of either 250 or 20% of the member accounts in your organization, up to a maximum of 1,000. This quota is not bound by a calendar month, but starts when you close an account. After you reach this limit, you can't close additional accounts. For more information, see Closing a member account in your organization and Quotas for Organizations in the Organizations User Guide. To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status. If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the CloseAccount request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide." + description: "Closes an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following: Use the AccountId that you sent in the CloseAccount request to provide as a parameter to the DescribeAccount operation. While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED. Check the CloudTrail log for the CloseAccountResult event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. Resources remaining within the account after closing will be automatically deleted after 90 days. During this 90-day period, the resources won't be available unless you contact Amazon Web Services Support to reopen the account. After 90 days, you can't reopen an account. You might still receive a bill after account closure. Within a rolling 30 day period you can close the higher of either 250 or 20% of the member accounts in your organization, up to a maximum of 1,000. This quota is not bound by a calendar month, but starts when you close an account. After you reach this limit, you can't close additional accounts. For more information, see Closing a member account in your organization and Quotas for Organizations in the Organizations User Guide. To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status. If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the CloseAccount request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide. After the permanent termination of the account after the 90-day waiting period, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departureMethod:CLEANED and departureTime. This event is available only in the management account's event history." parameters: - name: X-Amz-Target in: header @@ -149,7 +149,7 @@ paths: /CreateAccount: post: operationId: CreateAccount - description: "Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the Id value of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account. You can only call this operation from the management account. For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. It isn't recommended to use CreateAccount to create multiple temporary accounts, and using the CreateAccount API to close accounts is subject to a 30-day usage quota. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools." + description: "Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the Id value of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. Additionally, the AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history. This event includes joinedMethod:Created and joinedTime fields to provide context on how and when the account joined the organization. The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account. You can only call this operation from the management account. For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. It isn't recommended to use CreateAccount to create multiple temporary accounts, and using the CreateAccount API to close accounts is subject to a 30-day usage quota. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools." parameters: - name: X-Amz-Target in: header @@ -194,7 +194,7 @@ paths: /CreateGovCloudAccount: post: operationId: CreateGovCloudAccount - description: "This action is available if all of the following are true: You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide. You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region. You call this action from the management account of your organization in the commercial Region. You have the organizations:CreateGovCloudAccount permission. Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide. Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following: Verify that CloudTrail is enabled to store logs. Create an Amazon S3 bucket for CloudTrail log storage. For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists. You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide. Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address. A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide. For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools." + description: "This action is available if all of the following are true: You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide. You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region. You call this action from the management account of your organization in the commercial Region. You have the organizations:CreateGovCloudAccount permission. Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide. Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following: Verify that CloudTrail is enabled to store logs. Create an Amazon S3 bucket for CloudTrail log storage. For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists. You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide. Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the Id response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. Additionally, the AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history only for the linked commercial account. This event includes joinedMethod:Created and joinedTime fields to provide context on how and when the account joined the organization. When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address. A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide. For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools." parameters: - name: X-Amz-Target in: header @@ -239,7 +239,7 @@ paths: /CreateOrganization: post: operationId: CreateOrganization - description: Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization. This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING, no policy types are enabled by default and you can't use organization policies. + description: Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization. This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING, no policy types are enabled by default and you can't use organization policies. The AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history. This event includes joinedMethod:INVITED and joinedTime fields to provide context on how and when the account joined the organization. parameters: - name: X-Amz-Target in: header @@ -388,7 +388,7 @@ paths: /DeleteOrganization: post: operationId: DeleteOrganization - description: Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts. + description: Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts. When an organization is deleted, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departureMethod:LEFT and departureTime. This event is available only in the management account's event history. parameters: - name: X-Amz-Target in: header @@ -1071,7 +1071,7 @@ paths: /LeaveOrganization: post: operationId: LeaveOrganization - description: Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use RemoveAccountFromOrganization instead. You can only call from operation from a member account. The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling LeaveOrganization and leaving the organization. You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear. Choose a support plan Provide and verify the required contact information Provide a current payment method Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization. After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags. A newly created account has a waiting period before it can be removed from its organization. You must wait until at least four days after the account was created. Invited accounts aren't subject to this waiting period. If you are using an organization principal to call LeaveOrganization across multiple accounts, you can only do this up to 5 accounts per second in a single organization. + description: Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use RemoveAccountFromOrganization instead. You can only call from operation from a member account. When an account leaves an organization, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departureMethod:LEFT and departureTime. This event is available only in the management account's event history. The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling LeaveOrganization and leaving the organization. You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear. Choose a support plan Provide and verify the required contact information Provide a current payment method Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization. After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags. A newly created account has a waiting period before it can be removed from its organization. You must wait until at least four days after the account was created. Invited accounts aren't subject to this waiting period. If you are using an organization principal to call LeaveOrganization across multiple accounts, you can only do this up to 5 accounts per second in a single organization. parameters: - name: X-Amz-Target in: header @@ -1963,7 +1963,7 @@ paths: /RemoveAccountFromOrganization: post: operationId: RemoveAccountFromOrganization - description: Removes the specified account from the organization. The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization. You can only call this operation from the management account. Member accounts can remove themselves with LeaveOrganization instead. You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization. After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags. + description: Removes the specified account from the organization. The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization. You can only call this operation from the management account. Member accounts can remove themselves with LeaveOrganization instead. When an account is removed from an organization, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departureMethod:REMOVED and departureTime. This event is available only in the management account's event history. You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For more information, see Considerations before removing an account from an organization in the Organizations User Guide. The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization. After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags. parameters: - name: X-Amz-Target in: header @@ -2025,7 +2025,7 @@ paths: /TerminateResponsibilityTransfer: post: operationId: TerminateResponsibilityTransfer - description: Ends a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. + description: "Ends a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. When a transfer ends, Organizations publishes a ResponsibilityTransferTerminated service event to CloudTrail. Each affected account receives this event, including upstream participants such as distributors in a chained transfer. For an example log entry, see Example log entries: TerminateResponsibilityTransfer in the Organizations User Guide." parameters: - name: X-Amz-Target in: header @@ -2305,7 +2305,7 @@ components: description: 'ID for the participant: Acccount ID, organization ID, or email address. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.' Type: $ref: "#/components/schemas/HandshakePartyType" - description: The type of ID for the participant. + description: The type of ID for the participant. ORGANIZATION is valid only in the response context (identifying the inviting organization). Valid input values for the Target parameter are ACCOUNT and EMAIL only. required: - Id - Type diff --git a/providers/src/aws/v00.00.00000/services/outposts.yaml b/providers/src/aws/v00.00.00000/services/outposts.yaml index c10d3943..8d701c7a 100644 --- a/providers/src/aws/v00.00.00000/services/outposts.yaml +++ b/providers/src/aws/v00.00.00000/services/outposts.yaml @@ -96,6 +96,10 @@ paths: properties: OutpostIdentifier: $ref: "#/components/schemas/OutpostIdentifier" + QuoteIdentifier: + $ref: "#/components/schemas/QuoteIdentifier" + QuoteOptionIdentifier: + $ref: "#/components/schemas/QuoteOptionIdentifier" LineItems: $ref: "#/components/schemas/LineItemRequestListDefinition" PaymentOption: @@ -186,6 +190,111 @@ paths: application/json: schema: $ref: "#/components/schemas/ListOutpostsOutput" + /outposts/{outpost_id}/privateConnectivity: + post: + operationId: CreatePrivateConnectivityConfig + description: Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home Amazon Web Services Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure. + parameters: + - name: outpost_id + in: path + required: true + schema: + $ref: "#/components/schemas/OutpostId" + description: The ID or ARN of the Outpost. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + VpcInformationList: + $ref: "#/components/schemas/VpcInformationList" + required: + - VpcInformationList + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreatePrivateConnectivityConfigOutput" + get: + operationId: GetPrivateConnectivityConfig + description: Gets the private connectivity configuration for the specified Outpost. + parameters: + - name: outpost_id + in: path + required: true + schema: + $ref: "#/components/schemas/OutpostId" + description: The ID or ARN of the Outpost. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetPrivateConnectivityConfigOutput" + /quotes: + post: + operationId: CreateQuote + description: Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + OutpostIdentifier: + $ref: "#/components/schemas/OutpostIdentifier" + CountryCode: + $ref: "#/components/schemas/CountryCode" + RequestedCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + RequestedConstraints: + $ref: "#/components/schemas/QuoteConstraintList" + RequestedPaymentOptions: + $ref: "#/components/schemas/PaymentOptionList" + RequestedPaymentTerms: + $ref: "#/components/schemas/PaymentTermList" + Description: + $ref: "#/components/schemas/QuoteDescription" + required: + - CountryCode + - RequestedCapacities + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateQuoteOutput" + get: + operationId: ListQuotes + description: Lists the quotes for your Amazon Web Services account. + parameters: + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/Token" + description: The pagination token. + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults1000" + description: The maximum page size. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListQuotesOutput" /renewals: post: operationId: CreateRenewal @@ -354,6 +463,79 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateOutpostOutput" + /quotes/{quote_identifier}: + delete: + operationId: DeleteQuote + description: Deletes the specified quote. + parameters: + - name: quote_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/QuoteIdentifier" + description: The ID of the quote. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteQuoteOutput" + get: + operationId: GetQuote + description: Gets information about the specified quote. + parameters: + - name: quote_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/QuoteIdentifier" + description: The ID of the quote. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetQuoteOutput" + patch: + operationId: UpdateQuote + description: Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association. + parameters: + - name: quote_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/QuoteIdentifier" + description: The ID of the quote. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + OutpostIdentifier: + $ref: "#/components/schemas/OutpostIdentifierOrEmpty" + CountryCode: + $ref: "#/components/schemas/CountryCode" + RequestedCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + RequestedConstraints: + $ref: "#/components/schemas/QuoteConstraintList" + RequestedPaymentOptions: + $ref: "#/components/schemas/PaymentOptionList" + RequestedPaymentTerms: + $ref: "#/components/schemas/PaymentTermList" + Description: + $ref: "#/components/schemas/QuoteDescription" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateQuoteOutput" /sites/{site_id}: delete: operationId: DeleteSite @@ -847,6 +1029,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListCatalogItemsOutput" + /instanceTypes: + get: + operationId: ListOrderableInstanceTypes + description: Lists the instance types that can be ordered for an Outpost. You can filter the results by Outpost generation. + parameters: + - name: OutpostGenerationFilter + in: query + required: false + schema: + $ref: "#/components/schemas/OutpostGeneration" + description: Filters the results by Outpost generation. Specify GENERATION_1 for first-generation rack deployments or GENERATION_2 for second-generation rack deployments. + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults1000" + description: The maximum page size. + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/Token" + description: The pagination token. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListOrderableInstanceTypesOutput" /list-orders: get: operationId: ListOrders @@ -1146,6 +1358,16 @@ components: pattern: oo-[a-f0-9]{17}$ CancelOrderOutput: type: object + QuoteIdentifier: + type: string + minLength: 1 + maxLength: 255 + pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:quote/)?oq-[a-f0-9]{17}$ + QuoteOptionIdentifier: + type: string + minLength: 1 + maxLength: 21 + pattern: ^oqo-[a-f0-9]{17}$ LineItemRequestListDefinition: type: array items: @@ -1193,6 +1415,12 @@ components: OutpostId: $ref: "#/components/schemas/OutpostIdOnly" description: The ID of the Outpost in the order. + QuoteIdentifier: + $ref: "#/components/schemas/QuoteIdentifier" + description: The ID of the quote associated with the order. + QuoteOptionIdentifier: + $ref: "#/components/schemas/QuoteOptionIdentifier" + description: The ID of the quote option associated with the order. OrderId: $ref: "#/components/schemas/OrderId" description: The ID of the order. @@ -1419,33 +1647,508 @@ components: description: The hardware type. OutpostId: type: string - minLength: 1 - maxLength: 180 - pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$ - OwnerId: - description: The Amazon Web Services account ID of the Outpost owner. + minLength: 1 + maxLength: 180 + pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$ + OwnerId: + description: The Amazon Web Services account ID of the Outpost owner. + type: string + minLength: 12 + maxLength: 12 + pattern: \d{12} + OutpostArn: + description: The Amazon Resource Name (ARN) of the Outpost. + type: string + minLength: 1 + maxLength: 255 + pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$ + LifeCycleStatus: + description: The life cycle status. + type: string + minLength: 1 + maxLength: 20 + pattern: ^[ A-Za-z]+$ + SiteArn: + description: The Amazon Resource Name (ARN) of the site. + type: string + minLength: 1 + maxLength: 255 + pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$ + VpcInformationList: + type: array + items: + $ref: "#/components/schemas/VpcInformation" + VpcInformation: + description: Information about a VPC used for private connectivity, including its subnets and an associated VPC endpoint. + type: object + properties: + VpcId: + $ref: "#/components/schemas/VpcId" + description: The ID of the VPC used for private connectivity. + SubnetIds: + $ref: "#/components/schemas/SubnetIds" + description: The IDs of the subnets associated with the VPC endpoint. Currently, only one subnet is supported. + VpcEndpointId: + $ref: "#/components/schemas/VpcEndpointId" + description: The ID of the interface VPC endpoint for the Amazon Web Services Outposts service. When specified, the endpoint must be in the available state and the specified subnets must be associated with it. + VpcId: + type: string + minLength: 1 + maxLength: 25 + pattern: "[a-z0-9-]+" + SubnetIds: + type: array + items: + $ref: "#/components/schemas/SubnetId" + SubnetId: + type: string + minLength: 1 + maxLength: 25 + pattern: "[a-z0-9-]+" + VpcEndpointId: + type: string + minLength: 1 + maxLength: 25 + pattern: ^vpce-[a-f0-9]+$ + CreatePrivateConnectivityConfigOutput: + type: object + properties: + PrivateConnectivityConfig: + $ref: "#/components/schemas/PrivateConnectivityConfig" + description: The private connectivity configuration for the Outpost. + OutpostId: + $ref: "#/components/schemas/OutpostId" + description: The ID of the Outpost. + PrivateConnectivityConfig: + description: Information about the private connectivity configuration for an Outpost. + type: object + properties: + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the service-linked role that Amazon Web Services Outposts creates and uses to provision and attach the network interfaces for private connectivity in your VPC. The role's permissions are scoped to the specific Outpost and VPC. + PrivateConnectivityStatus: + $ref: "#/components/schemas/PrivateConnectivityStatus" + description: The status of private connectivity for the Outpost. Valid values are ENABLED and DISABLED. + VpcInformationList: + $ref: "#/components/schemas/VpcInformationList" + description: Information about the VPC used for private connectivity. + ProvisioningRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the provisioning role in your account that Amazon Web Services Outposts uses to establish the service link connection during Outpost installation. This field is present only when VPC endpoint-based provisioning is configured. + RoleArn: + type: string + minLength: 1 + maxLength: 150 + pattern: ^arn:aws([a-z-]+)?:iam::\d{12}:role\/[a-zA-Z_0-9+=,.@\-_\/]+ + PrivateConnectivityStatus: + type: string + enum: + - ENABLED + - DISABLED + CountryCode: + type: string + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + QuoteCapacityList: + type: array + items: + $ref: "#/components/schemas/QuoteCapacity" + QuoteCapacity: + description: A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity. + type: object + properties: + QuoteCapacityType: + $ref: "#/components/schemas/QuoteCapacityType" + description: The type of capacity. Valid values are EC2, EBS, and S3. + Unit: + $ref: "#/components/schemas/String" + description: The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes). + Quantity: + $ref: "#/components/schemas/NullableFloat" + description: The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost. + QuoteCapacityType: + type: string + enum: + - EC2 + - EBS + - S3 + String: + type: string + minLength: 1 + maxLength: 1000 + pattern: ^[\S \n]+$ + NullableFloat: + type: number + format: float + QuoteConstraintList: + type: array + items: + $ref: "#/components/schemas/QuoteConstraint" + QuoteConstraint: + description: A physical constraint for a quote. + type: object + properties: + QuoteConstraintType: + $ref: "#/components/schemas/QuoteConstraintType" + description: The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, and RACK_MAX_WEIGHT_LBS. + Value: + $ref: "#/components/schemas/ConstraintValue" + description: The value of the constraint. + QuoteConstraintType: + type: string + enum: + - RACK_MAXIMUM + - RACK_MAX_POWER_KVA + - RACK_MAX_WEIGHT_LBS + ConstraintValue: + type: string + minLength: 1 + maxLength: 2048 + pattern: ^[\S \n]+$ + PaymentOptionList: + type: array + items: + $ref: "#/components/schemas/PaymentOption" + PaymentTermList: + type: array + items: + $ref: "#/components/schemas/PaymentTerm" + QuoteDescription: + type: string + minLength: 0 + maxLength: 1024 + pattern: ^[\S \n]*$ + CreateQuoteOutput: + type: object + properties: + Quote: + $ref: "#/components/schemas/Quote" + description: Information about the quote. + Quote: + description: Information about a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. + type: object + properties: + QuoteId: + $ref: "#/components/schemas/QuoteId" + description: The ID of the quote. + AccountId: + $ref: "#/components/schemas/AccountId" + description: The ID of the account that owns the quote. + QuoteStatus: + $ref: "#/components/schemas/QuoteStatus" + description: The status of the quote. CREATED - The quote has been created and is available for review. ORDER_SUBMITTED - An order has been submitted for the quote. EXPIRED - The quote has expired and can no longer be used to submit an order. + StatusMessage: + $ref: "#/components/schemas/StatusMessage" + description: A message about the status of the quote. + OutpostArn: + $ref: "#/components/schemas/OutpostArn" + description: The ARN of the Outpost associated with the quote. + CountryCode: + $ref: "#/components/schemas/CountryCode" + description: The country code for the Outpost site location. + RequestedCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + description: The capacity requirements specified in the quote request. + RequestedConstraints: + $ref: "#/components/schemas/QuoteConstraintList" + description: The physical constraints specified in the quote request. + RequestedPaymentOptions: + $ref: "#/components/schemas/PaymentOptionList" + description: The payment options specified in the quote request. + RequestedPaymentTerms: + $ref: "#/components/schemas/PaymentTermList" + description: The payment terms specified in the quote request. + QuoteOptions: + $ref: "#/components/schemas/QuoteOptionList" + description: The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information. + OrderingRequirements: + $ref: "#/components/schemas/OrderingRequirementList" + description: The requirements that must be met before an order can be submitted for the quote. + SubmittedOrderId: + $ref: "#/components/schemas/OrderIdentifier" + description: The ID of the order submitted for the quote. + CreatedDate: + $ref: "#/components/schemas/ISO8601Timestamp" + description: The date the quote was created. + ExpirationDate: + $ref: "#/components/schemas/ISO8601Timestamp" + description: The date the quote expires. + Description: + $ref: "#/components/schemas/QuoteDescription" + description: The description of the quote. + QuoteId: + type: string + minLength: 1 + maxLength: 255 + pattern: ^oq-[a-f0-9]{17}$ + AccountId: + description: The ID of the Amazon Web Services account. + type: string + minLength: 12 + maxLength: 12 + pattern: \d{12} + QuoteStatus: + type: string + enum: + - CREATED + - ORDER_SUBMITTED + - EXPIRED + StatusMessage: + type: string + minLength: 1 + maxLength: 2048 + pattern: ^[\S \n]+$ + QuoteOptionList: + type: array + items: + $ref: "#/components/schemas/QuoteOption" + QuoteOption: + description: A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details. + type: object + properties: + QuoteOptionIdentifier: + $ref: "#/components/schemas/QuoteOptionIdentifier" + description: The ID of the quote option. + Capacities: + $ref: "#/components/schemas/QuoteCapacityList" + description: The capacities included in this quote option. + CapacitySummary: + $ref: "#/components/schemas/CapacitySummary" + description: A summary of the existing, final, and changed capacity for this quote option. + Specifications: + $ref: "#/components/schemas/QuoteSpecificationList" + description: The physical specifications for the racks or servers in this quote option. + PricingOptions: + $ref: "#/components/schemas/PricingOptionList" + description: The pricing options for this quote option. + CapacitySummary: + description: A summary of the capacity changes for a quote option. + type: object + properties: + ExistingCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + description: The existing capacities on the Outpost before the quote is fulfilled. + FinalCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + description: The final capacities on the Outpost after the quote is fulfilled. + CapacityChange: + $ref: "#/components/schemas/QuoteCapacityList" + description: The change in capacity between the existing and final state. + QuoteSpecificationList: + type: array + items: + $ref: "#/components/schemas/QuoteSpecification" + QuoteSpecification: + description: A physical specification for a quote option. Describes the rack or server configuration that would be deployed. + type: object + properties: + QuoteSpecificationType: + $ref: "#/components/schemas/QuoteSpecificationType" + description: The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER. + ExistingRackSpecificationDetails: + $ref: "#/components/schemas/RackSpecificationDetails" + description: The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK. + FinalRackSpecificationDetails: + $ref: "#/components/schemas/RackSpecificationDetails" + description: The final rack specification details after the quote is fulfilled. + ServerSpecificationDetails: + $ref: "#/components/schemas/ServerSpecificationDetails" + description: The server specification details, if the specification type is SERVER. + QuoteSpecificationType: + type: string + enum: + - UPDATED_RACK + - NEW_RACK + - EXISTING_RACK + - SERVER + RackSpecificationDetails: + description: The physical specification details for a rack in a quote option. + type: object + properties: + RackId: + $ref: "#/components/schemas/RackId" + description: The ID of the rack. + RackUse: + $ref: "#/components/schemas/QuoteRackUseType" + description: The use of the rack. Valid values are COMPUTE and NETWORKING. + RackPowerDrawKva: + $ref: "#/components/schemas/NullableFloat" + description: The maximum power draw of the rack in kVA. + RackWeightLbs: + $ref: "#/components/schemas/NullableFloat" + description: The weight of the rack in pounds. + RackHeightInches: + $ref: "#/components/schemas/NullableFloat" + description: The height of the rack in inches. + RackWidthInches: + $ref: "#/components/schemas/NullableFloat" + description: The width of the rack in inches. + RackDepthInches: + $ref: "#/components/schemas/NullableFloat" + description: The depth of the rack in inches. + RackUnitHeight: + $ref: "#/components/schemas/RackUnitHeight" + description: The rack unit height. HEIGHT_42U - 42 rack units. HEIGHT_2U - 2 rack units. HEIGHT_1U - 1 rack unit. + EC2Capacities: + $ref: "#/components/schemas/EC2CapacityListDefinition" + description: The Amazon EC2 capacities for the rack. + RackId: + type: string + minLength: 5 + maxLength: 20 + pattern: ^[\S \n]+$ + QuoteRackUseType: + type: string + enum: + - NETWORKING + - COMPUTE + RackUnitHeight: + type: string + enum: + - HEIGHT_42U + - HEIGHT_2U + - HEIGHT_1U + EC2CapacityListDefinition: + type: array + items: + $ref: "#/components/schemas/EC2Capacity" + EC2Capacity: + description: Information about EC2 capacity. + type: object + properties: + Family: + $ref: "#/components/schemas/Family" + description: The family of the EC2 capacity. + MaxSize: + $ref: "#/components/schemas/MaxSize" + description: The maximum size of the EC2 capacity. + Quantity: + $ref: "#/components/schemas/Quantity" + description: The quantity of the EC2 capacity. + Family: + type: string + minLength: 1 + maxLength: 10 + pattern: ^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$ + MaxSize: + type: string + Quantity: + type: string + ServerSpecificationDetails: + description: The physical specification details for a server in a quote option. + type: object + properties: + ServerPowerDrawKva: + $ref: "#/components/schemas/NullableFloat" + description: The maximum power draw of the server in kVA. + ServerWeightLbs: + $ref: "#/components/schemas/NullableFloat" + description: The weight of the server in pounds. + ServerHeightInches: + $ref: "#/components/schemas/NullableFloat" + description: The height of the server in inches. + ServerWidthInches: + $ref: "#/components/schemas/NullableFloat" + description: The width of the server in inches. + ServerDepthInches: + $ref: "#/components/schemas/NullableFloat" + description: The depth of the server in inches. + RackUnitHeight: + $ref: "#/components/schemas/RackUnitHeight" + description: The rack unit height of the server. HEIGHT_2U - 2 rack units. HEIGHT_1U - 1 rack unit. + EC2Capacities: + $ref: "#/components/schemas/EC2CapacityListDefinition" + description: The Amazon EC2 capacities for the server. + PricingOptionList: + type: array + items: + $ref: "#/components/schemas/PricingOption" + PricingOption: + description: A pricing option for the specified Outpost. + type: object + properties: + PricingType: + $ref: "#/components/schemas/QuotePricingType" + description: The type of pricing model. + SubscriptionPricingDetails: + $ref: "#/components/schemas/SubscriptionPricingDetails" + description: The subscription pricing details for this pricing option. + QuotePricingType: + type: string + enum: + - SUBSCRIPTION + SubscriptionPricingDetails: + description: The pricing details for a subscription. + type: object + properties: + PaymentOption: + $ref: "#/components/schemas/PaymentOption" + description: The payment option. + PaymentTerm: + $ref: "#/components/schemas/PaymentTerm" + description: The payment term. + UpfrontPrice: + $ref: "#/components/schemas/NullableFloat" + description: The upfront price. + MonthlyRecurringPrice: + $ref: "#/components/schemas/NullableFloat" + description: The monthly recurring price. + Currency: + $ref: "#/components/schemas/CurrencyCode" + description: The currency of the price. Currently only USD is supported. + CurrencyCode: + type: string + enum: + - USD + OrderingRequirementList: + type: array + items: + $ref: "#/components/schemas/OrderingRequirement" + OrderingRequirement: + description: A requirement that must be met before an order can be submitted for a quote. + type: object + properties: + StatusMessage: + $ref: "#/components/schemas/StatusMessage" + description: A message about the ordering requirement. + OrderingRequirementType: + $ref: "#/components/schemas/OrderingRequirementType" + description: The type of ordering requirement. Indicates which check failed or passed. OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state. MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached. VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code. RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements. OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address. SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address. COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country. OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration. OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order. ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required. SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name. SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number. SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information. OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created. OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found. OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted. UNSUPPORTED - The requirement type is not recognized. + Status: + $ref: "#/components/schemas/OrderingRequirementStatus" + description: The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT. + OrderingRequirementType: type: string - minLength: 12 - maxLength: 12 - pattern: \d{12} - OutpostArn: - description: The Amazon Resource Name (ARN) of the Outpost. + enum: + - OUTPOST_ACTIVE_CHECK_ERROR + - MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR + - VALID_ZIP_CODE_CHECK_ERROR + - RACK_PHYSICAL_PROPERTIES_CHECK_ERROR + - OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR + - SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR + - COUNTRY_CODE_MISMATCH_CHECK_ERROR + - OUTPOST_GENERATION_MISMATCH_ERROR + - UNSUPPORTED + - OUTPOST_ID_MISSING_ON_QUOTE_ERROR + - ENTERPRISE_SUPPORT_ERROR + - SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR + - SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR + - SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR + - OUTPOST_STATE_CHANGED_ERROR + - OUTPOST_NOT_FOUND_ERROR + - OUTPOST_RENEWAL_REQUIRED_ERROR + OrderingRequirementStatus: type: string - minLength: 1 - maxLength: 255 - pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$ - LifeCycleStatus: - description: The life cycle status. + enum: + - PASS + - FAIL + - EXEMPT + OrderIdentifier: type: string minLength: 1 maxLength: 20 - pattern: ^[ A-Za-z]+$ - SiteArn: - description: The Amazon Resource Name (ARN) of the site. - type: string - minLength: 1 - maxLength: 255 - pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$ + pattern: ^oo-[a-f0-9]{17}$ AutoFillIdempotencyToken: type: string minLength: 1 @@ -1469,9 +2172,9 @@ components: MonthlyRecurringPrice: $ref: "#/components/schemas/NullableFloat" description: The monthly recurring price of the renewal. - NullableFloat: - type: number - format: float + Currency: + $ref: "#/components/schemas/CurrencyCode" + description: The currency of the renewal price. SiteName: description: The name of the site. type: string @@ -1498,7 +2201,7 @@ components: description: The name of the contact. ContactPhoneNumber: $ref: "#/components/schemas/ContactPhoneNumber" - description: The phone number of the contact. + description: The phone number of the contact, including the country code (for example, +12065550100). AddressLine1: $ref: "#/components/schemas/AddressLine1" description: The first line of the address. @@ -1543,7 +2246,7 @@ components: type: string minLength: 1 maxLength: 20 - pattern: ^[\S ]+$ + pattern: \+[1-9][0-9]{1,18} AddressLine1: type: string minLength: 1 @@ -1579,11 +2282,6 @@ components: minLength: 1 maxLength: 20 pattern: ^[a-zA-Z0-9 -]+$ - CountryCode: - type: string - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ Municipality: type: string minLength: 0 @@ -1732,14 +2430,10 @@ components: RackPhysicalProperties: $ref: "#/components/schemas/RackPhysicalProperties" description: Information about the physical and logistical details for a rack at the site. - AccountId: - description: The ID of the Amazon Web Services account. - type: string - minLength: 12 - maxLength: 12 - pattern: \d{12} DeleteOutpostOutput: type: object + DeleteQuoteOutput: + type: object DeleteSiteOutput: type: object GetCapacityTaskOutput: @@ -1845,6 +2539,7 @@ components: enum: - AWS - EC2 + - EKS - ELASTICACHE - ELB - RDS @@ -1925,32 +2620,6 @@ components: enum: - AVAILABLE - DISCONTINUED - EC2CapacityListDefinition: - type: array - items: - $ref: "#/components/schemas/EC2Capacity" - EC2Capacity: - description: Information about EC2 capacity. - type: object - properties: - Family: - $ref: "#/components/schemas/Family" - description: The family of the EC2 capacity. - MaxSize: - $ref: "#/components/schemas/MaxSize" - description: The maximum size of the EC2 capacity. - Quantity: - $ref: "#/components/schemas/Quantity" - description: The quantity of the EC2 capacity. - Family: - type: string - minLength: 1 - maxLength: 10 - pattern: ^[a-z0-9]+$ - MaxSize: - type: string - Quantity: - type: string CatalogItemPowerKva: type: number format: float @@ -2090,17 +2759,15 @@ components: EndDate: $ref: "#/components/schemas/ISO8601Timestamp" description: The date your subscription ends. + Currency: + $ref: "#/components/schemas/CurrencyCode" + description: The currency of the subscription price. Currently only USD is supported. MonthlyRecurringPrice: $ref: "#/components/schemas/NullableDouble" description: The amount you are billed each month in the subscription period. UpfrontPrice: $ref: "#/components/schemas/NullableDouble" description: The amount billed when the subscription is created. This is a one-time charge. - String: - type: string - minLength: 1 - maxLength: 1000 - pattern: ^[\S \n]+$ SubscriptionType: type: string enum: @@ -2164,6 +2831,18 @@ components: $ref: "#/components/schemas/InstanceTypeListDefinition" NextToken: $ref: "#/components/schemas/Token" + GetPrivateConnectivityConfigOutput: + type: object + properties: + PrivateConnectivityConfig: + $ref: "#/components/schemas/PrivateConnectivityConfig" + description: The private connectivity configuration for the Outpost. + GetQuoteOutput: + type: object + properties: + Quote: + $ref: "#/components/schemas/Quote" + description: Information about the quote. GetRenewalPricingOutput: type: object properties: @@ -2178,40 +2857,6 @@ components: enum: - PRICED - UNABLE_TO_PRICE - PricingOptionList: - type: array - items: - $ref: "#/components/schemas/PricingOption" - PricingOption: - description: A pricing option for the specified Outpost. - type: object - properties: - PricingType: - $ref: "#/components/schemas/QuotePricingType" - description: The type of pricing model. - SubscriptionPricingDetails: - $ref: "#/components/schemas/SubscriptionPricingDetails" - description: The subscription pricing details for this pricing option. - QuotePricingType: - type: string - enum: - - SUBSCRIPTION - SubscriptionPricingDetails: - description: The pricing details for a subscription. - type: object - properties: - PaymentOption: - $ref: "#/components/schemas/PaymentOption" - description: The payment option. - PaymentTerm: - $ref: "#/components/schemas/PaymentTerm" - description: The payment term. - UpfrontPrice: - $ref: "#/components/schemas/NullableFloat" - description: The upfront price. - MonthlyRecurringPrice: - $ref: "#/components/schemas/NullableFloat" - description: The monthly recurring price. GetSiteOutput: type: object properties: @@ -2339,11 +2984,6 @@ components: AssetLocation: $ref: "#/components/schemas/AssetLocation" description: The position of an asset in a rack. - RackId: - type: string - minLength: 5 - maxLength: 20 - pattern: ^[\S \n]+$ ComputeAttributes: description: Information about compute hardware assets. type: object @@ -2501,6 +3141,66 @@ components: type: array items: $ref: "#/components/schemas/CatalogItem" + OutpostGeneration: + type: string + enum: + - GENERATION_2 + - GENERATION_1 + ListOrderableInstanceTypesOutput: + type: object + properties: + InstanceTypes: + $ref: "#/components/schemas/DetailedInstanceTypeListDefinition" + description: Information about the instance types that can be ordered for the Outpost. + NextToken: + $ref: "#/components/schemas/Token" + description: The pagination token. + DetailedInstanceTypeListDefinition: + type: array + items: + $ref: "#/components/schemas/DetailedInstanceTypeItem" + DetailedInstanceTypeItem: + description: Information about an instance type that can be ordered for an Outpost, including hardware specifications and supported form factors. + type: object + properties: + InstanceType: + $ref: "#/components/schemas/InstanceType" + description: The instance type. + VCPUs: + $ref: "#/components/schemas/VCPUCount" + description: The number of default VCPUs in the instance type. + MemoryInMib: + $ref: "#/components/schemas/MemoryInMib" + description: The memory size of the instance type, in MiB. + NetworkPerformance: + $ref: "#/components/schemas/NetworkPerformance" + description: The network performance of the instance type. + FormFactorConfigs: + $ref: "#/components/schemas/FormFactorConfigList" + description: The supported form factor and Outpost generation configurations for the instance type. + MemoryInMib: + type: integer + NetworkPerformance: + type: string + FormFactorConfigList: + type: array + items: + $ref: "#/components/schemas/FormFactorConfig" + FormFactorConfig: + description: A supported form factor and Outpost generation configuration for an instance type. + type: object + properties: + FormFactor: + $ref: "#/components/schemas/FormFactor" + description: The form factor. Valid values are RACK for rack-based Outposts and SERVER for server-based Outposts. + OutpostGeneration: + $ref: "#/components/schemas/OutpostGeneration" + description: The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments. This value is not set for server form factors. + FormFactor: + type: string + enum: + - RACK + - SERVER ListOrdersOutput: type: object properties: @@ -2563,6 +3263,68 @@ components: type: array items: $ref: "#/components/schemas/Outpost" + ListQuotesOutput: + type: object + properties: + Quotes: + $ref: "#/components/schemas/QuoteSummaryListDefinition" + description: Information about the quotes. + NextToken: + $ref: "#/components/schemas/Token" + description: The pagination token. + QuoteSummaryListDefinition: + type: array + items: + $ref: "#/components/schemas/QuoteSummary" + QuoteSummary: + description: Summary information about a quote. + type: object + properties: + QuoteId: + $ref: "#/components/schemas/QuoteId" + description: The ID of the quote. + AccountId: + $ref: "#/components/schemas/AccountId" + description: The ID of the account that owns the quote. + QuoteStatus: + $ref: "#/components/schemas/QuoteStatus" + description: The status of the quote. + StatusMessage: + $ref: "#/components/schemas/StatusMessage" + description: A message about the status of the quote. + OutpostArn: + $ref: "#/components/schemas/OutpostArn" + description: The ARN of the Outpost associated with the quote. + CountryCode: + $ref: "#/components/schemas/CountryCode" + description: The country code for the Outpost site location. + RequestedCapacities: + $ref: "#/components/schemas/QuoteCapacityList" + description: The capacity requirements specified in the quote request. + RequestedConstraints: + $ref: "#/components/schemas/QuoteConstraintList" + description: The physical constraints specified in the quote request. + RequestedPaymentOptions: + $ref: "#/components/schemas/PaymentOptionList" + description: The payment options specified in the quote request. + RequestedPaymentTerms: + $ref: "#/components/schemas/PaymentTermList" + description: The payment terms specified in the quote request. + QuoteOptions: + $ref: "#/components/schemas/QuoteOptionList" + description: The configuration and pricing options for the quote. + SubmittedOrderId: + $ref: "#/components/schemas/OrderIdentifier" + description: The ID of the order submitted for the quote. + CreatedDate: + $ref: "#/components/schemas/ISO8601Timestamp" + description: The date the quote was created. + ExpirationDate: + $ref: "#/components/schemas/ISO8601Timestamp" + description: The date the quote expires. + Description: + $ref: "#/components/schemas/QuoteDescription" + description: The description of the quote. CountryCodeList: type: array items: @@ -2712,6 +3474,17 @@ components: properties: Outpost: $ref: "#/components/schemas/Outpost" + OutpostIdentifierOrEmpty: + type: string + minLength: 0 + maxLength: 180 + pattern: ^((arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17})?$ + UpdateQuoteOutput: + type: object + properties: + Quote: + $ref: "#/components/schemas/Quote" + description: Information about the updated quote. UpdateSiteOutput: type: object properties: @@ -2928,6 +3701,103 @@ components: - $ref: "#/components/x-stackQL-resources/orders/methods/create_order" update: [] delete: [] + private_connectivity_configs: + id: aws.outposts.private_connectivity_configs + name: private_connectivity_configs + title: private_connectivity_configs + methods: + create_private_connectivity_config: + operation: + $ref: "#/paths/~1outposts~1{outpost_id}~1privateConnectivity/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_private_connectivity_config: + operation: + $ref: "#/paths/~1outposts~1{outpost_id}~1privateConnectivity/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.PrivateConnectivityConfig + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/private_connectivity_configs/methods/get_private_connectivity_config" + insert: + - $ref: "#/components/x-stackQL-resources/private_connectivity_configs/methods/create_private_connectivity_config" + update: [] + delete: [] + quotes: + id: aws.outposts.quotes + name: quotes + title: quotes + methods: + create_quote: + operation: + $ref: "#/paths/~1quotes/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_quotes: + operation: + $ref: "#/paths/~1quotes/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Quotes + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: query + responseToken: + key: $.NextToken + location: body + delete_quote: + operation: + $ref: "#/paths/~1quotes~1{quote_identifier}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_quote: + operation: + $ref: "#/paths/~1quotes~1{quote_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Quote + update_quote: + operation: + $ref: "#/paths/~1quotes~1{quote_identifier}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/quotes/methods/get_quote" + - $ref: "#/components/x-stackQL-resources/quotes/methods/list_quotes" + insert: + - $ref: "#/components/x-stackQL-resources/quotes/methods/create_quote" + update: + - $ref: "#/components/x-stackQL-resources/quotes/methods/update_quote" + delete: + - $ref: "#/components/x-stackQL-resources/quotes/methods/delete_quote" sites: id: aws.outposts.sites name: sites @@ -3286,6 +4156,34 @@ components: insert: [] update: [] delete: [] + orderable_instance_types: + id: aws.outposts.orderable_instance_types + name: orderable_instance_types + title: orderable_instance_types + methods: + list_orderable_instance_types: + operation: + $ref: "#/paths/~1instanceTypes/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.InstanceTypes + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: query + responseToken: + key: $.NextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/orderable_instance_types/methods/list_orderable_instance_types" + insert: [] + update: [] + delete: [] tags: id: aws.outposts.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/panorama.yaml b/providers/src/aws/v00.00.00000/services/panorama.yaml deleted file mode 100644 index 5c999263..00000000 --- a/providers/src/aws/v00.00.00000/services/panorama.yaml +++ /dev/null @@ -1,3212 +0,0 @@ -openapi: 3.0.0 -info: - version: "2019-07-24" - title: AWS Panorama - description: AWS Panorama - x-serviceName: panorama - x-serviceAlias: panorama - x-protocol: rest-json - x-apiVersion: "2019-07-24" - x-endpointPrefix: panorama - x-jsonVersion: "1.1" -servers: - - url: https://panorama.{region}.amazonaws.com - variables: - region: - default: us-east-1 - description: AWS region - description: Regional endpoint for panorama -paths: - /application-instances: - post: - operationId: CreateApplicationInstance - description: Creates an application instance and deploys it to a device. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ApplicationInstanceIdToReplace: - $ref: "#/components/schemas/ApplicationInstanceId" - DefaultRuntimeContextDevice: - $ref: "#/components/schemas/DefaultRuntimeContextDevice" - Description: - $ref: "#/components/schemas/Description" - ManifestOverridesPayload: - $ref: "#/components/schemas/ManifestOverridesPayload" - ManifestPayload: - $ref: "#/components/schemas/ManifestPayload" - Name: - $ref: "#/components/schemas/ApplicationInstanceName" - RuntimeRoleArn: - $ref: "#/components/schemas/RuntimeRoleArn" - Tags: - $ref: "#/components/schemas/TagMap" - required: - - DefaultRuntimeContextDevice - - ManifestPayload - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateApplicationInstanceResponse" - get: - operationId: ListApplicationInstances - description: Returns a list of application instances. - parameters: - - name: deviceId - in: query - required: false - schema: - $ref: "#/components/schemas/DeviceId" - description: The application instances' device ID. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of application instances to return in one page of results. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - - name: statusFilter - in: query - required: false - schema: - $ref: "#/components/schemas/StatusFilter" - description: Only include instances with a specific status. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListApplicationInstancesResponse" - /jobs: - post: - operationId: CreateJobForDevices - description: Creates a job to run on a device. A job can update a device's software or reboot it. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - DeviceIds: - $ref: "#/components/schemas/DeviceIdList" - DeviceJobConfig: - $ref: "#/components/schemas/DeviceJobConfig" - JobType: - $ref: "#/components/schemas/JobType" - required: - - DeviceIds - - JobType - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateJobForDevicesResponse" - get: - operationId: ListDevicesJobs - description: Returns a list of jobs. - parameters: - - name: DeviceId - in: query - required: false - schema: - $ref: "#/components/schemas/DeviceId" - description: Filter results by the job's target device ID. - - name: MaxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of device jobs to return in one page of results. - - name: NextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListDevicesJobsResponse" - /packages/template-job: - post: - operationId: CreateNodeFromTemplateJob - description: Creates a camera stream node. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - JobTags: - $ref: "#/components/schemas/JobTagsList" - NodeDescription: - $ref: "#/components/schemas/Description" - NodeName: - $ref: "#/components/schemas/NodeName" - OutputPackageName: - $ref: "#/components/schemas/NodePackageName" - OutputPackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - TemplateParameters: - $ref: "#/components/schemas/TemplateParametersMap" - TemplateType: - $ref: "#/components/schemas/TemplateType" - required: - - NodeName - - OutputPackageName - - OutputPackageVersion - - TemplateParameters - - TemplateType - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateNodeFromTemplateJobResponse" - get: - operationId: ListNodeFromTemplateJobs - description: Returns a list of camera stream node jobs. - parameters: - - name: MaxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of node from template jobs to return in one page of results. - - name: NextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListNodeFromTemplateJobsResponse" - /packages: - post: - operationId: CreatePackage - description: Creates a package and storage location in an Amazon S3 access point. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - PackageName: - $ref: "#/components/schemas/NodePackageName" - Tags: - $ref: "#/components/schemas/TagMap" - required: - - PackageName - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePackageResponse" - get: - operationId: ListPackages - description: Returns a list of packages. - parameters: - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of packages to return in one page of results. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/Token" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListPackagesResponse" - /packages/import-jobs: - post: - operationId: CreatePackageImportJob - description: Imports a node package. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ClientToken: - $ref: "#/components/schemas/ClientToken" - InputConfig: - $ref: "#/components/schemas/PackageImportJobInputConfig" - JobTags: - $ref: "#/components/schemas/JobTagsList" - JobType: - $ref: "#/components/schemas/PackageImportJobType" - OutputConfig: - $ref: "#/components/schemas/PackageImportJobOutputConfig" - required: - - ClientToken - - InputConfig - - JobType - - OutputConfig - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePackageImportJobResponse" - get: - operationId: ListPackageImportJobs - description: Returns a list of package import jobs. - parameters: - - name: MaxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of package import jobs to return in one page of results. - - name: NextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListPackageImportJobsResponse" - /devices/{device_id}: - delete: - operationId: DeleteDevice - description: Deletes a device. - parameters: - - name: device_id - in: path - required: true - schema: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDeviceResponse" - get: - operationId: DescribeDevice - description: Returns information about a device. - parameters: - - name: device_id - in: path - required: true - schema: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDeviceResponse" - put: - operationId: UpdateDeviceMetadata - description: Updates a device's metadata. - parameters: - - name: device_id - in: path - required: true - schema: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - Description: - $ref: "#/components/schemas/Description" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDeviceMetadataResponse" - /packages/{package_id}: - delete: - operationId: DeletePackage - description: Deletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API. - parameters: - - name: ForceDelete - in: query - required: false - schema: - $ref: "#/components/schemas/Boolean" - description: Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3. - - name: package_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeletePackageResponse" - /packages/{package_id}/versions/{package_version}/patch/{patch_version}: - delete: - operationId: DeregisterPackageVersion - description: Deregisters a package version. - parameters: - - name: OwnerAccount - in: query - required: false - schema: - $ref: "#/components/schemas/PackageOwnerAccount" - description: An owner account. - - name: package_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageId" - description: A package ID. - - name: package_version - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageVersion" - description: A package version. - - name: patch_version - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: A patch version. - - name: UpdatedLatestPatchVersion - in: query - required: false - schema: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: If the version was marked latest, the new version to maker as latest. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeregisterPackageVersionResponse" - put: - operationId: RegisterPackageVersion - description: Registers a package version. - parameters: - - name: package_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageId" - description: A package ID. - - name: package_version - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageVersion" - description: A package version. - - name: patch_version - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: A patch version. - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - MarkLatest: - $ref: "#/components/schemas/MarkLatestPatch" - OwnerAccount: - $ref: "#/components/schemas/PackageOwnerAccount" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/RegisterPackageVersionResponse" - /application-instances/{application_instance_id}: - get: - operationId: DescribeApplicationInstance - description: Returns information about an application instance on a device. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeApplicationInstanceResponse" - delete: - operationId: RemoveApplicationInstance - description: Removes an application instance. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: An application instance ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/RemoveApplicationInstanceResponse" - /application-instances/{application_instance_id}/details: - get: - operationId: DescribeApplicationInstanceDetails - description: Returns information about an application instance's configuration manifest. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeApplicationInstanceDetailsResponse" - /jobs/{job_id}: - get: - operationId: DescribeDeviceJob - description: Returns information about a device job. - parameters: - - name: job_id - in: path - required: true - schema: - $ref: "#/components/schemas/JobId" - description: The job's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDeviceJobResponse" - /nodes/{node_id}: - get: - operationId: DescribeNode - description: Returns information about a node. - parameters: - - name: node_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodeId" - description: The node's ID. - - name: OwnerAccount - in: query - required: false - schema: - $ref: "#/components/schemas/PackageOwnerAccount" - description: The account ID of the node's owner. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeNodeResponse" - /packages/template-job/{job_id}: - get: - operationId: DescribeNodeFromTemplateJob - description: Returns information about a job to create a camera stream node. - parameters: - - name: job_id - in: path - required: true - schema: - $ref: "#/components/schemas/JobId" - description: The job's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeNodeFromTemplateJobResponse" - /packages/metadata/{package_id}: - get: - operationId: DescribePackage - description: Returns information about a package. - parameters: - - name: package_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePackageResponse" - /packages/import-jobs/{job_id}: - get: - operationId: DescribePackageImportJob - description: Returns information about a package import job. - parameters: - - name: job_id - in: path - required: true - schema: - $ref: "#/components/schemas/JobId" - description: The job's ID. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePackageImportJobResponse" - /packages/metadata/{package_id}/versions/{package_version}: - get: - operationId: DescribePackageVersion - description: Returns information about a package version. - parameters: - - name: OwnerAccount - in: query - required: false - schema: - $ref: "#/components/schemas/PackageOwnerAccount" - description: The version's owner account. - - name: package_id - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageId" - description: The version's ID. - - name: package_version - in: path - required: true - schema: - $ref: "#/components/schemas/NodePackageVersion" - description: The version's version. - - name: PatchVersion - in: query - required: false - schema: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The version's patch version. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePackageVersionResponse" - /application-instances/{application_instance_id}/package-dependencies: - get: - operationId: ListApplicationInstanceDependencies - description: Returns a list of application instance dependencies. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of application instance dependencies to return in one page of results. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListApplicationInstanceDependenciesResponse" - /application-instances/{application_instance_id}/node-instances: - get: - operationId: ListApplicationInstanceNodeInstances - description: Returns a list of application node instances. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The node instances' application instance ID. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of node instances to return in one page of results. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListApplicationInstanceNodeInstancesResponse" - /devices: - get: - operationId: ListDevices - description: Returns a list of devices. - parameters: - - name: DeviceAggregatedStatusFilter - in: query - required: false - schema: - $ref: "#/components/schemas/DeviceAggregatedStatus" - description: Filter based on a device's status. - - name: MaxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of devices to return in one page of results. - - name: NameFilter - in: query - required: false - schema: - $ref: "#/components/schemas/NameFilter" - description: Filter based on device's name. Prefixes supported. - - name: NextToken - in: query - required: false - schema: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token from a previous request to retrieve the next page of results. - - name: SortBy - in: query - required: false - schema: - $ref: "#/components/schemas/ListDevicesSortBy" - description: The target column to be sorted on. Default column sort is CREATED_TIME. - - name: SortOrder - in: query - required: false - schema: - $ref: "#/components/schemas/SortOrder" - description: The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListDevicesResponse" - post: - operationId: ProvisionDevice - description: Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Description: - $ref: "#/components/schemas/Description" - Name: - $ref: "#/components/schemas/DeviceName" - NetworkingConfiguration: - $ref: "#/components/schemas/NetworkPayload" - Tags: - $ref: "#/components/schemas/TagMap" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ProvisionDeviceResponse" - /nodes: - get: - operationId: ListNodes - description: Returns a list of nodes. - parameters: - - name: category - in: query - required: false - schema: - $ref: "#/components/schemas/NodeCategory" - description: Search for nodes by category. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/MaxSize25" - description: The maximum number of nodes to return in one page of results. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/Token" - description: Specify the pagination token from a previous request to retrieve the next page of results. - - name: ownerAccount - in: query - required: false - schema: - $ref: "#/components/schemas/PackageOwnerAccount" - description: Search for nodes by the account ID of the nodes' owner. - - name: packageName - in: query - required: false - schema: - $ref: "#/components/schemas/NodePackageName" - description: Search for nodes by name. - - name: packageVersion - in: query - required: false - schema: - $ref: "#/components/schemas/NodePackageVersion" - description: Search for nodes by version. - - name: patchVersion - in: query - required: false - schema: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: Search for nodes by patch version. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListNodesResponse" - /tags/{resource_arn}: - get: - operationId: ListTagsForResource - description: Returns a list of tags for a resource. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/ResourceArn" - description: The resource's ARN. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListTagsForResourceResponse" - post: - operationId: TagResource - description: Tags a resource. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/ResourceArn" - description: The resource's ARN. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Tags: - $ref: "#/components/schemas/TagMap" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/TagResourceResponse" - delete: - operationId: UntagResource - description: Removes tags from a resource. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/ResourceArn" - description: The resource's ARN. - - name: tagKeys - in: query - required: true - schema: - $ref: "#/components/schemas/TagKeyList" - description: Tag keys to remove. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UntagResourceResponse" - /application-instances/{application_instance_id}/node-signals: - put: - operationId: SignalApplicationInstanceNodeInstances - description: Signal camera nodes to stop or resume. - parameters: - - name: application_instance_id - in: path - required: true - schema: - $ref: "#/components/schemas/ApplicationInstanceId" - description: An application instance ID. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - NodeSignals: - $ref: "#/components/schemas/NodeSignalList" - required: - - NodeSignals - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/SignalApplicationInstanceNodeInstancesResponse" -components: - parameters: - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false - schema: - type: string - X-Amz-Security-Token: - in: header - name: X-Amz-Security-Token - required: false - schema: - type: string - X-Amz-Signature: - in: header - name: X-Amz-Signature - required: false - schema: - type: string - X-Amz-SignedHeaders: - in: header - name: X-Amz-SignedHeaders - required: false - schema: - type: string - schemas: - ApplicationInstanceId: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - DefaultRuntimeContextDevice: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - Description: - type: string - minLength: 0 - maxLength: 255 - pattern: ^.*$ - ManifestOverridesPayload: - description: Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document. - type: object - properties: - PayloadData: - $ref: "#/components/schemas/ManifestOverridesPayloadData" - description: The overrides document. - ManifestOverridesPayloadData: - type: string - minLength: 0 - maxLength: 51200 - pattern: ^.*$ - ManifestPayload: - description: A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source. - type: object - properties: - PayloadData: - $ref: "#/components/schemas/ManifestPayloadData" - description: The application manifest. - ManifestPayloadData: - type: string - minLength: 1 - maxLength: 51200 - pattern: ^.+$ - ApplicationInstanceName: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - RuntimeRoleArn: - type: string - minLength: 1 - maxLength: 255 - pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$ - TagMap: - type: object - properties: {} - CreateApplicationInstanceResponse: - type: object - properties: - ApplicationInstanceId: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - required: - - ApplicationInstanceId - DeviceIdList: - type: array - items: - $ref: "#/components/schemas/DeviceId" - DeviceId: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - DeviceJobConfig: - description: A job's configuration. - type: object - properties: - OTAJobConfig: - $ref: "#/components/schemas/OTAJobConfig" - description: A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs. - OTAJobConfig: - description: An over-the-air update (OTA) job configuration. - type: object - properties: - AllowMajorVersionUpdate: - $ref: "#/components/schemas/Boolean" - description: Whether to apply the update if it is a major version change. - ImageVersion: - $ref: "#/components/schemas/ImageVersion" - description: The target version of the device software. - required: - - ImageVersion - Boolean: - type: boolean - ImageVersion: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - JobType: - type: string - enum: - - OTA - - REBOOT - CreateJobForDevicesResponse: - type: object - properties: - Jobs: - $ref: "#/components/schemas/JobList" - description: A list of jobs. - required: - - Jobs - JobList: - type: array - items: - $ref: "#/components/schemas/Job" - Job: - description: A job for a device. - type: object - properties: - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The target device's ID. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobId: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - JobTagsList: - type: array - items: - $ref: "#/components/schemas/JobResourceTags" - JobResourceTags: - description: Tags for a job. - type: object - properties: - ResourceType: - $ref: "#/components/schemas/JobResourceType" - description: The job's type. - Tags: - type: object - properties: {} - description: The job's tags. - required: - - ResourceType - - Tags - JobResourceType: - type: string - enum: - - PACKAGE - NodeName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9\-\_]+$ - NodePackageName: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9\-\_]+$ - NodePackageVersion: - type: string - minLength: 1 - maxLength: 255 - pattern: ^([0-9]+)\.([0-9]+)$ - TemplateParametersMap: - type: object - properties: {} - TemplateType: - type: string - enum: - - RTSP_CAMERA_STREAM - CreateNodeFromTemplateJobResponse: - type: object - properties: - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - required: - - JobId - CreatePackageResponse: - type: object - properties: - Arn: - $ref: "#/components/schemas/NodePackageArn" - description: The package's ARN. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - StorageLocation: - $ref: "#/components/schemas/StorageLocation" - description: The package's storage location. - required: - - StorageLocation - NodePackageArn: - type: string - minLength: 1 - maxLength: 255 - NodePackageId: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_\/]+$ - StorageLocation: - description: A storage location. - type: object - properties: - BinaryPrefixLocation: - $ref: "#/components/schemas/Object" - description: The location's binary prefix. - Bucket: - $ref: "#/components/schemas/Bucket" - description: The location's bucket. - GeneratedPrefixLocation: - $ref: "#/components/schemas/Object" - description: The location's generated prefix. - ManifestPrefixLocation: - $ref: "#/components/schemas/Object" - description: The location's manifest prefix. - RepoPrefixLocation: - $ref: "#/components/schemas/Object" - description: The location's repo prefix. - required: - - BinaryPrefixLocation - - Bucket - - GeneratedPrefixLocation - - ManifestPrefixLocation - - RepoPrefixLocation - Object: - type: string - Bucket: - type: string - ClientToken: - type: string - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9\-\_]+$ - PackageImportJobInputConfig: - description: A configuration for a package import job. - type: object - properties: - PackageVersionInputConfig: - $ref: "#/components/schemas/PackageVersionInputConfig" - description: The package version's input configuration. - PackageVersionInputConfig: - description: A package version input configuration. - type: object - properties: - S3Location: - $ref: "#/components/schemas/S3Location" - description: A location in Amazon S3. - required: - - S3Location - S3Location: - description: A location in Amazon S3. - type: object - properties: - BucketName: - $ref: "#/components/schemas/BucketName" - description: A bucket name. - ObjectKey: - $ref: "#/components/schemas/ObjectKey" - description: An object key. - Region: - $ref: "#/components/schemas/Region" - description: The bucket's Region. - required: - - BucketName - - ObjectKey - BucketName: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - ObjectKey: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - Region: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - PackageImportJobType: - type: string - enum: - - NODE_PACKAGE_VERSION - - MARKETPLACE_NODE_PACKAGE_VERSION - PackageImportJobOutputConfig: - description: An output configuration for a package import job. - type: object - properties: - PackageVersionOutputConfig: - $ref: "#/components/schemas/PackageVersionOutputConfig" - description: The package version's output configuration. - PackageVersionOutputConfig: - description: A package version output configuration. - type: object - properties: - MarkLatest: - $ref: "#/components/schemas/MarkLatestPatch" - description: Indicates that the version is recommended for all users. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The output's package name. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The output's package version. - required: - - PackageName - - PackageVersion - MarkLatestPatch: - type: boolean - CreatePackageImportJobResponse: - type: object - properties: - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - required: - - JobId - DeleteDeviceResponse: - type: object - properties: - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - DeletePackageResponse: - type: object - PackageOwnerAccount: - type: string - minLength: 1 - maxLength: 12 - pattern: ^[0-9a-z\_]+$ - NodePackagePatchVersion: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-z0-9]+$ - DeregisterPackageVersionResponse: - type: object - DescribeApplicationInstanceResponse: - type: object - properties: - ApplicationInstanceId: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - ApplicationInstanceIdToReplace: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The ID of the application instance that this instance replaced. - Arn: - $ref: "#/components/schemas/ApplicationInstanceArn" - description: The application instance's ARN. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the application instance was created. - DefaultRuntimeContextDevice: - $ref: "#/components/schemas/DefaultRuntimeContextDevice" - description: The device's ID. - DefaultRuntimeContextDeviceName: - $ref: "#/components/schemas/DeviceName" - description: The device's bane. - Description: - $ref: "#/components/schemas/Description" - description: The application instance's description. - HealthStatus: - $ref: "#/components/schemas/ApplicationInstanceHealthStatus" - description: The application instance's health status. - LastUpdatedTime: - $ref: "#/components/schemas/TimeStamp" - description: The application instance was updated. - Name: - $ref: "#/components/schemas/ApplicationInstanceName" - description: The application instance's name. - RuntimeContextStates: - $ref: "#/components/schemas/ReportedRuntimeContextStates" - description: The application instance's state. - RuntimeRoleArn: - $ref: "#/components/schemas/RuntimeRoleArn" - description: The application instance's runtime role ARN. - Status: - $ref: "#/components/schemas/ApplicationInstanceStatus" - description: The application instance's status. - StatusDescription: - $ref: "#/components/schemas/ApplicationInstanceStatusDescription" - description: The application instance's status description. - Tags: - type: object - properties: {} - description: The application instance's tags. - ApplicationInstanceArn: - type: string - minLength: 1 - maxLength: 255 - TimeStamp: - type: string - format: date-time - DeviceName: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - ApplicationInstanceHealthStatus: - type: string - enum: - - RUNNING - - ERROR - - NOT_AVAILABLE - ReportedRuntimeContextStates: - type: array - items: - $ref: "#/components/schemas/ReportedRuntimeContextState" - ReportedRuntimeContextState: - description: An application instance's state. - type: object - properties: - DesiredState: - $ref: "#/components/schemas/DesiredState" - description: The application's desired state. - DeviceReportedStatus: - $ref: "#/components/schemas/DeviceReportedStatus" - description: The application's reported status. - DeviceReportedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the device reported the application's state. - RuntimeContextName: - $ref: "#/components/schemas/RuntimeContextName" - description: The device's name. - required: - - DesiredState - - DeviceReportedStatus - - DeviceReportedTime - - RuntimeContextName - DesiredState: - type: string - enum: - - RUNNING - - STOPPED - - REMOVED - DeviceReportedStatus: - type: string - enum: - - STOPPING - - STOPPED - - STOP_ERROR - - REMOVAL_FAILED - - REMOVAL_IN_PROGRESS - - STARTING - - RUNNING - - INSTALL_ERROR - - LAUNCHED - - LAUNCH_ERROR - - INSTALL_IN_PROGRESS - RuntimeContextName: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - ApplicationInstanceStatus: - type: string - enum: - - DEPLOYMENT_PENDING - - DEPLOYMENT_REQUESTED - - DEPLOYMENT_IN_PROGRESS - - DEPLOYMENT_ERROR - - DEPLOYMENT_SUCCEEDED - - REMOVAL_PENDING - - REMOVAL_REQUESTED - - REMOVAL_IN_PROGRESS - - REMOVAL_FAILED - - REMOVAL_SUCCEEDED - - DEPLOYMENT_FAILED - ApplicationInstanceStatusDescription: - type: string - minLength: 1 - maxLength: 255 - DescribeApplicationInstanceDetailsResponse: - type: object - properties: - ApplicationInstanceId: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - ApplicationInstanceIdToReplace: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The ID of the application instance that this instance replaced. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the application instance was created. - DefaultRuntimeContextDevice: - $ref: "#/components/schemas/DefaultRuntimeContextDevice" - description: The application instance's default runtime context device. - Description: - $ref: "#/components/schemas/Description" - description: The application instance's description. - ManifestOverridesPayload: - $ref: "#/components/schemas/ManifestOverridesPayload" - description: Parameter overrides for the configuration manifest. - ManifestPayload: - $ref: "#/components/schemas/ManifestPayload" - description: The application instance's configuration manifest. - Name: - $ref: "#/components/schemas/ApplicationInstanceName" - description: The application instance's name. - DescribeDeviceResponse: - type: object - properties: - AlternateSoftwares: - $ref: "#/components/schemas/AlternateSoftwares" - description: Beta software releases available for the device. - Arn: - $ref: "#/components/schemas/DeviceArn" - description: The device's ARN. - Brand: - $ref: "#/components/schemas/DeviceBrand" - description: The device's maker. - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the device was created. - CurrentNetworkingStatus: - $ref: "#/components/schemas/NetworkStatus" - description: The device's networking status. - CurrentSoftware: - $ref: "#/components/schemas/CurrentSoftware" - description: The device's current software version. - Description: - $ref: "#/components/schemas/Description" - description: The device's description. - DeviceAggregatedStatus: - $ref: "#/components/schemas/DeviceAggregatedStatus" - description: A device's aggregated status. Including the device's connection status, provisioning status, and lease status. - DeviceConnectionStatus: - $ref: "#/components/schemas/DeviceConnectionStatus" - description: The device's connection status. - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - LatestAlternateSoftware: - $ref: "#/components/schemas/LatestAlternateSoftware" - description: The most recent beta software release. - LatestDeviceJob: - $ref: "#/components/schemas/LatestDeviceJob" - description: A device's latest job. Includes the target image version, and the job status. - LatestSoftware: - $ref: "#/components/schemas/LatestSoftware" - description: The latest software version available for the device. - LeaseExpirationTime: - $ref: "#/components/schemas/LeaseExpirationTime" - description: The device's lease expiration time. - Name: - $ref: "#/components/schemas/DeviceName" - description: The device's name. - NetworkingConfiguration: - $ref: "#/components/schemas/NetworkPayload" - description: The device's networking configuration. - ProvisioningStatus: - $ref: "#/components/schemas/DeviceStatus" - description: The device's provisioning status. - SerialNumber: - $ref: "#/components/schemas/DeviceSerialNumber" - description: The device's serial number. - Tags: - type: object - properties: {} - description: The device's tags. - Type: - $ref: "#/components/schemas/DeviceType" - description: The device's type. - AlternateSoftwares: - type: array - items: - $ref: "#/components/schemas/AlternateSoftwareMetadata" - AlternateSoftwareMetadata: - description: Details about a beta appliance software update. - type: object - properties: - Version: - $ref: "#/components/schemas/Version" - description: The appliance software version. - Version: - type: string - minLength: 1 - maxLength: 255 - DeviceArn: - type: string - minLength: 1 - maxLength: 255 - DeviceBrand: - type: string - enum: - - AWS_PANORAMA - - LENOVO - CreatedTime: - type: string - format: date-time - NetworkStatus: - description: The network status of a device. - type: object - properties: - Ethernet0Status: - $ref: "#/components/schemas/EthernetStatus" - description: The status of Ethernet port 0. - Ethernet1Status: - $ref: "#/components/schemas/EthernetStatus" - description: The status of Ethernet port 1. - LastUpdatedTime: - $ref: "#/components/schemas/LastUpdatedTime" - description: When the network status changed. - NtpStatus: - $ref: "#/components/schemas/NtpStatus" - description: Details about a network time protocol (NTP) server connection. - EthernetStatus: - description: A device's Ethernet status. - type: object - properties: - ConnectionStatus: - $ref: "#/components/schemas/NetworkConnectionStatus" - description: The device's connection status. - HwAddress: - $ref: "#/components/schemas/HwAddress" - description: The device's physical address. - IpAddress: - $ref: "#/components/schemas/IpAddress" - description: The device's IP address. - NetworkConnectionStatus: - type: string - enum: - - CONNECTED - - NOT_CONNECTED - - CONNECTING - HwAddress: - type: string - minLength: 1 - maxLength: 255 - IpAddress: - type: string - minLength: 1 - maxLength: 255 - pattern: ^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$ - LastUpdatedTime: - type: string - format: date-time - NtpStatus: - description: Details about an NTP server connection. - type: object - properties: - ConnectionStatus: - $ref: "#/components/schemas/NetworkConnectionStatus" - description: The connection's status. - IpAddress: - $ref: "#/components/schemas/IpAddress" - description: The IP address of the server. - NtpServerName: - $ref: "#/components/schemas/NtpServerName" - description: The domain name of the server. - NtpServerName: - type: string - minLength: 1 - maxLength: 255 - CurrentSoftware: - type: string - minLength: 1 - maxLength: 255 - DeviceAggregatedStatus: - type: string - enum: - - ERROR - - AWAITING_PROVISIONING - - PENDING - - FAILED - - DELETING - - ONLINE - - OFFLINE - - LEASE_EXPIRED - - UPDATE_NEEDED - - REBOOTING - DeviceConnectionStatus: - type: string - enum: - - ONLINE - - OFFLINE - - AWAITING_CREDENTIALS - - NOT_AVAILABLE - - ERROR - LatestAlternateSoftware: - type: string - minLength: 1 - maxLength: 255 - LatestDeviceJob: - description: Returns information about the latest device job. - type: object - properties: - ImageVersion: - $ref: "#/components/schemas/ImageVersion" - description: The target version of the device software. - JobType: - $ref: "#/components/schemas/JobType" - description: The job's type. - Status: - $ref: "#/components/schemas/UpdateProgress" - description: Status of the latest device job. - UpdateProgress: - type: string - enum: - - PENDING - - IN_PROGRESS - - VERIFYING - - REBOOTING - - DOWNLOADING - - COMPLETED - - FAILED - LatestSoftware: - type: string - minLength: 1 - maxLength: 255 - LeaseExpirationTime: - type: string - format: date-time - NetworkPayload: - description: The network configuration for a device. - type: object - properties: - Ethernet0: - $ref: "#/components/schemas/EthernetPayload" - description: Settings for Ethernet port 0. - Ethernet1: - $ref: "#/components/schemas/EthernetPayload" - description: Settings for Ethernet port 1. - Ntp: - $ref: "#/components/schemas/NtpPayload" - description: Network time protocol (NTP) server settings. - EthernetPayload: - description: A device's network configuration. - type: object - properties: - ConnectionType: - $ref: "#/components/schemas/ConnectionType" - description: How the device gets an IP address. - StaticIpConnectionInfo: - $ref: "#/components/schemas/StaticIpConnectionInfo" - description: Network configuration for a static IP connection. - required: - - ConnectionType - ConnectionType: - type: string - enum: - - STATIC_IP - - DHCP - StaticIpConnectionInfo: - description: A static IP configuration. - type: object - properties: - DefaultGateway: - $ref: "#/components/schemas/DefaultGateway" - description: The connection's default gateway. - Dns: - $ref: "#/components/schemas/DnsList" - description: The connection's DNS address. - IpAddress: - $ref: "#/components/schemas/IpAddress" - description: The connection's IP address. - Mask: - $ref: "#/components/schemas/Mask" - description: The connection's DNS mask. - required: - - DefaultGateway - - Dns - - IpAddress - - Mask - DefaultGateway: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - DnsList: - type: array - items: - $ref: "#/components/schemas/Dns" - Dns: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - Mask: - type: string - minLength: 1 - maxLength: 255 - pattern: ^.+$ - NtpPayload: - description: Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of pool.ntp.org. - type: object - properties: - NtpServers: - $ref: "#/components/schemas/NtpServerList" - description: NTP servers to use, in order of preference. - required: - - NtpServers - NtpServerList: - type: array - items: - $ref: "#/components/schemas/IpAddressOrServerName" - IpAddressOrServerName: - type: string - minLength: 1 - maxLength: 255 - pattern: (^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$)|(^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$) - DeviceStatus: - type: string - enum: - - AWAITING_PROVISIONING - - PENDING - - SUCCEEDED - - FAILED - - ERROR - - DELETING - DeviceSerialNumber: - type: string - pattern: ^[0-9]{1,20}$ - DeviceType: - type: string - enum: - - PANORAMA_APPLIANCE_DEVELOPER_KIT - - PANORAMA_APPLIANCE - DescribeDeviceJobResponse: - type: object - properties: - CreatedTime: - $ref: "#/components/schemas/UpdateCreatedTime" - description: When the job was created. - DeviceArn: - $ref: "#/components/schemas/DeviceArn" - description: The device's ARN. - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - DeviceName: - $ref: "#/components/schemas/DeviceName" - description: The device's name. - DeviceType: - $ref: "#/components/schemas/DeviceType" - description: The device's type. - ImageVersion: - $ref: "#/components/schemas/ImageVersion" - description: For an OTA job, the target version of the device software. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobType: - $ref: "#/components/schemas/JobType" - description: The job's type. - Status: - $ref: "#/components/schemas/UpdateProgress" - description: The job's status. - UpdateCreatedTime: - type: string - format: date-time - NodeId: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_\.]+$ - DescribeNodeResponse: - type: object - properties: - AssetName: - $ref: "#/components/schemas/NodeAssetName" - description: The node's asset name. - Category: - $ref: "#/components/schemas/NodeCategory" - description: The node's category. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the node was created. - Description: - $ref: "#/components/schemas/Description" - description: The node's description. - LastUpdatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the node was updated. - Name: - $ref: "#/components/schemas/NodeName" - description: The node's name. - NodeId: - $ref: "#/components/schemas/NodeId" - description: The node's ID. - NodeInterface: - $ref: "#/components/schemas/NodeInterface" - description: The node's interface. - OwnerAccount: - $ref: "#/components/schemas/PackageOwnerAccount" - description: The account ID of the node's owner. - PackageArn: - $ref: "#/components/schemas/NodePackageArn" - description: The node's ARN. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The node's package ID. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The node's package name. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The node's package version. - PatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The node's patch version. - required: - - Category - - CreatedTime - - Description - - LastUpdatedTime - - Name - - NodeId - - NodeInterface - - OwnerAccount - - PackageId - - PackageName - - PackageVersion - - PatchVersion - NodeAssetName: - type: string - minLength: 1 - maxLength: 255 - pattern: ^[a-zA-Z0-9\-\_]+$ - NodeCategory: - type: string - enum: - - BUSINESS_LOGIC - - ML_MODEL - - MEDIA_SOURCE - - MEDIA_SINK - NodeInterface: - description: A node interface. - type: object - properties: - Inputs: - $ref: "#/components/schemas/InputPortList" - description: The node interface's inputs. - Outputs: - $ref: "#/components/schemas/OutputPortList" - description: The node interface's outputs. - required: - - Inputs - - Outputs - InputPortList: - type: array - items: - $ref: "#/components/schemas/NodeInputPort" - NodeInputPort: - description: A node input port. - type: object - properties: - DefaultValue: - $ref: "#/components/schemas/PortDefaultValue" - description: The input port's default value. - Description: - $ref: "#/components/schemas/Description" - description: The input port's description. - MaxConnections: - $ref: "#/components/schemas/MaxConnections" - description: The input port's max connections. - Name: - $ref: "#/components/schemas/PortName" - description: The input port's name. - Type: - $ref: "#/components/schemas/PortType" - description: The input port's type. - PortDefaultValue: - type: string - minLength: 1 - maxLength: 255 - MaxConnections: - type: integer - PortName: - type: string - minLength: 1 - maxLength: 50 - pattern: ^[a-zA-Z0-9\_]+$ - PortType: - type: string - enum: - - BOOLEAN - - STRING - - INT32 - - FLOAT32 - - MEDIA - OutputPortList: - type: array - items: - $ref: "#/components/schemas/NodeOutputPort" - NodeOutputPort: - description: A node output port. - type: object - properties: - Description: - $ref: "#/components/schemas/Description" - description: The output port's description. - Name: - $ref: "#/components/schemas/PortName" - description: The output port's name. - Type: - $ref: "#/components/schemas/PortType" - description: The output port's type. - DescribeNodeFromTemplateJobResponse: - type: object - properties: - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the job was created. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobTags: - $ref: "#/components/schemas/JobTagsList" - description: The job's tags. - LastUpdatedTime: - $ref: "#/components/schemas/LastUpdatedTime" - description: When the job was updated. - NodeDescription: - $ref: "#/components/schemas/Description" - description: The node's description. - NodeName: - $ref: "#/components/schemas/NodeName" - description: The node's name. - OutputPackageName: - $ref: "#/components/schemas/NodePackageName" - description: The job's output package name. - OutputPackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The job's output package version. - Status: - $ref: "#/components/schemas/NodeFromTemplateJobStatus" - description: The job's status. - StatusMessage: - $ref: "#/components/schemas/NodeFromTemplateJobStatusMessage" - description: The job's status message. - TemplateParameters: - type: object - properties: {} - description: The job's template parameters. - TemplateType: - $ref: "#/components/schemas/TemplateType" - description: The job's template type. - required: - - CreatedTime - - JobId - - LastUpdatedTime - - NodeName - - OutputPackageName - - OutputPackageVersion - - Status - - StatusMessage - - TemplateParameters - - TemplateType - NodeFromTemplateJobStatus: - type: string - enum: - - PENDING - - SUCCEEDED - - FAILED - NodeFromTemplateJobStatusMessage: - type: string - DescribePackageResponse: - type: object - properties: - Arn: - $ref: "#/components/schemas/NodePackageArn" - description: The package's ARN. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the package was created. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The package's name. - ReadAccessPrincipalArns: - $ref: "#/components/schemas/PrincipalArnsList" - description: ARNs of accounts that have read access to the package. - StorageLocation: - $ref: "#/components/schemas/StorageLocation" - description: The package's storage location. - Tags: - type: object - properties: {} - description: The package's tags. - WriteAccessPrincipalArns: - $ref: "#/components/schemas/PrincipalArnsList" - description: ARNs of accounts that have write access to the package. - required: - - Arn - - CreatedTime - - PackageId - - PackageName - - StorageLocation - - Tags - PrincipalArnsList: - type: array - items: - $ref: "#/components/schemas/PrincipalArn" - PrincipalArn: - type: string - minLength: 1 - maxLength: 255 - pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\-_/]+$ - DescribePackageImportJobResponse: - type: object - properties: - ClientToken: - $ref: "#/components/schemas/ClientToken" - description: The job's client token. - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the job was created. - InputConfig: - $ref: "#/components/schemas/PackageImportJobInputConfig" - description: The job's input config. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobTags: - $ref: "#/components/schemas/JobTagsList" - description: The job's tags. - JobType: - $ref: "#/components/schemas/PackageImportJobType" - description: The job's type. - LastUpdatedTime: - $ref: "#/components/schemas/LastUpdatedTime" - description: When the job was updated. - Output: - $ref: "#/components/schemas/PackageImportJobOutput" - description: The job's output. - OutputConfig: - $ref: "#/components/schemas/PackageImportJobOutputConfig" - description: The job's output config. - Status: - $ref: "#/components/schemas/PackageImportJobStatus" - description: The job's status. - StatusMessage: - $ref: "#/components/schemas/PackageImportJobStatusMessage" - description: The job's status message. - required: - - CreatedTime - - InputConfig - - JobId - - JobType - - LastUpdatedTime - - Output - - OutputConfig - - Status - - StatusMessage - PackageImportJobOutput: - description: Results of a package import job. - type: object - properties: - OutputS3Location: - $ref: "#/components/schemas/OutPutS3Location" - description: The package's output location. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The package's version. - PatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The package's patch version. - required: - - OutputS3Location - - PackageId - - PackageVersion - - PatchVersion - OutPutS3Location: - description: The location of an output object in Amazon S3. - type: object - properties: - BucketName: - $ref: "#/components/schemas/BucketName" - description: The object's bucket. - ObjectKey: - $ref: "#/components/schemas/ObjectKey" - description: The object's key. - required: - - BucketName - - ObjectKey - PackageImportJobStatus: - type: string - enum: - - PENDING - - SUCCEEDED - - FAILED - PackageImportJobStatusMessage: - type: string - DescribePackageVersionResponse: - type: object - properties: - IsLatestPatch: - $ref: "#/components/schemas/Boolean" - description: Whether the version is the latest available. - OwnerAccount: - $ref: "#/components/schemas/PackageOwnerAccount" - description: The account ID of the version's owner. - PackageArn: - $ref: "#/components/schemas/NodePackageArn" - description: The ARN of the package. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The version's ID. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The version's name. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The version's version. - PatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The version's patch version. - RegisteredTime: - $ref: "#/components/schemas/TimeStamp" - description: The version's registered time. - Status: - $ref: "#/components/schemas/PackageVersionStatus" - description: The version's status. - StatusDescription: - $ref: "#/components/schemas/PackageVersionStatusDescription" - description: The version's status description. - required: - - IsLatestPatch - - PackageId - - PackageName - - PackageVersion - - PatchVersion - - Status - PackageVersionStatus: - type: string - enum: - - REGISTER_PENDING - - REGISTER_COMPLETED - - FAILED - - DELETING - PackageVersionStatusDescription: - type: string - minLength: 1 - maxLength: 255 - MaxSize25: - type: integer - minimum: 0 - maximum: 25 - NextToken: - type: string - minLength: 1 - maxLength: 4096 - pattern: ^.+$ - ListApplicationInstanceDependenciesResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - PackageObjects: - $ref: "#/components/schemas/PackageObjects" - description: A list of package objects. - PackageObjects: - type: array - items: - $ref: "#/components/schemas/PackageObject" - PackageObject: - description: A package object. - type: object - properties: - Name: - $ref: "#/components/schemas/NodePackageName" - description: The object's name. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The object's package version. - PatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The object's patch version. - required: - - Name - - PackageVersion - - PatchVersion - ListApplicationInstanceNodeInstancesResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - NodeInstances: - $ref: "#/components/schemas/NodeInstances" - description: A list of node instances. - NodeInstances: - type: array - items: - $ref: "#/components/schemas/NodeInstance" - NodeInstance: - description: A node instance. - type: object - properties: - CurrentStatus: - $ref: "#/components/schemas/NodeInstanceStatus" - description: The instance's current status. - NodeId: - $ref: "#/components/schemas/NodeId" - description: The node's ID. - NodeInstanceId: - $ref: "#/components/schemas/NodeInstanceId" - description: The instance's ID. - NodeName: - $ref: "#/components/schemas/NodeName" - description: The instance's name. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The instance's package name. - PackagePatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The instance's package patch version. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The instance's package version. - required: - - CurrentStatus - - NodeInstanceId - NodeInstanceStatus: - type: string - enum: - - RUNNING - - ERROR - - NOT_AVAILABLE - - PAUSED - NodeInstanceId: - type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9\-\_]+$ - StatusFilter: - type: string - enum: - - DEPLOYMENT_SUCCEEDED - - DEPLOYMENT_ERROR - - REMOVAL_SUCCEEDED - - REMOVAL_FAILED - - PROCESSING_DEPLOYMENT - - PROCESSING_REMOVAL - - DEPLOYMENT_FAILED - ListApplicationInstancesResponse: - type: object - properties: - ApplicationInstances: - $ref: "#/components/schemas/ApplicationInstances" - description: A list of application instances. - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - ApplicationInstances: - type: array - items: - $ref: "#/components/schemas/ApplicationInstance" - ApplicationInstance: - description: An application instance on a device. - type: object - properties: - ApplicationInstanceId: - $ref: "#/components/schemas/ApplicationInstanceId" - description: The application instance's ID. - Arn: - $ref: "#/components/schemas/ApplicationInstanceArn" - description: The application instance's ARN. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the application instance was created. - DefaultRuntimeContextDevice: - $ref: "#/components/schemas/DefaultRuntimeContextDevice" - description: The device's ID. - DefaultRuntimeContextDeviceName: - $ref: "#/components/schemas/DeviceName" - description: The device's name. - Description: - $ref: "#/components/schemas/Description" - description: The application instance's description. - HealthStatus: - $ref: "#/components/schemas/ApplicationInstanceHealthStatus" - description: The application instance's health status. - Name: - $ref: "#/components/schemas/ApplicationInstanceName" - description: The application instance's name. - RuntimeContextStates: - $ref: "#/components/schemas/ReportedRuntimeContextStates" - description: The application's state. - Status: - $ref: "#/components/schemas/ApplicationInstanceStatus" - description: The application instance's status. - StatusDescription: - $ref: "#/components/schemas/ApplicationInstanceStatusDescription" - description: The application instance's status description. - Tags: - type: object - properties: {} - description: The application instance's tags. - NameFilter: - type: string - ListDevicesSortBy: - type: string - enum: - - DEVICE_ID - - CREATED_TIME - - NAME - - DEVICE_AGGREGATED_STATUS - SortOrder: - type: string - enum: - - ASCENDING - - DESCENDING - ListDevicesResponse: - type: object - properties: - Devices: - $ref: "#/components/schemas/DeviceList" - description: A list of devices. - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - required: - - Devices - DeviceList: - type: array - items: - $ref: "#/components/schemas/Device" - Device: - description: A device. - type: object - properties: - Brand: - $ref: "#/components/schemas/DeviceBrand" - description: The device's maker. - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the device was created. - CurrentSoftware: - $ref: "#/components/schemas/CurrentSoftware" - description: A device's current software. - Description: - $ref: "#/components/schemas/Description" - description: A description for the device. - DeviceAggregatedStatus: - $ref: "#/components/schemas/DeviceAggregatedStatus" - description: A device's aggregated status. Including the device's connection status, provisioning status, and lease status. - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - LastUpdatedTime: - $ref: "#/components/schemas/LastUpdatedTime" - description: When the device was updated. - LatestDeviceJob: - $ref: "#/components/schemas/LatestDeviceJob" - description: A device's latest job. Includes the target image version, and the update job status. - LeaseExpirationTime: - $ref: "#/components/schemas/LeaseExpirationTime" - description: The device's lease expiration time. - Name: - $ref: "#/components/schemas/DeviceName" - description: The device's name. - ProvisioningStatus: - $ref: "#/components/schemas/DeviceStatus" - description: The device's provisioning status. - Tags: - type: object - properties: {} - description: The device's tags. - Type: - $ref: "#/components/schemas/DeviceType" - description: The device's type. - ListDevicesJobsResponse: - type: object - properties: - DeviceJobs: - $ref: "#/components/schemas/DeviceJobList" - description: A list of jobs. - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - DeviceJobList: - type: array - items: - $ref: "#/components/schemas/DeviceJob" - DeviceJob: - description: A job that runs on a device. - type: object - properties: - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the job was created. - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The ID of the target device. - DeviceName: - $ref: "#/components/schemas/DeviceName" - description: The name of the target device - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobType: - $ref: "#/components/schemas/JobType" - description: The job's type. - ListNodeFromTemplateJobsResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - NodeFromTemplateJobs: - $ref: "#/components/schemas/NodeFromTemplateJobList" - description: A list of jobs. - required: - - NodeFromTemplateJobs - NodeFromTemplateJobList: - type: array - items: - $ref: "#/components/schemas/NodeFromTemplateJob" - NodeFromTemplateJob: - description: A job to create a camera stream node. - type: object - properties: - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the job was created. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - NodeName: - $ref: "#/components/schemas/NodeName" - description: The node's name. - Status: - $ref: "#/components/schemas/NodeFromTemplateJobStatus" - description: The job's status. - StatusMessage: - $ref: "#/components/schemas/NodeFromTemplateJobStatusMessage" - description: The job's status message. - TemplateType: - $ref: "#/components/schemas/TemplateType" - description: The job's template type. - Token: - type: string - minLength: 1 - maxLength: 4096 - pattern: ^.+$ - ListNodesResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/Token" - description: A pagination token that's included if more results are available. - Nodes: - $ref: "#/components/schemas/NodesList" - description: A list of nodes. - NodesList: - type: array - items: - $ref: "#/components/schemas/Node" - Node: - description: An application node that represents a camera stream, a model, code, or output. - type: object - properties: - Category: - $ref: "#/components/schemas/NodeCategory" - description: The node's category. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the node was created. - Description: - $ref: "#/components/schemas/Description" - description: The node's description. - Name: - $ref: "#/components/schemas/NodeName" - description: The node's name. - NodeId: - $ref: "#/components/schemas/NodeId" - description: The node's ID. - OwnerAccount: - $ref: "#/components/schemas/PackageOwnerAccount" - description: The account ID of the node's owner. - PackageArn: - $ref: "#/components/schemas/NodePackageArn" - description: The node's ARN. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The node's package ID. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The node's package name. - PackageVersion: - $ref: "#/components/schemas/NodePackageVersion" - description: The node's package version. - PatchVersion: - $ref: "#/components/schemas/NodePackagePatchVersion" - description: The node's patch version. - required: - - Category - - CreatedTime - - Name - - NodeId - - PackageId - - PackageName - - PackageVersion - - PatchVersion - ListPackageImportJobsResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - PackageImportJobs: - $ref: "#/components/schemas/PackageImportJobList" - description: A list of package import jobs. - required: - - PackageImportJobs - PackageImportJobList: - type: array - items: - $ref: "#/components/schemas/PackageImportJob" - PackageImportJob: - description: A job to import a package version. - type: object - properties: - CreatedTime: - $ref: "#/components/schemas/CreatedTime" - description: When the job was created. - JobId: - $ref: "#/components/schemas/JobId" - description: The job's ID. - JobType: - $ref: "#/components/schemas/PackageImportJobType" - description: The job's type. - LastUpdatedTime: - $ref: "#/components/schemas/LastUpdatedTime" - description: When the job was updated. - Status: - $ref: "#/components/schemas/PackageImportJobStatus" - description: The job's status. - StatusMessage: - $ref: "#/components/schemas/PackageImportJobStatusMessage" - description: The job's status message. - ListPackagesResponse: - type: object - properties: - NextToken: - $ref: "#/components/schemas/NextToken" - description: A pagination token that's included if more results are available. - Packages: - $ref: "#/components/schemas/PackageList" - description: A list of packages. - PackageList: - type: array - items: - $ref: "#/components/schemas/PackageListItem" - PackageListItem: - description: A package summary. - type: object - properties: - Arn: - $ref: "#/components/schemas/NodePackageArn" - description: The package's ARN. - CreatedTime: - $ref: "#/components/schemas/TimeStamp" - description: When the package was created. - PackageId: - $ref: "#/components/schemas/NodePackageId" - description: The package's ID. - PackageName: - $ref: "#/components/schemas/NodePackageName" - description: The package's name. - Tags: - type: object - properties: {} - description: The package's tags. - ResourceArn: - type: string - minLength: 1 - maxLength: 2048 - pattern: ^.+$ - ListTagsForResourceResponse: - type: object - properties: - Tags: - type: object - properties: {} - description: A list of tags. - ProvisionDeviceResponse: - type: object - properties: - Arn: - $ref: "#/components/schemas/DeviceArn" - description: The device's ARN. - Certificates: - $ref: "#/components/schemas/Certificates" - description: The device's configuration bundle. - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - IotThingName: - $ref: "#/components/schemas/IotThingName" - description: The device's IoT thing name. - Status: - $ref: "#/components/schemas/DeviceStatus" - description: The device's status. - required: - - Arn - - Status - Certificates: - type: string - format: byte - IotThingName: - type: string - minLength: 1 - maxLength: 255 - RegisterPackageVersionResponse: - type: object - RemoveApplicationInstanceResponse: - type: object - NodeSignalList: - type: array - items: - $ref: "#/components/schemas/NodeSignal" - NodeSignal: - description: A signal to a camera node to start or stop processing video. - type: object - properties: - NodeInstanceId: - $ref: "#/components/schemas/NodeInstanceId" - description: The camera node's name, from the application manifest. - Signal: - $ref: "#/components/schemas/NodeSignalValue" - description: The signal value. - required: - - NodeInstanceId - - Signal - NodeSignalValue: - type: string - enum: - - PAUSE - - RESUME - SignalApplicationInstanceNodeInstancesResponse: - type: object - properties: - ApplicationInstanceId: - $ref: "#/components/schemas/ApplicationInstanceId" - description: An application instance ID. - required: - - ApplicationInstanceId - TagResourceResponse: - type: object - TagKeyList: - type: array - items: - $ref: "#/components/schemas/TagKey" - TagKey: - type: string - minLength: 1 - maxLength: 128 - pattern: ^.+$ - UntagResourceResponse: - type: object - UpdateDeviceMetadataResponse: - type: object - properties: - DeviceId: - $ref: "#/components/schemas/DeviceId" - description: The device's ID. - x-stackQL-resources: - application_instances: - id: aws.panorama.application_instances - name: application_instances - title: application_instances - methods: - create_application_instance: - operation: - $ref: "#/paths/~1application-instances/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_application_instances: - operation: - $ref: "#/paths/~1application-instances/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_application_instance: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - remove_application_instance: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/application_instances/methods/describe_application_instance" - - $ref: "#/components/x-stackQL-resources/application_instances/methods/list_application_instances" - insert: - - $ref: "#/components/x-stackQL-resources/application_instances/methods/create_application_instance" - update: - - $ref: "#/components/x-stackQL-resources/application_instances/methods/remove_application_instance" - delete: [] - devices: - id: aws.panorama.devices - name: devices - title: devices - methods: - create_job_for_devices: - operation: - $ref: "#/paths/~1jobs/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - delete_device: - operation: - $ref: "#/paths/~1devices~1{device_id}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - describe_device: - operation: - $ref: "#/paths/~1devices~1{device_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - update_device_metadata: - operation: - $ref: "#/paths/~1devices~1{device_id}/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_devices: - operation: - $ref: "#/paths/~1devices/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - provision_device: - operation: - $ref: "#/paths/~1devices/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/devices/methods/describe_device" - - $ref: "#/components/x-stackQL-resources/devices/methods/list_devices" - insert: - - $ref: "#/components/x-stackQL-resources/devices/methods/create_job_for_devices" - update: - - $ref: "#/components/x-stackQL-resources/devices/methods/update_device_metadata" - - $ref: "#/components/x-stackQL-resources/devices/methods/provision_device" - delete: - - $ref: "#/components/x-stackQL-resources/devices/methods/delete_device" - devices_jobs: - id: aws.panorama.devices_jobs - name: devices_jobs - title: devices_jobs - methods: - list_devices_jobs: - operation: - $ref: "#/paths/~1jobs/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/devices_jobs/methods/list_devices_jobs" - insert: [] - update: [] - delete: [] - node_from_template_jobs: - id: aws.panorama.node_from_template_jobs - name: node_from_template_jobs - title: node_from_template_jobs - methods: - create_node_from_template_job: - operation: - $ref: "#/paths/~1packages~1template-job/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_node_from_template_jobs: - operation: - $ref: "#/paths/~1packages~1template-job/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_node_from_template_job: - operation: - $ref: "#/paths/~1packages~1template-job~1{job_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/node_from_template_jobs/methods/describe_node_from_template_job" - - $ref: "#/components/x-stackQL-resources/node_from_template_jobs/methods/list_node_from_template_jobs" - insert: - - $ref: "#/components/x-stackQL-resources/node_from_template_jobs/methods/create_node_from_template_job" - update: [] - delete: [] - packages: - id: aws.panorama.packages - name: packages - title: packages - methods: - create_package: - operation: - $ref: "#/paths/~1packages/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_packages: - operation: - $ref: "#/paths/~1packages/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - delete_package: - operation: - $ref: "#/paths/~1packages~1{package_id}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_package: - operation: - $ref: "#/paths/~1packages~1metadata~1{package_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/packages/methods/describe_package" - - $ref: "#/components/x-stackQL-resources/packages/methods/list_packages" - insert: - - $ref: "#/components/x-stackQL-resources/packages/methods/create_package" - update: [] - delete: - - $ref: "#/components/x-stackQL-resources/packages/methods/delete_package" - package_import_jobs: - id: aws.panorama.package_import_jobs - name: package_import_jobs - title: package_import_jobs - methods: - create_package_import_job: - operation: - $ref: "#/paths/~1packages~1import-jobs/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - list_package_import_jobs: - operation: - $ref: "#/paths/~1packages~1import-jobs/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_package_import_job: - operation: - $ref: "#/paths/~1packages~1import-jobs~1{job_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/package_import_jobs/methods/describe_package_import_job" - - $ref: "#/components/x-stackQL-resources/package_import_jobs/methods/list_package_import_jobs" - insert: - - $ref: "#/components/x-stackQL-resources/package_import_jobs/methods/create_package_import_job" - update: [] - delete: [] - package_versions: - id: aws.panorama.package_versions - name: package_versions - title: package_versions - methods: - deregister_package_version: - operation: - $ref: "#/paths/~1packages~1{package_id}~1versions~1{package_version}~1patch~1{patch_version}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - register_package_version: - operation: - $ref: "#/paths/~1packages~1{package_id}~1versions~1{package_version}~1patch~1{patch_version}/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - describe_package_version: - operation: - $ref: "#/paths/~1packages~1metadata~1{package_id}~1versions~1{package_version}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/package_versions/methods/describe_package_version" - insert: - - $ref: "#/components/x-stackQL-resources/package_versions/methods/register_package_version" - update: [] - delete: - - $ref: "#/components/x-stackQL-resources/package_versions/methods/deregister_package_version" - application_instance_details: - id: aws.panorama.application_instance_details - name: application_instance_details - title: application_instance_details - methods: - describe_application_instance_details: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}~1details/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/application_instance_details/methods/describe_application_instance_details" - insert: [] - update: [] - delete: [] - device_jobs: - id: aws.panorama.device_jobs - name: device_jobs - title: device_jobs - methods: - describe_device_job: - operation: - $ref: "#/paths/~1jobs~1{job_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/device_jobs/methods/describe_device_job" - insert: [] - update: [] - delete: [] - nodes: - id: aws.panorama.nodes - name: nodes - title: nodes - methods: - describe_node: - operation: - $ref: "#/paths/~1nodes~1{node_id}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - list_nodes: - operation: - $ref: "#/paths/~1nodes/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/nodes/methods/describe_node" - - $ref: "#/components/x-stackQL-resources/nodes/methods/list_nodes" - insert: [] - update: [] - delete: [] - application_instance_dependencies: - id: aws.panorama.application_instance_dependencies - name: application_instance_dependencies - title: application_instance_dependencies - methods: - list_application_instance_dependencies: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}~1package-dependencies/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/application_instance_dependencies/methods/list_application_instance_dependencies" - insert: [] - update: [] - delete: [] - application_instance_node_instances: - id: aws.panorama.application_instance_node_instances - name: application_instance_node_instances - title: application_instance_node_instances - methods: - list_application_instance_node_instances: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}~1node-instances/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - signal_application_instance_node_instances: - operation: - $ref: "#/paths/~1application-instances~1{application_instance_id}~1node-signals/put" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/application_instance_node_instances/methods/list_application_instance_node_instances" - insert: [] - update: [] - delete: [] - tags: - id: aws.panorama.tags - name: tags - title: tags - methods: - list_tags_for_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - tag_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - untag_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" - insert: [] - update: - - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" - - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - delete: [] diff --git a/providers/src/aws/v00.00.00000/services/partnercentral_account.yaml b/providers/src/aws/v00.00.00000/services/partnercentral_account.yaml index d065f393..d90519df 100644 --- a/providers/src/aws/v00.00.00000/services/partnercentral_account.yaml +++ b/providers/src/aws/v00.00.00000/services/partnercentral_account.yaml @@ -638,6 +638,114 @@ paths: application/json: schema: $ref: "#/components/schemas/GetProfileVisibilityResponse" + /GetQualificationsAssociationDetails: + post: + operationId: GetQualificationsAssociationDetails + description: Returns your current qualifications association status, the primary partner, and the full list of partners associated under the primary partner. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PartnerCentralAccount.GetQualificationsAssociationDetails + default: PartnerCentralAccount.GetQualificationsAssociationDetails + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: "The catalog in which to look up the qualifications association. Valid values: AWS, Sandbox." + Identifier: + $ref: "#/components/schemas/PartnerIdentifier" + description: Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetQualificationsAssociationDetailsResponse" + /GetQualificationsAssociationTask: + post: + operationId: GetQualificationsAssociationTask + description: Retrieves the status and details of the most recent qualifications association task for your partner account. Use this operation to poll the progress of an association task initiated by StartQualificationsAssociationTask. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PartnerCentralAccount.GetQualificationsAssociationTask + default: PartnerCentralAccount.GetQualificationsAssociationTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: "The catalog in which to look up the qualifications association task. Valid values: AWS, Sandbox." + Identifier: + $ref: "#/components/schemas/PartnerIdentifier" + description: Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetQualificationsAssociationTaskResponse" + /GetQualificationsDisassociationTask: + post: + operationId: GetQualificationsDisassociationTask + description: Retrieves the status and details of the most recent qualifications disassociation task for your partner account. Use this operation to poll the progress of a disassociation task initiated by StartQualificationsDisassociationTask. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PartnerCentralAccount.GetQualificationsDisassociationTask + default: PartnerCentralAccount.GetQualificationsDisassociationTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: "The catalog in which to look up the qualifications disassociation task. Valid values: AWS, Sandbox." + Identifier: + $ref: "#/components/schemas/PartnerIdentifier" + description: Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier. + required: + - Identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetQualificationsDisassociationTaskResponse" /GetVerification: post: operationId: GetVerification @@ -1035,6 +1143,92 @@ paths: application/json: schema: $ref: "#/components/schemas/StartProfileUpdateTaskResponse" + /StartQualificationsAssociationTask: + post: + operationId: StartQualificationsAssociationTask + description: Initiates an asynchronous task to associate your partner qualifications with a primary account. You must be a subsidiary of the primary account with an active subsidiary connection. Use GetQualificationsAssociationTask to monitor task progress. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PartnerCentralAccount.StartQualificationsAssociationTask + default: PartnerCentralAccount.StartQualificationsAssociationTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: "The catalog in which to perform the qualifications association. Valid values: AWS, Sandbox." + Identifier: + $ref: "#/components/schemas/PartnerIdentifier" + description: Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier. + ClientToken: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + PrimaryPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The primary (acquiring) partner's profile and account identifier to associate qualifications with. You must provide at least one of ProfileId or AccountId. You cannot specify yourself as the primary partner. + required: + - Identifier + - PrimaryPartner + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartQualificationsAssociationTaskResponse" + /StartQualificationsDisassociationTask: + post: + operationId: StartQualificationsDisassociationTask + description: Initiates an asynchronous task to disassociate your partner qualifications from a primary account. You must currently be associated and cannot disassociate if you are the primary partner. Use GetQualificationsDisassociationTask to monitor task progress. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PartnerCentralAccount.StartQualificationsDisassociationTask + default: PartnerCentralAccount.StartQualificationsDisassociationTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: "The catalog in which to perform the qualifications disassociation. Valid values: AWS, Sandbox." + Identifier: + $ref: "#/components/schemas/PartnerIdentifier" + description: Your partner identifier. You can provide either a partner ID (for example, partner-abc123) or a partner ARN. You must own this identifier. + ClientToken: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + AssociatedPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The primary partner's profile and account identifier that you are currently associated with and will disassociate from. You must provide at least one of ProfileId or AccountId. The specified partner must match your current primary association. + required: + - Identifier + - AssociatedPartner + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartQualificationsDisassociationTaskResponse" /StartVerification: post: operationId: StartVerification @@ -1519,6 +1713,9 @@ components: LocalizedContents: $ref: "#/components/schemas/LocalizedContentList" description: The updated localized content for the partner profile. + Headquarters: + $ref: "#/components/schemas/Headquarters" + description: The ISO 3166 country and subdivision codes for the partner's headquarters location. If you omit this field, the service retains the existing headquarters value. required: - DisplayName - Description @@ -1634,6 +1831,29 @@ components: minLength: 1 maxLength: 600 pattern: "[\\u0020-\\u007E\\u00A0-\\uD7FF\\uE000-\\uFFFD]+" + Headquarters: + description: Contains the partner's headquarters location using International Organization for Standardization (ISO) 3166 country and subdivision codes. + type: object + properties: + CountryCode: + $ref: "#/components/schemas/CountryCode" + description: The ISO 3166-1 alpha-2 country code of the partner's headquarters. For example, US, BR, or DE. + SubdivisionCode: + $ref: "#/components/schemas/SubdivisionCode" + description: The subdivision portion of the ISO 3166-2 code for the partner's headquarters (for example, SP from BR-SP, NSW from AU-NSW, or 13 from JP-13). + required: + - CountryCode + - SubdivisionCode + CountryCode: + type: string + minLength: 2 + maxLength: 2 + pattern: "[A-Z]{2}" + SubdivisionCode: + type: string + minLength: 1 + maxLength: 3 + pattern: "[A-Z0-9]{1,3}" ProfileTaskStatus: type: string enum: @@ -1851,6 +2071,9 @@ components: LocalizedContents: $ref: "#/components/schemas/LocalizedContentList" description: A list of localized content versions for different languages and regions. + Headquarters: + $ref: "#/components/schemas/Headquarters" + description: The ISO 3166 country and subdivision codes for the partner's headquarters location. If no headquarters location is set, this field is not included in the response. ProfileId: $ref: "#/components/schemas/PartnerProfileId" description: The unique identifier of the partner profile. @@ -2151,6 +2374,150 @@ components: enum: - PRIVATE - PUBLIC + GetQualificationsAssociationDetailsResponse: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: The catalog identifier echoed from the request. + Arn: + $ref: "#/components/schemas/PartnerArn" + description: The Amazon Resource Name (ARN) that uniquely identifies your partner resource. + Id: + $ref: "#/components/schemas/PartnerId" + description: Your unique partner identifier in the AWS Partner Network. + Status: + $ref: "#/components/schemas/QualificationsAssociationStatus" + description: "The current qualifications association status. Valid values: ASSOCIATED (the partner is associated with a primary), NOT_ASSOCIATED (the partner has no active association)." + PrimaryPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The primary partner's profile and account identifiers. This field is null when the status is NOT_ASSOCIATED. + AssociatedPartners: + $ref: "#/components/schemas/AssociatedPartnerList" + description: The list of all partner profile and account identifiers currently associated under the primary partner. This field is null when the status is NOT_ASSOCIATED. + UpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications association was last updated, in ISO 8601 format. This field is null when the status is NOT_ASSOCIATED. + required: + - Catalog + - Arn + - Id + - Status + QualificationsAssociationStatus: + description: "The current state of a partner qualifications association. Valid values: ASSOCIATED (the partner is associated with a primary), NOT_ASSOCIATED (the partner has no active association)." + type: string + enum: + - ASSOCIATED + - NOT_ASSOCIATED + QualificationsAssociationPartner: + description: Identifies a partner in a qualifications association group. Contains the partner's profile identifier and AWS account identifier. In requests, provide at least one of ProfileId or AccountId. In responses, both fields are populated. + type: object + properties: + ProfileId: + $ref: "#/components/schemas/PartnerProfileId" + description: The unique identifier for the partner profile, in the format pprofile-*. Required in requests if AccountId is not provided. + AccountId: + $ref: "#/components/schemas/AwsAccountId" + description: The 12-digit AWS account ID linked to the partner profile. Required in requests if ProfileId is not provided. + AssociatedPartnerList: + description: A list of partner profile and account identifiers representing all partners associated under the primary partner. + type: array + items: + $ref: "#/components/schemas/QualificationsAssociationPartner" + GetQualificationsAssociationTaskResponse: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: The catalog identifier echoed from the request. + Arn: + $ref: "#/components/schemas/PartnerArn" + description: The Amazon Resource Name (ARN) that uniquely identifies your partner resource. + Id: + $ref: "#/components/schemas/PartnerId" + description: Your unique partner identifier in the AWS Partner Network. + TaskId: + $ref: "#/components/schemas/QualificationsAssociationTaskId" + description: The unique identifier of the qualifications association task, in the format pqatask-[a-z2-7]{13}. + Status: + $ref: "#/components/schemas/QualificationsAssociationTaskStatus" + description: "The current status of the qualifications association task. Valid values: IN_PROGRESS, SUCCEEDED." + PrimaryPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The primary partner's profile and account identifiers that the task is associating qualifications with. + StartedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications association task started, in ISO 8601 format. + EndedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications association task ended, in ISO 8601 format. This field is present only when the status is SUCCEEDED. + required: + - Catalog + - Arn + - Id + - TaskId + - Status + - PrimaryPartner + - StartedAt + QualificationsAssociationTaskId: + description: The unique identifier for a qualifications association task, in the format pqatask-[a-z2-7]{13}. + type: string + minLength: 1 + maxLength: 80 + pattern: pqatask-[A-Za-z0-9]{13} + QualificationsAssociationTaskStatus: + description: "The current status of a qualifications association task. Valid values: IN_PROGRESS (task is running), SUCCEEDED (task completed successfully)." + type: string + enum: + - IN_PROGRESS + - SUCCEEDED + GetQualificationsDisassociationTaskResponse: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: The catalog identifier echoed from the request. + Arn: + $ref: "#/components/schemas/PartnerArn" + description: The Amazon Resource Name (ARN) that uniquely identifies your partner resource. + Id: + $ref: "#/components/schemas/PartnerId" + description: Your unique partner identifier in the AWS Partner Network. + TaskId: + $ref: "#/components/schemas/QualificationsDisassociationTaskId" + description: The unique identifier of the qualifications disassociation task, in the format pqdtask-[a-z2-7]{13}. + Status: + $ref: "#/components/schemas/QualificationsDisassociationTaskStatus" + description: "The current status of the qualifications disassociation task. Valid values: IN_PROGRESS, SUCCEEDED." + AssociatedPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The primary partner's profile and account identifiers that the task is disassociating qualifications from. + StartedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications disassociation task started, in ISO 8601 format. + EndedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications disassociation task ended, in ISO 8601 format. This field is present only when the status is SUCCEEDED. + required: + - Catalog + - Arn + - Id + - TaskId + - Status + - AssociatedPartner + - StartedAt + QualificationsDisassociationTaskId: + description: The unique identifier for a qualifications disassociation task, in the format pqdtask-[a-z2-7]{13}. + type: string + minLength: 1 + maxLength: 80 + pattern: pqdtask-[A-Za-z0-9]{13} + QualificationsDisassociationTaskStatus: + description: "The current status of a qualifications disassociation task. Valid values: IN_PROGRESS (task is running), SUCCEEDED (task completed successfully)." + type: string + enum: + - IN_PROGRESS + - SUCCEEDED VerificationType: type: string enum: @@ -2250,11 +2617,6 @@ components: minLength: 1 maxLength: 80 pattern: "[\\u0020-\\u007E\\u00A0-\\uD7FF\\uE000-\\uFFFD]+" - CountryCode: - type: string - minLength: 2 - maxLength: 2 - pattern: "[A-Z]{2}" JurisdictionCode: type: string minLength: 2 @@ -2611,6 +2973,70 @@ components: - TaskDetails - StartedAt - Status + StartQualificationsAssociationTaskResponse: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: The catalog identifier echoed from the request. + Arn: + $ref: "#/components/schemas/PartnerArn" + description: The Amazon Resource Name (ARN) that uniquely identifies your partner resource. + Id: + $ref: "#/components/schemas/PartnerId" + description: Your unique partner identifier in the AWS Partner Network. + TaskId: + $ref: "#/components/schemas/QualificationsAssociationTaskId" + description: The unique identifier of the started qualifications association task, in the format pqatask-[a-z2-7]{13}. + Status: + $ref: "#/components/schemas/QualificationsAssociationTaskStatus" + description: The current status of the qualifications association task. The initial value is IN_PROGRESS. + PrimaryPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The resolved primary partner's profile and account identifiers, including both ProfileId and AccountId. + StartedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications association task started, in ISO 8601 format. + required: + - Catalog + - Arn + - Id + - TaskId + - Status + - PrimaryPartner + - StartedAt + StartQualificationsDisassociationTaskResponse: + type: object + properties: + Catalog: + $ref: "#/components/schemas/Catalog" + description: The catalog identifier echoed from the request. + Arn: + $ref: "#/components/schemas/PartnerArn" + description: The Amazon Resource Name (ARN) that uniquely identifies your partner resource. + Id: + $ref: "#/components/schemas/PartnerId" + description: Your unique partner identifier in the AWS Partner Network. + TaskId: + $ref: "#/components/schemas/QualificationsDisassociationTaskId" + description: The unique identifier of the started qualifications disassociation task, in the format pqdtask-[a-z2-7]{13}. + Status: + $ref: "#/components/schemas/QualificationsDisassociationTaskStatus" + description: The current status of the qualifications disassociation task. The initial value is IN_PROGRESS. + AssociatedPartner: + $ref: "#/components/schemas/QualificationsAssociationPartner" + description: The resolved primary partner's profile and account identifiers that the task is disassociating qualifications from. + StartedAt: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the qualifications disassociation task started, in ISO 8601 format. + required: + - Catalog + - Arn + - Id + - TaskId + - Status + - AssociatedPartner + - StartedAt VerificationDetails: description: A union structure containing the specific details required for different types of verification processes supported by AWS Partner Central. type: object @@ -3073,6 +3499,78 @@ components: replace: - $ref: "#/components/x-stackQL-resources/profile_visibilities/methods/put_profile_visibility" delete: [] + qualifications_association_details: + id: aws.partnercentral_account.qualifications_association_details + name: qualifications_association_details + title: qualifications_association_details + methods: + get_qualifications_association_details: + operation: + $ref: "#/paths/~1GetQualificationsAssociationDetails/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/qualifications_association_details/methods/get_qualifications_association_details" + insert: [] + update: [] + delete: [] + qualifications_association_tasks: + id: aws.partnercentral_account.qualifications_association_tasks + name: qualifications_association_tasks + title: qualifications_association_tasks + methods: + get_qualifications_association_task: + operation: + $ref: "#/paths/~1GetQualificationsAssociationTask/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/qualifications_association_tasks/methods/get_qualifications_association_task" + insert: [] + update: [] + delete: [] + qualifications_disassociation_tasks: + id: aws.partnercentral_account.qualifications_disassociation_tasks + name: qualifications_disassociation_tasks + title: qualifications_disassociation_tasks + methods: + get_qualifications_disassociation_task: + operation: + $ref: "#/paths/~1GetQualificationsDisassociationTask/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/qualifications_disassociation_tasks/methods/get_qualifications_disassociation_task" + insert: [] + update: [] + delete: [] verifications: id: aws.partnercentral_account.verifications name: verifications diff --git a/providers/src/aws/v00.00.00000/services/partnercentral_selling.yaml b/providers/src/aws/v00.00.00000/services/partnercentral_selling.yaml index 2530f176..0d3da86e 100644 --- a/providers/src/aws/v00.00.00000/services/partnercentral_selling.yaml +++ b/providers/src/aws/v00.00.00000/services/partnercentral_selling.yaml @@ -661,6 +661,43 @@ paths: application/json: schema: $ref: "#/components/schemas/GetOpportunityResponse" + /GetProspectingFromEngagementTask: + post: + operationId: GetProspectingFromEngagementTask + description: Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSPartnerCentralSelling.GetProspectingFromEngagementTask + default: AWSPartnerCentralSelling.GetProspectingFromEngagementTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/CatalogIdentifier" + description: Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created. + TaskIdentifier: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + description: The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response. + required: + - Catalog + - TaskIdentifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetProspectingFromEngagementTaskResponse" /GetResourceSnapshot: post: operationId: GetResourceSnapshot @@ -1209,6 +1246,60 @@ paths: application/json: schema: $ref: "#/components/schemas/ListOpportunityFromEngagementTasksResponse" + /ListProspectingFromEngagementTasks: + post: + operationId: ListProspectingFromEngagementTasks + description: Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the NextToken value from each response to retrieve subsequent pages. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSPartnerCentralSelling.ListProspectingFromEngagementTasks + default: AWSPartnerCentralSelling.ListProspectingFromEngagementTasks + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/CatalogIdentifier" + description: Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes. + MaxResults: + $ref: "#/components/schemas/PageSize" + description: The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size. + NextToken: + $ref: "#/components/schemas/String" + description: The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned. + TaskIdentifier: + $ref: "#/components/schemas/TaskIdentifierList" + description: Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier. + TaskName: + $ref: "#/components/schemas/TaskNameList" + description: Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name. + StartAfter: + $ref: "#/components/schemas/DateTime" + description: Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation. + StartBefore: + $ref: "#/components/schemas/DateTime" + description: Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation. + Sort: + $ref: "#/components/schemas/ProspectingFromEngagementTaskSort" + description: Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order. + required: + - Catalog + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListProspectingFromEngagementTasksResponse" /ListResourceSnapshotJobs: post: operationId: ListResourceSnapshotJobs @@ -1351,6 +1442,9 @@ paths: Category: $ref: "#/components/schemas/ListSolutionsRequestCategoryList" description: Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services. + AwsMarketplaceSolutionArn: + $ref: "#/components/schemas/ListSolutionsRequestAwsMarketplaceSolutionArnList" + description: Filters results by AWS Marketplace solution ARN. You can provide up to 10 ARNs. responses: "200": description: Success @@ -1599,6 +1693,50 @@ paths: application/json: schema: $ref: "#/components/schemas/StartOpportunityFromEngagementTaskResponse" + /StartProspectingFromEngagementTask: + post: + operationId: StartProspectingFromEngagementTask + description: Starts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use GetProspectingFromEngagementTask, or use ListProspectingFromEngagementTasks to monitor multiple tasks. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSPartnerCentralSelling.StartProspectingFromEngagementTask + default: AWSPartnerCentralSelling.StartProspectingFromEngagementTask + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + Catalog: + $ref: "#/components/schemas/CatalogIdentifier" + description: Specifies the catalog in which the task is initiated. Specify AWS for production environments and Sandbox for testing and development purposes. + Identifiers: + $ref: "#/components/schemas/EngagementIdentifierList" + description: The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task. + TaskName: + $ref: "#/components/schemas/TaskName" + description: A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters. + ClientToken: + $ref: "#/components/schemas/ClientToken" + description: A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same ClientToken returns the same response without creating a duplicate task. + required: + - Catalog + - TaskName + - ClientToken + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartProspectingFromEngagementTaskResponse" /StartResourceSnapshotJob: post: operationId: StartResourceSnapshotJob @@ -1996,6 +2134,8 @@ components: - AwsProducts - AwsMarketplaceOffers - AwsMarketplaceOfferSets + - AwsMarketplaceSolutions + - AwsMarketplaceProducts AssociateOpportunityRequestRelatedEntityIdentifierString: type: string pattern: (?s).{1,255} @@ -2004,7 +2144,7 @@ components: pattern: .{1,255} EngagementTitle: type: string - pattern: (?s).{1,40} + pattern: (?s).{0,40} EngagementDescription: type: string pattern: (?s).{0,255} @@ -2035,6 +2175,7 @@ components: enum: - CustomerProject - Lead + - ProspectingResult EngagementContextPayload: description: Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails. type: object @@ -2045,6 +2186,9 @@ components: Lead: $ref: "#/components/schemas/LeadContext" description: Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead". + ProspectingResult: + $ref: "#/components/schemas/ProspectingResult" + description: Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult". CustomerProjectsContext: description: The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers. All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations. type: object @@ -2394,6 +2538,9 @@ components: description: Provides comprehensive details about a lead associated with an engagement. This structure contains information about lead qualification status, customer details, and interaction history to facilitate lead management and tracking within the engagement. type: object properties: + Insights: + $ref: "#/components/schemas/LeadInsights" + description: Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality. QualificationStatus: $ref: "#/components/schemas/LeadQualificationStatus" description: Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process. @@ -2406,6 +2553,15 @@ components: required: - Customer - Interactions + LeadInsights: + description: Contains insights that AI generates for a lead. These insights provide automated analysis to help partners evaluate the lead quality and prioritize engagement efforts. + type: object + properties: + LeadReadinessScore: + $ref: "#/components/schemas/String" + description: A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion. + String: + type: string LeadQualificationStatus: type: string pattern: (?s).{1,255} @@ -2414,60 +2570,73 @@ components: type: object properties: Industry: - $ref: "#/components/schemas/Industry" + $ref: "#/components/schemas/LeadIndustry" description: Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions. CompanyName: $ref: "#/components/schemas/CompanyName" description: The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead. WebsiteUrl: - $ref: "#/components/schemas/CompanyWebsiteUrl" + $ref: "#/components/schemas/LeadWebsiteUrl" description: The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size. Address: - $ref: "#/components/schemas/AddressSummary" + $ref: "#/components/schemas/LeadAddress" + description: The address information for the lead customer. AwsMaturity: $ref: "#/components/schemas/AwsMaturity" description: Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity. MarketSegment: - $ref: "#/components/schemas/MarketSegment" + $ref: "#/components/schemas/LeadMarketSegment" description: Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies. required: - CompanyName - - Address - AddressSummary: - description: An object that contains an Address object's subset of fields. + LeadIndustry: + type: string + minLength: 0 + maxLength: 255 + LeadWebsiteUrl: + type: string + minLength: 0 + maxLength: 255 + LeadAddress: + description: The address information for a lead customer, including city, state or region, postal code, and country code. type: object properties: City: - $ref: "#/components/schemas/AddressSummaryCityString" - description: Specifies the end Customer's city associated with the Opportunity. + $ref: "#/components/schemas/LeadAddressCityString" + description: The city of the lead customer's address. PostalCode: - $ref: "#/components/schemas/AddressSummaryPostalCodeString" - description: Specifies the end Customer's postal code associated with the Opportunity. + $ref: "#/components/schemas/LeadAddressPostalCodeString" + description: The postal code of the lead customer's address. StateOrRegion: - $ref: "#/components/schemas/AddressPart" - description: "Specifies the end Customer's state or region associated with the Opportunity. Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP" + $ref: "#/components/schemas/LeadAddressStateOrRegionString" + description: The state or region of the lead customer's address. CountryCode: - $ref: "#/components/schemas/CountryCode" - description: Specifies the end Customer's country associated with the Opportunity. - AddressSummaryCityString: + $ref: "#/components/schemas/LeadCountryCode" + description: The country code of the lead customer's address. + LeadAddressCityString: type: string - pattern: (?s).{0,255} - AddressSummaryPostalCodeString: + minLength: 0 + maxLength: 255 + LeadAddressPostalCodeString: type: string - pattern: (?s).{0,20} - AddressPart: + minLength: 0 + maxLength: 20 + LeadAddressStateOrRegionString: type: string + minLength: 0 + maxLength: 255 + LeadCountryCode: + type: string + minLength: 0 + maxLength: 10 AwsMaturity: type: string - pattern: (?s).{1,20} - MarketSegment: + minLength: 0 + maxLength: 255 + LeadMarketSegment: type: string - enum: - - Enterprise - - Large - - Medium - - Small - - Micro + minLength: 0 + maxLength: 255 LeadInteractionList: type: array items: @@ -2495,44 +2664,46 @@ components: $ref: "#/components/schemas/CustomerAction" description: Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution. BusinessProblem: - $ref: "#/components/schemas/EngagementCustomerBusinessProblem" + $ref: "#/components/schemas/LeadBusinessProblem" description: Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions. Contact: $ref: "#/components/schemas/LeadContact" description: Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details. required: - - SourceType - - SourceId - - SourceName - - CustomerAction - Contact LeadSourceType: type: string - pattern: (?s).{1,255} + pattern: (?s).{0,255} LeadSourceId: type: string - pattern: (?s).{1,255} + pattern: (?s).{0,255} LeadSourceName: type: string - pattern: (?s).{1,255} + pattern: (?s).{0,255} EngagementUseCase: type: string - pattern: (?s).{1,255} + minLength: 0 + maxLength: 255 DateTime: type: string format: date-time CustomerAction: type: string - pattern: (?s).{1,255} + minLength: 0 + maxLength: 255 + LeadBusinessProblem: + type: string + minLength: 0 + maxLength: 2000 LeadContact: description: An object that contains a lead contact's details associated with the engagement. This provides contact information for individuals involved in lead-related activities. type: object properties: BusinessTitle: - $ref: "#/components/schemas/JobTitle" + $ref: "#/components/schemas/LeadJobTitle" description: The lead contact's business title or job role associated with the engagement. Email: - $ref: "#/components/schemas/Email" + $ref: "#/components/schemas/LeadEmail" description: The lead contact's email address associated with the engagement. FirstName: $ref: "#/components/schemas/Name" @@ -2541,16 +2712,163 @@ components: $ref: "#/components/schemas/Name" description: The lead contact's last name associated with the engagement. Phone: - $ref: "#/components/schemas/PhoneNumber" + $ref: "#/components/schemas/LeadPhoneNumber" description: The lead contact's phone number associated with the engagement. required: - BusinessTitle - Email - FirstName - LastName + LeadJobTitle: + type: string + minLength: 0 + maxLength: 255 + LeadEmail: + type: string + minLength: 1 + maxLength: 255 Name: type: string pattern: (?s).{0,80} + LeadPhoneNumber: + type: string + minLength: 0 + maxLength: 255 + ProspectingResult: + description: Contains the results of an autonomous prospecting job. This includes data and insights that AWS provides about a prospected customer account. + type: object + properties: + Aws: + $ref: "#/components/schemas/ProspectingResultAws" + description: Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates. + ProspectingResultAws: + description: Contains the prospecting data that AWS sources. This includes task execution details, customer account information, and insights that AI generates from the prospecting analysis. + type: object + properties: + Customer: + $ref: "#/components/schemas/ProspectingResultCustomer" + description: Contains details about the prospected customer account, including geographic, industry, and segment classifications. + Insights: + $ref: "#/components/schemas/ProspectingInsights" + description: Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer. + StartTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC). + EndTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC). + TaskId: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + description: The unique identifier of the prospecting task that generates this result. + TaskArn: + $ref: "#/components/schemas/TaskArn" + description: The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS. + TaskName: + $ref: "#/components/schemas/TaskName" + description: The name that the user provides for the prospecting task that generates this result. + ProspectingResultCustomer: + description: Contains detailed information about the prospected customer account, including company identifiers, geographic classification, industry segmentation, and program eligibility. + type: object + properties: + AccountName: + $ref: "#/components/schemas/ProspectingAccountName" + description: The name of the prospected customer account. + Geo: + $ref: "#/components/schemas/ProspectingGeo" + description: The geographic region classification of the prospected customer account. + Region: + $ref: "#/components/schemas/ProspectingRegion" + description: The specific region of the prospected customer account. + SubRegion: + $ref: "#/components/schemas/ProspectingSubRegion" + description: The subregion classification of the prospected customer account. + Country: + $ref: "#/components/schemas/CountryCode" + description: The country code of the prospected customer account. + Industry: + $ref: "#/components/schemas/Industry" + description: The industry classification of the prospected customer account. + SubIndustry: + $ref: "#/components/schemas/ProspectingSubIndustry" + description: The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry. + Segment: + $ref: "#/components/schemas/ProspectingSegment" + description: The market segment classification of the prospected customer account. + CompanySize: + $ref: "#/components/schemas/ProspectingCompanySize" + description: The company size classification of the prospected customer account. + EligiblePrograms: + $ref: "#/components/schemas/EligibleProgramsList" + description: A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities. + PublicProfileSummary: + $ref: "#/components/schemas/ProspectingPublicProfileSummary" + description: A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies. + ProspectingAccountName: + type: string + minLength: 0 + maxLength: 255 + ProspectingGeo: + type: string + minLength: 0 + maxLength: 255 + ProspectingRegion: + type: string + minLength: 0 + maxLength: 255 + ProspectingSubRegion: + type: string + minLength: 0 + maxLength: 255 + ProspectingSubIndustry: + type: string + minLength: 0 + maxLength: 255 + ProspectingSegment: + type: string + minLength: 0 + maxLength: 255 + ProspectingCompanySize: + type: string + minLength: 0 + maxLength: 255 + EligibleProgramsList: + type: array + items: + $ref: "#/components/schemas/String" + ProspectingPublicProfileSummary: + type: string + minLength: 0 + maxLength: 5000 + ProspectingInsights: + description: Contains insights that AI generates from the prospecting analysis. These insights include marketplace engagement scoring, solution fit assessments, and solution categorization for the prospected customer. + type: object + properties: + MarketplaceEngagementScore: + $ref: "#/components/schemas/EngagementScoreLevel" + description: A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low. + SolutionScore: + $ref: "#/components/schemas/String" + description: A score that indicates how well the partner's solution fits the prospected customer's needs. + SolutionCategory: + $ref: "#/components/schemas/String" + description: The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs. + SolutionSubCategory: + $ref: "#/components/schemas/String" + description: The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type. + EngagementScoreLevel: + type: string + minLength: 0 + maxLength: 255 + ProspectingTaskIdentifier: + type: string + pattern: task-[0-9a-z]{14} + TaskArn: + type: string + pattern: arn:.* + TaskName: + type: string + minLength: 1 + maxLength: 128 CreateEngagementResponse: type: object properties: @@ -2747,10 +3065,10 @@ components: description: Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR. Frequency: $ref: "#/components/schemas/PaymentFrequency" - description: Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend. + description: 'Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).' TargetCompany: $ref: "#/components/schemas/ExpectedCustomerSpendTargetCompanyString" - description: Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS. + description: Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS. EstimationUrl: $ref: "#/components/schemas/EstimationUrl" description: A URL providing additional information or context about the spend estimation. @@ -2960,26 +3278,25 @@ components: type: object properties: Industry: - $ref: "#/components/schemas/Industry" + $ref: "#/components/schemas/LeadIndustry" description: Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit. CompanyName: $ref: "#/components/schemas/CompanyName" description: The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity. WebsiteUrl: - $ref: "#/components/schemas/CompanyWebsiteUrl" + $ref: "#/components/schemas/LeadWebsiteUrl" description: The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy. CountryCode: - $ref: "#/components/schemas/CountryCode" + $ref: "#/components/schemas/LeadCountryCode" description: The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively. AwsMaturity: $ref: "#/components/schemas/AwsMaturity" description: Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly. MarketSegment: - $ref: "#/components/schemas/MarketSegment" + $ref: "#/components/schemas/LeadMarketSegment" description: Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy. required: - CompanyName - - CountryCode LeadInvitationInteraction: description: Represents interaction details included in a lead invitation payload. This structure provides context about how the lead was generated and the customer's engagement history to help partners assess the opportunity quality. type: object @@ -3000,9 +3317,6 @@ components: $ref: "#/components/schemas/JobTitle" description: The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead. required: - - SourceType - - SourceId - - SourceName - ContactBusinessTitle CreateEngagementInvitationResponse: type: object @@ -3116,6 +3430,8 @@ components: AddressPostalCodeString: type: string pattern: (?s).{0,20} + AddressPart: + type: string AddressStreetAddressString: type: string pattern: (?s).{0,255} @@ -3228,8 +3544,6 @@ components: type: string enum: - Months - String: - type: string ProjectTitleString: type: string pattern: (?s).{0,255} @@ -3593,6 +3907,9 @@ components: Project: $ref: "#/components/schemas/AwsOpportunityProject" description: Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity. + CosellMotion: + $ref: "#/components/schemas/String" + description: "Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led." Catalog: $ref: "#/components/schemas/CatalogIdentifier" description: Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed. @@ -3773,6 +4090,12 @@ components: AwsProductsSpendInsightsBySource: $ref: "#/components/schemas/AwsProductsSpendInsightsBySource" description: Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates. + OpportunityQuality: + $ref: "#/components/schemas/OpportunityQuality" + description: Opportunity quality assessment. Null if not yet scored. + Recommendations: + $ref: "#/components/schemas/RecommendationList" + description: List of recommendations from various agent-driven sources. EngagementScore: type: string enum: @@ -3879,6 +4202,41 @@ components: required: - Description - SavingsAmount + OpportunityQuality: + description: Opportunity quality score and trend. + type: object + properties: + Score: + $ref: "#/components/schemas/OpportunityQualityScoreInteger" + description: Deal quality score based on opportunity content completeness and sales methodology criteria. Values range from 0 to 100. + Trend: + $ref: "#/components/schemas/String" + description: "Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change." + OpportunityQualityScoreInteger: + type: integer + minimum: 0 + maximum: 100 + RecommendationList: + type: array + items: + $ref: "#/components/schemas/Recommendation" + Recommendation: + description: A recommendation from an agent-driven source. + type: object + properties: + Type: + $ref: "#/components/schemas/String" + description: "The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation." + Details: + $ref: "#/components/schemas/String" + description: Human-readable recommendation text from this source. + Attributes: + type: object + properties: {} + description: Source-specific metadata as key-value pairs. + required: + - Type + - Details InvolvementTypeChangeReason: type: string enum: @@ -3897,6 +4255,12 @@ components: Solutions: $ref: "#/components/schemas/SolutionIdentifiers" description: Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity. + AwsMarketplaceSolutions: + $ref: "#/components/schemas/AwsMarketplaceSolutionIdentifiers" + description: The AWS Marketplace solution ARNs associated with this opportunity. + AwsMarketplaceProducts: + $ref: "#/components/schemas/AwsMarketplaceProductIdentifiers" + description: The AWS Marketplace product ARNs associated with this opportunity. AwsProductIdentifiers: type: array items: @@ -3910,6 +4274,24 @@ components: SolutionIdentifier: type: string pattern: S-[0-9]{1,19} + AwsMarketplaceSolutionIdentifiers: + type: array + items: + $ref: "#/components/schemas/AwsMarketplaceSolutionIdentifier" + AwsMarketplaceSolutionIdentifier: + type: string + minLength: 4 + maxLength: 2048 + pattern: arn:.* + AwsMarketplaceProductIdentifiers: + type: array + items: + $ref: "#/components/schemas/AwsMarketplaceProductArn" + AwsMarketplaceProductArn: + type: string + minLength: 4 + maxLength: 2048 + pattern: arn:.* AwsOpportunityCustomer: description: Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity. type: object @@ -4016,6 +4398,9 @@ components: ExistingMembers: $ref: "#/components/schemas/EngagementMemberSummaries" description: "A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties. CompanyName: The name of the member's company. WebsiteUrl: The website URL of the member's company." + EnrichmentContext: + $ref: "#/components/schemas/EnrichmentContext" + description: The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation. required: - Id - Catalog @@ -4054,6 +4439,26 @@ components: MemberCompanyName: type: string pattern: (?s).{1,120} + EnrichmentContext: + description: Contains enrichment data for engagement invitations. You can view propensity scores, program eligibility, and lead readiness insights directly in the invitation, before you take action on the invitation. + type: object + properties: + ProspectingResultAws: + $ref: "#/components/schemas/InvitationProspectingResultAws" + description: The customer account data and propensity insights for the prospected account. It includes geographic, industry, and segment classifications, along with engagement and solution scoring. + LeadInsights: + $ref: "#/components/schemas/LeadInsights" + description: The AI-generated lead readiness score for this lead. Use this score to assess lead quality and prioritize engagement efforts. + InvitationProspectingResultAws: + description: A subset of prospecting result data visible to invitation receivers. It includes customer account details and AI-generated insights. + type: object + properties: + Customer: + $ref: "#/components/schemas/ProspectingResultCustomer" + description: The prospected customer account details, including geographic classification, industry segmentation, company size, and program eligibility. + Insights: + $ref: "#/components/schemas/ProspectingInsights" + description: The AI-generated insights from the prospecting analysis, including marketplace engagement scoring, solution fit assessments, and solution categorization. GetOpportunityResponse: type: object properties: @@ -4133,6 +4538,12 @@ components: AwsProducts: $ref: "#/components/schemas/AwsProductIdentifiers" description: "Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"]. Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products." + AwsMarketplaceSolutions: + $ref: "#/components/schemas/AwsMarketplaceSolutionIdentifiers" + description: Specifies the AWS Marketplace solutions to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a solution listing in AWS Marketplace. + AwsMarketplaceProducts: + $ref: "#/components/schemas/AwsMarketplaceProductIdentifiers" + description: Specifies the AWS Marketplace products to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a product listing in AWS Marketplace. AwsMarketplaceOfferIdentifiers: type: array items: @@ -4147,6 +4558,74 @@ components: AwsMarketplaceOfferSetIdentifier: type: string pattern: arn:aws:aws-marketplace:[a-z]{1,2}-[a-z]*-\d+:\d{12}:AWSMarketplace/OfferSet/offerset-.* + GetProspectingFromEngagementTaskResponse: + description: Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the Status field of each EngagementProspectingResult entry to determine individual outcomes. + type: object + properties: + TaskId: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + description: The unique identifier of the task. + TaskArn: + $ref: "#/components/schemas/ProspectingTaskArn" + description: The Amazon Resource Name (ARN) of the task. + TaskName: + $ref: "#/components/schemas/TaskName" + description: The descriptive name of the task that you provided when you created it. + StartTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation. + EndTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation. + Engagements: + $ref: "#/components/schemas/EngagementProspectingResultList" + description: An array of EngagementProspectingResult entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message. + required: + - TaskId + - TaskArn + - TaskName + - StartTime + - Engagements + ProspectingTaskArn: + type: string + pattern: arn:aws:partnercentral-selling:.*:.*:catalog/.*/prospecting-from-engagement-task/task-[0-9a-z]{14} + EngagementProspectingResultList: + type: array + items: + $ref: "#/components/schemas/EngagementProspectingResult" + EngagementProspectingResult: + description: Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task. + type: object + properties: + EngagementIdentifier: + $ref: "#/components/schemas/EngagementIdentifier" + description: The unique identifier of the engagement that was processed. + EngagementContextId: + $ref: "#/components/schemas/EngagementProspectingResultEngagementContextIdString" + description: The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations. + Status: + $ref: "#/components/schemas/ProspectingTaskStatus" + description: The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED. + ReasonCode: + $ref: "#/components/schemas/String" + description: An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED. + Message: + $ref: "#/components/schemas/String" + description: A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED. + required: + - EngagementIdentifier + - Status + EngagementProspectingResultEngagementContextIdString: + type: string + pattern: ctx-[0-9a-z]{14} + ProspectingTaskStatus: + description: The current execution state of a prospecting task. A task transitions from PENDING to IN_PROGRESS when processing begins, and then to either COMPLETED or FAILED when processing ends. + type: string + enum: + - PENDING + - IN_PROGRESS + - COMPLETED + - FAILED GetResourceSnapshotResponse: type: object properties: @@ -4293,6 +4772,9 @@ components: $ref: "#/components/schemas/AwsOpportunityCustomer" Project: $ref: "#/components/schemas/AwsOpportunityProject" + CosellMotion: + $ref: "#/components/schemas/String" + description: "Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led." AwsAccountIdOrAliasList: type: array items: @@ -4458,9 +4940,6 @@ components: TaskIdentifier: type: string pattern: .*task-[0-9a-z]{13} - TaskArn: - type: string - pattern: arn:.* ReasonCode: type: string enum: @@ -4967,6 +5446,28 @@ components: AccountSummaryCompanyNameString: type: string pattern: (?s).{0,120} + AddressSummary: + description: An object that contains an Address object's subset of fields. + type: object + properties: + City: + $ref: "#/components/schemas/AddressSummaryCityString" + description: Specifies the end Customer's city associated with the Opportunity. + PostalCode: + $ref: "#/components/schemas/AddressSummaryPostalCodeString" + description: Specifies the end Customer's postal code associated with the Opportunity. + StateOrRegion: + $ref: "#/components/schemas/AddressPart" + description: "Specifies the end Customer's state or region associated with the Opportunity. Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP" + CountryCode: + $ref: "#/components/schemas/CountryCode" + description: Specifies the end Customer's country associated with the Opportunity. + AddressSummaryCityString: + type: string + pattern: (?s).{0,255} + AddressSummaryPostalCodeString: + type: string + pattern: (?s).{0,20} ProjectSummary: description: An object that contains a Project object's subset of fields. type: object @@ -5041,6 +5542,89 @@ components: ContextId: $ref: "#/components/schemas/ContextIdentifier" description: The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement. + TaskIdentifierList: + type: array + items: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + TaskNameList: + type: array + items: + $ref: "#/components/schemas/TaskName" + ProspectingFromEngagementTaskSort: + description: Specifies the sort configuration for ListProspectingFromEngagementTasks. Contains the field to sort by and the sort direction. + type: object + properties: + SortOrder: + $ref: "#/components/schemas/SortOrder" + description: The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first. + SortBy: + $ref: "#/components/schemas/ProspectingFromEngagementTaskSortName" + description: "The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements)." + required: + - SortOrder + - SortBy + ProspectingFromEngagementTaskSortName: + description: The fields available for sorting results from ListProspectingFromEngagementTasks. Valid values are StartTime, TaskName, and FailedEngagementCount. + type: string + enum: + - StartTime + - TaskName + - FailedEngagementCount + ListProspectingFromEngagementTasksResponse: + description: Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through NextToken when additional results are available. + type: object + properties: + NextToken: + $ref: "#/components/schemas/ListProspectingFromEngagementTasksResponseNextTokenString" + description: A pagination token used to retrieve the next page of results. If this field is present, pass its value as NextToken in the next call. If absent or empty, there are no further pages. + TaskSummaries: + $ref: "#/components/schemas/ProspectingTaskSummaryList" + description: Prospecting task summaries matching the specified filters. Each summary includes the task identifier, name, status counters, and timing information. If no tasks match the filter criteria, the list is empty. + required: + - TaskSummaries + ListProspectingFromEngagementTasksResponseNextTokenString: + type: string + pattern: (?s).{1,2048} + ProspectingTaskSummaryList: + type: array + items: + $ref: "#/components/schemas/ProspectingTaskSummary" + ProspectingTaskSummary: + description: A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask. + type: object + properties: + TaskId: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + description: The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details. + TaskArn: + $ref: "#/components/schemas/ProspectingTaskArn" + description: The Amazon Resource Name (ARN) of the task. + TaskName: + $ref: "#/components/schemas/TaskName" + description: The descriptive name of the task provided when it was created. + StartTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation. + EndTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation. + TotalEngagementCount: + $ref: "#/components/schemas/Integer" + description: The total number of engagements included in the task. + CompletedEngagementCount: + $ref: "#/components/schemas/Integer" + description: The number of engagements that have been successfully converted into prospecting leads. + FailedEngagementCount: + $ref: "#/components/schemas/Integer" + description: The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information. + required: + - TaskId + - TaskArn + - TaskName + - StartTime + - TotalEngagementCount + - CompletedEngagementCount + - FailedEngagementCount ListResourceSnapshotJobsRequestMaxResultsInteger: type: integer minimum: 1 @@ -5173,6 +5757,15 @@ components: type: array items: $ref: "#/components/schemas/String" + ListSolutionsRequestAwsMarketplaceSolutionArnList: + type: array + items: + $ref: "#/components/schemas/AwsMarketplaceSolutionArn" + AwsMarketplaceSolutionArn: + type: string + minLength: 4 + maxLength: 2048 + pattern: arn:.* ListSolutionsResponse: type: object properties: @@ -5213,6 +5806,9 @@ components: CreatedDate: $ref: "#/components/schemas/DateTime" description: Indicates the solution creation date. This is useful to track and audit. + AwsMarketplaceSolutionArn: + $ref: "#/components/schemas/AwsMarketplaceSolutionArn" + description: The Amazon Resource Name (ARN) of the AWS Marketplace solution associated with this partner solution. required: - Catalog - Id @@ -5356,6 +5952,43 @@ components: ContextId: $ref: "#/components/schemas/ContextIdentifier" description: The unique identifier of the engagement context used to create the opportunity. + EngagementIdentifierList: + type: array + items: + $ref: "#/components/schemas/EngagementIdentifier" + StartProspectingFromEngagementTaskResponse: + description: Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion. + type: object + properties: + Identifiers: + $ref: "#/components/schemas/EngagementIdentifierList" + description: The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request. + TaskName: + $ref: "#/components/schemas/TaskName" + description: The task name from the request. + Message: + $ref: "#/components/schemas/String" + description: A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state. + ReasonCode: + $ref: "#/components/schemas/String" + description: An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure. + StartTime: + $ref: "#/components/schemas/DateTime" + description: The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation. + TaskId: + $ref: "#/components/schemas/ProspectingTaskIdentifier" + description: The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status. + TaskArn: + $ref: "#/components/schemas/ProspectingTaskArn" + description: The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies. + TaskStatus: + $ref: "#/components/schemas/ProspectingTaskStatus" + description: "The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error)." + required: + - Identifiers + - TaskName + - StartTime + - TaskStatus TagResourceResponse: type: object TagKeyList: @@ -5373,6 +6006,9 @@ components: description: Contains updated information about a lead when the context type is "Lead". This field is present only when updating a lead context within the engagement. CustomerProject: $ref: "#/components/schemas/CustomerProjectsContext" + ProspectingResult: + $ref: "#/components/schemas/ProspectingResult" + description: Contains updated prospecting result data when the context type is "ProspectingResult". This field includes enriched data and insights that the system generates when a partner runs an autonomous prospecting job on leads. UpdateLeadContext: description: Updates the context information for a lead with qualification status, customer details, and interaction data. type: object @@ -5386,6 +6022,9 @@ components: Interaction: $ref: "#/components/schemas/LeadInteraction" description: Updated interaction details for the lead context. + Insights: + $ref: "#/components/schemas/LeadInsights" + description: Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness. required: - Customer UpdateEngagementContextResponse: @@ -5928,6 +6567,52 @@ components: insert: [] update: [] delete: [] + prospecting_from_engagement_tasks: + id: aws.partnercentral_selling.prospecting_from_engagement_tasks + name: prospecting_from_engagement_tasks + title: prospecting_from_engagement_tasks + methods: + get_prospecting_from_engagement_task: + operation: + $ref: "#/paths/~1GetProspectingFromEngagementTask/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_prospecting_from_engagement_tasks: + operation: + $ref: "#/paths/~1ListProspectingFromEngagementTasks/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.TaskSummaries + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/prospecting_from_engagement_tasks/methods/get_prospecting_from_engagement_task" + - $ref: "#/components/x-stackQL-resources/prospecting_from_engagement_tasks/methods/list_prospecting_from_engagement_tasks" + insert: [] + update: [] + delete: [] selling_system_settings: id: aws.partnercentral_selling.selling_system_settings name: selling_system_settings diff --git a/providers/src/aws/v00.00.00000/services/payment_cryptography.yaml b/providers/src/aws/v00.00.00000/services/payment_cryptography.yaml index 2e1deb42..3e8b24f3 100644 --- a/providers/src/aws/v00.00.00000/services/payment_cryptography.yaml +++ b/providers/src/aws/v00.00.00000/services/payment_cryptography.yaml @@ -157,7 +157,7 @@ paths: description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. KeyCheckValueAlgorithm: $ref: "#/components/schemas/KeyCheckValueAlgorithm" - description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. + description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes. Exportable: $ref: "#/components/schemas/Boolean" description: Specifies whether the key is exportable from the service. @@ -764,7 +764,7 @@ paths: description: The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey. KeyCheckValueAlgorithm: $ref: "#/components/schemas/KeyCheckValueAlgorithm" - description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. + description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes. Enabled: $ref: "#/components/schemas/Boolean" description: Specifies whether import key is enabled. @@ -1264,7 +1264,7 @@ components: description: The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. KeyCheckValueAlgorithm: $ref: "#/components/schemas/KeyCheckValueAlgorithm" - description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. + description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes. Enabled: $ref: "#/components/schemas/Boolean" description: Specifies whether the key is enabled. @@ -1904,7 +1904,7 @@ components: description: Parameter information for IPEK export. KeyCheckValueAlgorithm: $ref: "#/components/schemas/KeyCheckValueAlgorithm" - description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. + description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes. ExportDukptInitialKey: description: Parameter information for IPEK generation during export. type: object @@ -1943,7 +1943,7 @@ components: description: The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. KeyCheckValueAlgorithm: $ref: "#/components/schemas/KeyCheckValueAlgorithm" - description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. + description: The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes. required: - WrappingKeyArn - WrappedKeyMaterialFormat diff --git a/providers/src/aws/v00.00.00000/services/pcs.yaml b/providers/src/aws/v00.00.00000/services/pcs.yaml index 4c570227..00d5598c 100644 --- a/providers/src/aws/v00.00.00000/services/pcs.yaml +++ b/providers/src/aws/v00.00.00000/services/pcs.yaml @@ -124,6 +124,9 @@ paths: slurmConfiguration: $ref: "#/components/schemas/ComputeNodeGroupSlurmConfigurationRequest" description: Additional options related to the Slurm scheduler. + nodeLifecycleActions: + $ref: "#/components/schemas/NodeLifecycleActionsRequest" + description: The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs. clientToken: $ref: "#/components/schemas/SBClientToken" description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you. @@ -676,7 +679,7 @@ paths: /UpdateCluster: post: operationId: UpdateCluster - description: Updates a cluster configuration. You can modify Slurm scheduler settings, accounting configuration, and security groups for an existing cluster. You can only update clusters that are in ACTIVE, UPDATE_FAILED, or SUSPENDED state. All associated resources (queues and compute node groups) must be in ACTIVE state before you can update the cluster. + description: Updates a cluster configuration. You can update the scheduler version, modify scheduler settings, and update accounting configuration for an existing cluster. For more information about updating the scheduler version, see Updating the scheduler version on a cluster in the PCS User Guide. You can only update clusters that are in ACTIVE, UPDATE_FAILED, or SUSPENDED state. All associated resources (queues and compute node groups) must be in ACTIVE state before you can update the cluster. parameters: - name: X-Amz-Target in: header @@ -703,6 +706,9 @@ paths: slurmConfiguration: $ref: "#/components/schemas/UpdateClusterSlurmConfigurationRequest" description: Additional options related to the Slurm scheduler. + scheduler: + $ref: "#/components/schemas/UpdateSchedulerRequest" + description: The scheduler configuration to update for the cluster. Use this to update the scheduler version. For more information, see Updating the scheduler version on a cluster in the PCS User Guide. required: - clusterIdentifier responses: @@ -761,6 +767,9 @@ paths: slurmConfiguration: $ref: "#/components/schemas/UpdateComputeNodeGroupSlurmConfigurationRequest" description: Additional options related to the Slurm scheduler. + nodeLifecycleActions: + $ref: "#/components/schemas/UpdateNodeLifecycleActionsRequest" + description: The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs. clientToken: $ref: "#/components/schemas/SBClientToken" description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you. @@ -1125,7 +1134,7 @@ components: description: The software PCS uses to manage cluster scaling and job scheduling. version: $ref: "#/components/schemas/String" - description: "The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in PCS in the PCS User Guide. Valid Values: 23.11 | 24.05 | 24.11 | 25.05 | 25.11" + description: "The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. You can update this version using the UpdateCluster API action. For more information, see Updating the scheduler version on a cluster and Slurm versions in PCS in the PCS User Guide. Valid Values: 23.11 | 24.05 | 24.11 | 25.05 | 25.11" required: - type_ - version @@ -1364,9 +1373,125 @@ components: description: Additional options related to the Slurm scheduler. type: object properties: + scaleDownIdleTimeInSeconds: + $ref: "#/components/schemas/ComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger" + description: The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later. slurmCustomSettings: $ref: "#/components/schemas/SlurmCustomSettings" description: Additional Slurm-specific configuration that directly maps to Slurm settings. + ComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger: + type: integer + minimum: -1 + maximum: 10000000 + NodeLifecycleActionsRequest: + description: The lifecycle actions to configure on a compute node group when you create it. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle. + type: object + properties: + stages: + $ref: "#/components/schemas/NodeLifecycleStages" + description: The lifecycle stages where you configure scripts to run. + scriptCachingPolicy: + $ref: "#/components/schemas/ScriptCachingPolicy" + description: "The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values: CACHE_ONCE – Downloads each script once and reuses it on subsequent boots. REFRESH_ON_REBOOT – Downloads each script on every boot." + required: + - stages + NodeLifecycleStages: + description: The stages of a compute node's lifecycle where you can configure scripts to run. + type: object + properties: + nodeBootstrapped: + $ref: "#/components/schemas/NodeLifecycleScriptList" + description: The scripts to run after PCS finishes setting up the compute node and before the Slurm daemon (slurmd) starts. Use this stage for tasks that must complete before the node accepts jobs, such as mounting shared storage, configuring networking, or installing software packages. + nodeReady: + $ref: "#/components/schemas/NodeLifecycleScriptList" + description: The scripts to run after the Slurm daemon (slurmd) starts and the compute node registers with the Slurm controller. Use this stage for tasks that require Slurm to be running, such as running Slurm commands. + NodeLifecycleScriptList: + type: array + items: + $ref: "#/components/schemas/NodeLifecycleScript" + NodeLifecycleScript: + description: A script to run during a compute node lifecycle stage. + type: object + properties: + name: + $ref: "#/components/schemas/NodeLifecycleScriptNameString" + description: A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_), and hyphens (-). The first character must be a letter or a number. + scriptSource: + $ref: "#/components/schemas/ScriptSource" + description: The source location and integrity information for the script. + arguments: + $ref: "#/components/schemas/NodeLifecycleScriptArguments" + description: The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long. + onError: + $ref: "#/components/schemas/OnError" + description: "The behavior when the script fails. The default value is TERMINATE. Valid values: TERMINATE – Terminates the compute node. STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node. CONTINUE – Ignores the error and continues running the next script." + executionPolicy: + $ref: "#/components/schemas/ExecutionPolicy" + description: "The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values: FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots. EVERY_BOOT – Runs the script every time the compute node boots, including reboots." + required: + - name + - scriptSource + NodeLifecycleScriptNameString: + type: string + minLength: 1 + maxLength: 64 + pattern: "[A-Za-z0-9][A-Za-z0-9 _-]*" + ScriptSource: + description: The source location and integrity information for a node lifecycle script. + type: object + properties: + scriptLocation: + $ref: "#/components/schemas/ScriptSourceScriptLocationString" + description: The location of the script. Specify either an Amazon S3 URI in the format s3://bucket-name/key or an HTTPS URL. + s3VersionId: + $ref: "#/components/schemas/ScriptSourceS3VersionIdString" + description: The Amazon S3 version ID of the script. Use this value to pin the script to a specific version in a versioned Amazon S3 bucket. This value is only valid when scriptLocation is an Amazon S3 URI. + checksum: + $ref: "#/components/schemas/ScriptSourceChecksumString" + description: The SHA-256 checksum of the script content, as a 64-character hexadecimal string. This value is optional. When specified, PCS uses this value to verify the integrity of the downloaded script. + required: + - scriptLocation + ScriptSourceScriptLocationString: + type: string + minLength: 1 + maxLength: 1024 + pattern: (s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+|https://([a-zA-Z0-9](?:[a-zA-Z0-9_-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,63}(?::[0-9]{1,5})?(?:[/?#][^\s]*)?) + ScriptSourceS3VersionIdString: + type: string + minLength: 0 + maxLength: 1024 + ScriptSourceChecksumString: + type: string + minLength: 64 + maxLength: 64 + pattern: "[a-fA-F0-9]{64}" + NodeLifecycleScriptArguments: + type: array + items: + $ref: "#/components/schemas/NodeLifecycleScriptArgument" + NodeLifecycleScriptArgument: + type: string + minLength: 0 + maxLength: 256 + OnError: + description: "The behavior when a node lifecycle script fails. Valid values: TERMINATE – Terminates the compute node. STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node. CONTINUE – Ignores the error and continues running the next script." + type: string + enum: + - TERMINATE + - STOP_SEQUENCE + - CONTINUE + ExecutionPolicy: + description: "The policy that determines when a node lifecycle script runs. Valid values: FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots. EVERY_BOOT – Runs the script every time the compute node boots, including reboots." + type: string + enum: + - FIRST_BOOT_ONLY + - EVERY_BOOT + ScriptCachingPolicy: + description: "The caching policy for a node lifecycle script. Valid values: CACHE_ONCE – Downloads the script once and reuses it on subsequent boots. REFRESH_ON_REBOOT – Downloads the script on every boot." + type: string + enum: + - CACHE_ONCE + - REFRESH_ON_REBOOT CreateComputeNodeGroupResponse: type: object properties: @@ -1420,6 +1545,9 @@ components: $ref: "#/components/schemas/SpotOptions" slurmConfiguration: $ref: "#/components/schemas/ComputeNodeGroupSlurmConfiguration" + nodeLifecycleActions: + $ref: "#/components/schemas/NodeLifecycleActions" + description: The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs. errorInfo: $ref: "#/components/schemas/ErrorInfoList" description: The list of errors that occurred during compute node group provisioning. @@ -1473,9 +1601,28 @@ components: description: Additional options related to the Slurm scheduler. type: object properties: + scaleDownIdleTimeInSeconds: + $ref: "#/components/schemas/ComputeNodeGroupSlurmConfigurationScaleDownIdleTimeInSecondsInteger" + description: The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later. slurmCustomSettings: $ref: "#/components/schemas/SlurmCustomSettings" description: Additional Slurm-specific configuration that directly maps to Slurm settings. + ComputeNodeGroupSlurmConfigurationScaleDownIdleTimeInSecondsInteger: + type: integer + minimum: -1 + maximum: 10000000 + NodeLifecycleActions: + description: The lifecycle actions configured on a compute node group. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle. + type: object + properties: + stages: + $ref: "#/components/schemas/NodeLifecycleStages" + description: The lifecycle stages where you configure scripts to run. + scriptCachingPolicy: + $ref: "#/components/schemas/ScriptCachingPolicy" + description: "The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values: CACHE_ONCE – Downloads each script once and reuses it on subsequent boots. REFRESH_ON_REBOOT – Downloads each script on every boot." + required: + - stages QueueName: type: string minLength: 3 @@ -1768,6 +1915,18 @@ components: endpoints: $ref: "#/components/schemas/Endpoints" description: The list of endpoints available for interaction with the scheduler. + clusterName: + $ref: "#/components/schemas/String" + description: The name of the cluster that the compute node registered into. + computeNodeGroupId: + $ref: "#/components/schemas/String" + description: The ID of the compute node group that the compute node registered into. + computeNodeGroupName: + $ref: "#/components/schemas/String" + description: The name of the compute node group that the compute node registered into. + nodeLifecycleActions: + $ref: "#/components/schemas/NodeLifecycleActions" + description: The node lifecycle actions configured for the node group, including scripts to run when a compute node finishes bootstrapping or becomes ready to accept jobs. required: - nodeID - sharedSecret @@ -1833,6 +1992,15 @@ components: mode: $ref: "#/components/schemas/SlurmRestMode" description: The default value for mode is NONE. A value of STANDARD means the Slurm REST API is enabled. + UpdateSchedulerRequest: + description: The scheduler configuration for updating a cluster. Use this to specify the scheduler version to update to. + type: object + properties: + version: + $ref: "#/components/schemas/String" + description: "The scheduler version to update the cluster to. You can only update to a newer version. For more information about supported versions and update paths, see Updating the scheduler version on a cluster in the PCS User Guide. Valid Values: 24.05 | 24.11 | 25.05 | 25.11" + required: + - version UpdateClusterResponse: type: object properties: @@ -1842,9 +2010,28 @@ components: description: Additional options related to the Slurm scheduler. type: object properties: + scaleDownIdleTimeInSeconds: + $ref: "#/components/schemas/UpdateComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger" + description: The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later. slurmCustomSettings: $ref: "#/components/schemas/SlurmCustomSettings" description: Additional Slurm-specific configuration that directly maps to Slurm settings. + UpdateComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger: + type: integer + minimum: -1 + maximum: 10000000 + UpdateNodeLifecycleActionsRequest: + description: The lifecycle actions to configure on a compute node group when you update it. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle. + type: object + properties: + stages: + $ref: "#/components/schemas/NodeLifecycleStages" + description: The lifecycle stages where you configure scripts to run. + scriptCachingPolicy: + $ref: "#/components/schemas/ScriptCachingPolicy" + description: "The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values: CACHE_ONCE – Downloads each script once and reuses it on subsequent boots. REFRESH_ON_REBOOT – Downloads each script on every boot." + required: + - stages UpdateComputeNodeGroupResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/pi.yaml b/providers/src/aws/v00.00.00000/services/pi.yaml index 73fa144e..427d5abb 100644 --- a/providers/src/aws/v00.00.00000/services/pi.yaml +++ b/providers/src/aws/v00.00.00000/services/pi.yaml @@ -58,7 +58,6 @@ paths: - ServiceType - Identifier - StartTime - - EndTime responses: "200": description: Success @@ -466,6 +465,56 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAvailableResourceMetricsResponse" + /ListPerformanceAnalysisReportRecommendations: + post: + operationId: ListPerformanceAnalysisReportRecommendations + description: Retrieves recommendations for a performance analysis report. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PerformanceInsightsv20180227.ListPerformanceAnalysisReportRecommendations + default: PerformanceInsightsv20180227.ListPerformanceAnalysisReportRecommendations + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + ServiceType: + $ref: "#/components/schemas/ServiceType" + description: The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS. + Identifier: + $ref: "#/components/schemas/IdentifierString" + description: An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + AnalysisReportId: + $ref: "#/components/schemas/AnalysisReportId" + description: A unique identifier of the created analysis report. For example, report-12345678901234567 + RecommendationIds: + $ref: "#/components/schemas/RecommendationIdList" + description: A list of recommendation identifiers to filter the results. + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved. + NextToken: + $ref: "#/components/schemas/NextToken" + description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults. + required: + - ServiceType + - Identifier + - AnalysisReportId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListPerformanceAnalysisReportRecommendationsResponse" /ListPerformanceAnalysisReports: post: operationId: ListPerformanceAnalysisReports @@ -1003,6 +1052,9 @@ components: RecommendationDescription: $ref: "#/components/schemas/MarkdownString" description: "The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id" + RecommendationDetails: + $ref: "#/components/schemas/MarkdownString" + description: Detailed information about the recommendation, including steps to resolve the performance issue. DataList: type: array items: @@ -1233,6 +1285,19 @@ components: type: string minLength: 1 maxLength: 2048 + RecommendationIdList: + type: array + items: + $ref: "#/components/schemas/String" + ListPerformanceAnalysisReportRecommendationsResponse: + type: object + properties: + Recommendations: + $ref: "#/components/schemas/RecommendationList" + description: The list of recommendations for the analysis report. + NextToken: + $ref: "#/components/schemas/NextToken" + description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults. Boolean: type: boolean ListPerformanceAnalysisReportsResponse: @@ -1501,6 +1566,38 @@ components: insert: [] update: [] delete: [] + performance_analysis_report_recommendations: + id: aws.pi.performance_analysis_report_recommendations + name: performance_analysis_report_recommendations + title: performance_analysis_report_recommendations + methods: + list_performance_analysis_report_recommendations: + operation: + $ref: "#/paths/~1ListPerformanceAnalysisReportRecommendations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Recommendations + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/performance_analysis_report_recommendations/methods/list_performance_analysis_report_recommendations" + insert: [] + update: [] + delete: [] tags: id: aws.pi.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/pinpoint_sms_voice_v2.yaml b/providers/src/aws/v00.00.00000/services/pinpoint_sms_voice_v2.yaml index de703cdd..08b62888 100644 --- a/providers/src/aws/v00.00.00000/services/pinpoint_sms_voice_v2.yaml +++ b/providers/src/aws/v00.00.00000/services/pinpoint_sms_voice_v2.yaml @@ -1130,6 +1130,33 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteRcsAgentResult" + /DeleteRcsMessageSpendLimitOverride: + post: + operationId: DeleteRcsMessageSpendLimitOverride + description: Deletes an account-level monthly spending limit override for sending RCS messages. Deleting a spend limit override sets the EnforcedLimit to equal the MaxLimit, which is set by Amazon Web Services. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PinpointSMSVoiceV2.DeleteRcsMessageSpendLimitOverride + default: PinpointSMSVoiceV2.DeleteRcsMessageSpendLimitOverride + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteRcsMessageSpendLimitOverrideResult" /DeleteRegistration: post: operationId: DeleteRegistration @@ -3094,7 +3121,7 @@ paths: properties: SenderId: $ref: "#/components/schemas/SenderId" - description: The sender ID string to request. + description: The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen. IsoCountryCode: $ref: "#/components/schemas/IsoCountryCode" description: The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. @@ -3357,6 +3384,73 @@ paths: application/json: schema: $ref: "#/components/schemas/SendNotifyVoiceMessageResult" + /SendRcsMessage: + post: + operationId: SendRcsMessage + description: Creates a new RCS message and sends it to a recipient's phone number. RCS messages support rich content including text, files, rich cards, and carousels with interactive suggested actions. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PinpointSMSVoiceV2.SendRcsMessage + default: PinpointSMSVoiceV2.SendRcsMessage + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + DestinationPhoneNumber: + $ref: "#/components/schemas/PhoneNumber" + description: The destination phone number in E.164 format. + OriginationIdentity: + $ref: "#/components/schemas/RcsMessageOriginationIdentity" + description: The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn. + RcsMessageContent: + $ref: "#/components/schemas/RcsMessageContent" + description: The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions. + TimeToLive: + $ref: "#/components/schemas/RcsTimeToLive" + description: The duration in seconds that the RCS message is valid for delivery. If the message cannot be delivered within this duration, it is considered expired. Valid values are 1 to 172800 (48 hours). If a FallbackConfiguration is provided, the fallback is triggered when the duration expires without delivery confirmation. + MessageTrafficType: + $ref: "#/components/schemas/RcsMessageTrafficType" + description: The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use. + FallbackConfiguration: + $ref: "#/components/schemas/RcsFallbackConfiguration" + description: Configuration for SMS or MMS fallback when RCS delivery fails. If provided, the service sends a fallback message via the specified channel when the RCS message fails or the TimeToLive expires. + ProtectConfigurationId: + $ref: "#/components/schemas/ProtectConfigurationIdOrArn" + description: The unique identifier of the protect configuration to use. + ConfigurationSetName: + $ref: "#/components/schemas/ConfigurationSetNameOrArn" + description: The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. + MaxPrice: + $ref: "#/components/schemas/MaxPrice" + description: The maximum amount that you want to spend, in US dollars, per each RCS message. + DryRun: + $ref: "#/components/schemas/PrimitiveBoolean" + description: When set to true, the message is checked and validated, but isn't sent to the end recipient. + Context: + $ref: "#/components/schemas/ContextMap" + description: You can specify custom data in this field. If you do, that data is logged to the event destination. + MessageFeedbackEnabled: + $ref: "#/components/schemas/Boolean" + description: Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback. + required: + - DestinationPhoneNumber + - OriginationIdentity + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SendRcsMessageResult" /SendTextMessage: post: operationId: SendTextMessage @@ -3383,7 +3477,7 @@ paths: description: The destination phone number in E.164 format. OriginationIdentity: $ref: "#/components/schemas/TextMessageOriginationIdentity" - description: The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn. If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN). + description: The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, RcsAgentId, RcsAgentArn, SenderId, SenderIdArn, PoolId, or PoolArn. If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN). MessageBody: $ref: "#/components/schemas/TextMessageBody" description: The body of the text message. @@ -3703,6 +3797,39 @@ paths: application/json: schema: $ref: "#/components/schemas/SetNotifyMessageSpendLimitOverrideResult" + /SetRcsMessageSpendLimitOverride: + post: + operationId: SetRcsMessageSpendLimitOverride + description: Sets an account level monthly spend limit override for sending RCS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - PinpointSMSVoiceV2.SetRcsMessageSpendLimitOverride + default: PinpointSMSVoiceV2.SetRcsMessageSpendLimitOverride + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + MonthlyLimit: + $ref: "#/components/schemas/MonthlyLimit" + description: The new monthly limit to enforce on RCS message spending. + required: + - MonthlyLimit + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SetRcsMessageSpendLimitOverrideResult" /SetTextMessageSpendLimitOverride: post: operationId: SetTextMessageSpendLimitOverride @@ -3956,10 +4083,10 @@ paths: description: The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation. DefaultTemplateId: $ref: "#/components/schemas/NotifyTemplateId" - description: The template ID to set as the default, or the special value UNSET_DEFAULT_TEMPLATE to clear the current default template. + description: The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier. Pass the special value UNSET_DEFAULT_TEMPLATE to clear the current default template from the notify configuration. PoolId: $ref: "#/components/schemas/NotifyPoolIdOrUnset" - description: The pool ID or ARN to associate, or the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool. + description: The pool identifier or Amazon Resource Name (ARN) to associate with the notify configuration. Pass the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool from the notify configuration. EnabledCountries: $ref: "#/components/schemas/IsoCountryCodeList" description: An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration. @@ -4205,6 +4332,18 @@ paths: TwoWayEnabled: $ref: "#/components/schemas/Boolean" description: By default this is set to false. When set to true you can receive incoming text messages from your end recipients. + TwoWayMediaS3BucketName: + $ref: "#/components/schemas/TwoWayMediaS3BucketNameOrUnset" + description: The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role. + TwoWayMediaS3KeyPrefix: + $ref: "#/components/schemas/TwoWayMediaS3KeyPrefix" + description: The key prefix used for inbound RCS media objects in the S3 bucket. + TwoWayMediaS3Role: + $ref: "#/components/schemas/IamRoleArnOrUnset" + description: The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName. + TwoWayRcsEventsEnabled: + $ref: "#/components/schemas/RcsEventTypeList" + description: The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used. required: - RcsAgentId responses: @@ -4583,6 +4722,15 @@ components: - MEDIA_FILE_INACCESSIBLE - MEDIA_FILE_TYPE_UNSUPPORTED - MEDIA_FILE_SIZE_EXCEEDED + - RCS_ALL + - RCS_QUEUED + - RCS_SENT + - RCS_DELIVERED + - RCS_READ + - RCS_FAILED + - RCS_TTL_EXPIRED + - RCS_PROTECT_BLOCKED + - RCS_FALLEN_BACK_TO_SMS CloudWatchLogsDestination: description: Contains the destination configuration to use when publishing message sending events. type: object @@ -4945,6 +5093,18 @@ components: TwoWayEnabled: $ref: "#/components/schemas/PrimitiveBoolean" description: By default this is set to false. When set to true you can receive incoming text messages from your end recipients. + TwoWayMediaS3BucketName: + $ref: "#/components/schemas/TwoWayMediaS3BucketName" + description: The name of the S3 bucket where inbound RCS media files are stored. + TwoWayMediaS3KeyPrefix: + $ref: "#/components/schemas/TwoWayMediaS3KeyPrefix" + description: The key prefix used for inbound RCS media objects in the S3 bucket. + TwoWayMediaS3Role: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. + TwoWayRcsEventsEnabled: + $ref: "#/components/schemas/RcsEventTypeList" + description: The list of RCS event types enabled for two-way messaging on the agent. Tags: $ref: "#/components/schemas/TagList" description: An array of tags (key and value pairs) associated with the RCS agent. @@ -4966,6 +5126,25 @@ components: - PARTIAL - ACTIVE - DELETED + TwoWayMediaS3BucketName: + type: string + minLength: 3 + maxLength: 63 + pattern: "[a-z0-9][a-z0-9.-]*[a-z0-9]" + TwoWayMediaS3KeyPrefix: + type: string + minLength: 1 + maxLength: 1024 + pattern: "[\\S]+" + RcsEventTypeList: + type: array + items: + $ref: "#/components/schemas/RcsEventType" + RcsEventType: + description: RCS event type identifier. Validated at the service layer. + type: string + minLength: 1 + maxLength: 50 RegistrationType: type: string minLength: 1 @@ -5584,6 +5763,9 @@ components: TwoWayEnabled: $ref: "#/components/schemas/PrimitiveBoolean" description: By default this is set to false. When set to true you can receive incoming text messages from your end recipients. + TwoWayRcsEventsEnabled: + $ref: "#/components/schemas/RcsEventTypeList" + description: The list of RCS event types that were enabled for two-way messaging on the deleted agent. required: - RcsAgentArn - RcsAgentId @@ -5592,6 +5774,12 @@ components: - DeletionProtectionEnabled - SelfManagedOptOutsEnabled - TwoWayEnabled + DeleteRcsMessageSpendLimitOverrideResult: + type: object + properties: + MonthlyLimit: + $ref: "#/components/schemas/MonthlyLimit" + description: The current monthly limit to enforce on RCS message spending. DeleteRegistrationResult: type: object properties: @@ -6873,6 +7061,18 @@ components: PoolId: $ref: "#/components/schemas/String" description: The unique identifier of the pool associated with the RCS agent. + TwoWayMediaS3BucketName: + $ref: "#/components/schemas/TwoWayMediaS3BucketName" + description: The name of the S3 bucket where inbound RCS media files are stored. + TwoWayMediaS3KeyPrefix: + $ref: "#/components/schemas/TwoWayMediaS3KeyPrefix" + description: The key prefix used for inbound RCS media objects in the S3 bucket. + TwoWayMediaS3Role: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. + TwoWayRcsEventsEnabled: + $ref: "#/components/schemas/RcsEventTypeList" + description: The list of RCS event types enabled for two-way messaging on the agent. TestingAgent: $ref: "#/components/schemas/TestingAgentInformation" description: The testing agent information associated with the RCS agent. @@ -7676,6 +7876,7 @@ components: - VOICE_MESSAGE_MONTHLY_SPEND_LIMIT - MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT - NOTIFY_MESSAGE_MONTHLY_SPEND_LIMIT + - RCS_MESSAGE_MONTHLY_SPEND_LIMIT VerifiedDestinationNumberIdList: type: array items: @@ -8530,6 +8731,439 @@ components: ResolvedMessageBody: $ref: "#/components/schemas/String" description: The message body after template variable substitution has been applied. + RcsMessageOriginationIdentity: + type: string + minLength: 1 + maxLength: 256 + pattern: "[A-Za-z0-9_:/\\+-]+" + RcsMessageContent: + description: The content of an RCS message, containing the message body (text, file, rich card, or carousel) and optional message-level suggested actions. + type: object + properties: + Content: + $ref: "#/components/schemas/RcsContent" + description: "The content of the RCS message. Exactly one content type must be specified: TextMessage, FileMessage, RichCard, or Carousel." + Suggestions: + $ref: "#/components/schemas/RcsSuggestedActionList" + description: Message-level suggested actions displayed to the recipient. Maximum 11 suggestions per message. + required: + - Content + RcsContent: + description: The message body of an RCS message. Exactly one content type must be specified. + type: object + properties: + TextMessage: + $ref: "#/components/schemas/RcsTextMessage" + description: A plain text RCS message. + FileMessage: + $ref: "#/components/schemas/RcsFileMessage" + description: A file message containing a media file (image, video, audio, or PDF) with an optional thumbnail. + RichCard: + $ref: "#/components/schemas/RcsStandaloneCard" + description: A standalone rich card with media, title, description, and suggested actions. + Carousel: + $ref: "#/components/schemas/RcsCarousel" + description: A carousel of 2 to 10 scrollable cards, each with media, title, description, and suggested actions. + RcsTextMessage: + description: A plain text RCS message body. + type: object + properties: + Body: + $ref: "#/components/schemas/RcsTextBody" + description: The text body of the RCS message. Maximum 3072 characters. + required: + - Body + RcsTextBody: + type: string + minLength: 1 + maxLength: 3072 + pattern: (?!\s*$)[\s\S]+ + RcsFileMessage: + description: A file message containing a media file (image, video, audio, or PDF) with an optional thumbnail. + type: object + properties: + FileUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of the media file to send, in the format s3://bucket-name/key. The service downloads the file from your S3 bucket, rehosts it, and generates a presigned URL for the aggregator. Maximum 2000 characters. + ThumbnailUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of an optional thumbnail image for the media file, in the format s3://bucket-name/key. Maximum 2000 characters. + required: + - FileUrl + RcsMediaUrl: + type: string + minLength: 1 + maxLength: 2000 + pattern: (https://|s3://).+ + RcsStandaloneCard: + description: A standalone rich card with media, title, description, and suggested actions. + type: object + properties: + CardOrientation: + $ref: "#/components/schemas/RcsStandaloneCardCardOrientationString" + description: The orientation of the rich card. Valid values are HORIZONTAL and VERTICAL. + ThumbnailImageAlignment: + $ref: "#/components/schemas/RcsStandaloneCardThumbnailImageAlignmentString" + description: The alignment of the thumbnail image in a horizontal card. Valid values are LEFT and RIGHT. Only applicable when CardOrientation is HORIZONTAL. + CardContent: + $ref: "#/components/schemas/RcsCardContent" + description: The content of the rich card, including title, description, media, and card-level suggested actions. + required: + - CardOrientation + - CardContent + RcsStandaloneCardCardOrientationString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsStandaloneCardThumbnailImageAlignmentString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsCardContent: + description: The content of a rich card, including title, description, media, and card-level suggested actions. + type: object + properties: + Title: + $ref: "#/components/schemas/RcsCardTitle" + description: The title of the card. Maximum 200 characters. + Description: + $ref: "#/components/schemas/RcsCardDescription" + description: The description text of the card. Maximum 2000 characters. + Media: + $ref: "#/components/schemas/RcsCardMedia" + description: The media content of the card, including the file URL, optional thumbnail, and display height. + Suggestions: + $ref: "#/components/schemas/RcsCardSuggestedActionList" + description: Card-level suggested actions. Maximum 4 suggestions per card. + RcsCardTitle: + type: string + minLength: 1 + maxLength: 200 + RcsCardDescription: + type: string + minLength: 1 + maxLength: 2000 + RcsCardMedia: + description: The media content of a rich card, including the file URL, optional thumbnail, and display height. + type: object + properties: + FileUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of the media file for the card, in the format s3://bucket-name/key. Maximum 2000 characters. + ThumbnailUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of an optional thumbnail image for the card media. Maximum 2000 characters. + Height: + $ref: "#/components/schemas/RcsCardMediaHeightString" + description: The display height of the media in the card. Valid values are SHORT, MEDIUM, and TALL. + required: + - FileUrl + RcsCardMediaHeightString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsCardSuggestedActionList: + type: array + items: + $ref: "#/components/schemas/RcsSuggestedAction" + RcsSuggestedAction: + description: A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event. + type: object + properties: + Reply: + $ref: "#/components/schemas/RcsReplyAction" + description: A suggested reply that sends predefined text and postback data when tapped. + OpenUrl: + $ref: "#/components/schemas/RcsOpenUrlAction" + description: A suggested action that opens a URL in the user's browser or a webview. + DialPhone: + $ref: "#/components/schemas/RcsDialPhoneAction" + description: A suggested action that initiates a phone call to the specified number. + ShowLocation: + $ref: "#/components/schemas/RcsShowLocationAction" + description: A suggested action that shows a location on a map. + RequestLocation: + $ref: "#/components/schemas/RcsRequestLocationAction" + description: A suggested action that requests the user's current location. + CreateCalendarEvent: + $ref: "#/components/schemas/RcsCreateCalendarEventAction" + description: A suggested action that creates a calendar event on the user's device. + RcsReplyAction: + description: A suggested reply action that sends predefined text and postback data when tapped by the recipient. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the suggested reply. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this reply. Maximum 2048 characters. + required: + - Text + - PostbackData + RcsSuggestedActionText: + type: string + minLength: 1 + maxLength: 25 + RcsPostbackData: + type: string + minLength: 1 + maxLength: 2048 + RcsOpenUrlAction: + description: A suggested action that opens a URL in the recipient's browser or an in-app webview. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the action. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this action. Maximum 2048 characters. + Url: + $ref: "#/components/schemas/RcsOpenUrlValue" + description: The URL to open. Must start with https://. Maximum 2048 characters. + Application: + $ref: "#/components/schemas/RcsOpenUrlActionApplicationString" + description: How to open the URL. BROWSER opens in the device's default browser. WEBVIEW opens in an in-app webview. + WebviewViewMode: + $ref: "#/components/schemas/RcsOpenUrlActionWebviewViewModeString" + description: The display mode of the webview. Valid values are FULL, HALF, and TALL. Only applicable when Application is WEBVIEW. + required: + - Text + - PostbackData + - Url + RcsOpenUrlValue: + type: string + minLength: 1 + maxLength: 2048 + pattern: https://\S+ + RcsOpenUrlActionApplicationString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsOpenUrlActionWebviewViewModeString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsDialPhoneAction: + description: A suggested action that initiates a phone call to a specified number when tapped by the recipient. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the action. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this action. Maximum 2048 characters. + PhoneNumber: + $ref: "#/components/schemas/PhoneNumber" + description: The phone number to dial in E.164 format. + required: + - Text + - PostbackData + - PhoneNumber + RcsShowLocationAction: + description: A suggested action that shows a location on a map when tapped by the recipient. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the action. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this action. Maximum 2048 characters. + Latitude: + $ref: "#/components/schemas/RcsShowLocationActionLatitudeDouble" + description: The latitude of the location. Valid values are -90 to 90. + Longitude: + $ref: "#/components/schemas/RcsShowLocationActionLongitudeDouble" + description: The longitude of the location. Valid values are -180 to 180. + Label: + $ref: "#/components/schemas/RcsLocationLabel" + description: An optional label for the location pin. Maximum 100 characters. + required: + - Text + - PostbackData + - Latitude + - Longitude + RcsShowLocationActionLatitudeDouble: + type: number + format: double + minimum: -90 + maximum: 90 + RcsShowLocationActionLongitudeDouble: + type: number + format: double + minimum: -180 + maximum: 180 + RcsLocationLabel: + type: string + minLength: 1 + maxLength: 100 + RcsRequestLocationAction: + description: A suggested action that requests the recipient's current location. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the action. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this action. Maximum 2048 characters. + required: + - Text + - PostbackData + RcsCreateCalendarEventAction: + description: A suggested action that creates a calendar event on the recipient's device. + type: object + properties: + Text: + $ref: "#/components/schemas/RcsSuggestedActionText" + description: The display text of the action. Maximum 25 characters. + PostbackData: + $ref: "#/components/schemas/RcsPostbackData" + description: The postback data sent to your webhook when the user taps this action. Maximum 2048 characters. + Title: + $ref: "#/components/schemas/RcsCalendarEventTitle" + description: The title of the calendar event. Maximum 100 characters. + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The start time of the calendar event in ISO 8601 format. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The end time of the calendar event in ISO 8601 format. + Description: + $ref: "#/components/schemas/RcsCalendarEventDescription" + description: An optional description for the calendar event. Maximum 500 characters. + required: + - Text + - PostbackData + - Title + - StartTime + - EndTime + RcsCalendarEventTitle: + type: string + minLength: 1 + maxLength: 100 + RcsCalendarEventDescription: + type: string + minLength: 1 + maxLength: 500 + RcsCarousel: + description: A carousel of 2 to 10 scrollable rich cards. + type: object + properties: + CardWidth: + $ref: "#/components/schemas/RcsCarouselCardWidthString" + description: The width of cards in the carousel. Valid values are SMALL and MEDIUM. + CardContents: + $ref: "#/components/schemas/RcsCarouselCardContentList" + description: The list of cards in the carousel. Minimum 2, maximum 10 cards. + required: + - CardWidth + - CardContents + RcsCarouselCardWidthString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsCarouselCardContentList: + type: array + items: + $ref: "#/components/schemas/RcsCarouselCardContent" + RcsCarouselCardContent: + description: The content of a carousel card, including title, description, media, and card-level suggested actions. Media height is restricted to SHORT or MEDIUM. + type: object + properties: + Title: + $ref: "#/components/schemas/RcsCardTitle" + description: The title of the carousel card. Maximum 200 characters. + Description: + $ref: "#/components/schemas/RcsCardDescription" + description: The description text of the carousel card. Maximum 2000 characters. + Media: + $ref: "#/components/schemas/RcsCarouselCardMedia" + description: The media content of the carousel card. Media height is restricted to SHORT or MEDIUM (TALL is not supported in carousels). + Suggestions: + $ref: "#/components/schemas/RcsCardSuggestedActionList" + description: Card-level suggested actions for this carousel card. Maximum 4 suggestions per card. + RcsCarouselCardMedia: + description: The media content of a carousel card. Display height is restricted to SHORT or MEDIUM (TALL is not supported in carousels). + type: object + properties: + FileUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of the media file for the carousel card. Maximum 2000 characters. + ThumbnailUrl: + $ref: "#/components/schemas/RcsMediaUrl" + description: The S3 URI of an optional thumbnail image for the carousel card media. Maximum 2000 characters. + Height: + $ref: "#/components/schemas/RcsCarouselCardMediaHeightString" + description: The display height of the media in the carousel card. Valid values are SHORT and MEDIUM. + required: + - FileUrl + RcsCarouselCardMediaHeightString: + type: string + minLength: 1 + maxLength: 50 + pattern: "[A-Z_]+" + RcsSuggestedActionList: + type: array + items: + $ref: "#/components/schemas/RcsSuggestedAction" + RcsTimeToLive: + type: integer + minimum: 1 + maximum: 172800 + RcsMessageTrafficType: + description: RCS message traffic type. Validated at the service layer. + type: string + minLength: 1 + maxLength: 50 + RcsFallbackConfiguration: + description: Configuration for SMS or MMS fallback when RCS delivery fails or the TimeToLive expires without delivery confirmation. + type: object + properties: + Channel: + $ref: "#/components/schemas/RcsFallbackChannel" + description: The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive. + MessageBody: + $ref: "#/components/schemas/RcsFallbackMessageBody" + description: The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided. + MediaUrls: + $ref: "#/components/schemas/MediaUrlList" + description: An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS. + OriginationIdentity: + $ref: "#/components/schemas/RcsFallbackOriginationIdentity" + description: The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool. + required: + - Channel + RcsFallbackChannel: + type: string + enum: + - SMS + - MMS + RcsFallbackMessageBody: + type: string + minLength: 1 + maxLength: 1600 + pattern: (?!\s*$)[\s\S]+ + RcsFallbackOriginationIdentity: + type: string + minLength: 1 + maxLength: 256 + pattern: "[A-Za-z0-9_:/\\+-]+" + SendRcsMessageResult: + type: object + properties: + MessageId: + $ref: "#/components/schemas/String" + description: The unique identifier for the message. TextMessageOriginationIdentity: type: string minLength: 1 @@ -8622,6 +9256,12 @@ components: MonthlyLimit: $ref: "#/components/schemas/MonthlyLimit" description: The current monthly limit, in US dollars. + SetRcsMessageSpendLimitOverrideResult: + type: object + properties: + MonthlyLimit: + $ref: "#/components/schemas/MonthlyLimit" + description: The current monthly limit to enforce on RCS message spending. SetTextMessageSpendLimitOverrideResult: type: object properties: @@ -8892,6 +9532,18 @@ components: - ProtectConfigurationId - NumberCapability - CountryRuleSet + TwoWayMediaS3BucketNameOrUnset: + description: S3 bucket name or UNSET_RCS_MEDIA_CONFIGURATION to clear media config. Pass UNSET_RCS_MEDIA_CONFIGURATION to clear the media configuration from an RCS agent. + type: string + minLength: 3 + maxLength: 63 + pattern: ([a-z0-9][a-z0-9.-]*[a-z0-9]|UNSET_RCS_MEDIA_CONFIGURATION) + IamRoleArnOrUnset: + description: IAM role ARN or UNSET_RCS_MEDIA_CONFIGURATION to clear media config. Pass UNSET_RCS_MEDIA_CONFIGURATION to clear the media configuration from an RCS agent. + type: string + minLength: 20 + maxLength: 2048 + pattern: (arn:\S+|UNSET_RCS_MEDIA_CONFIGURATION) UpdateRcsAgentResult: type: object properties: @@ -8925,6 +9577,18 @@ components: TwoWayEnabled: $ref: "#/components/schemas/PrimitiveBoolean" description: By default this is set to false. When set to true you can receive incoming text messages from your end recipients. + TwoWayMediaS3BucketName: + $ref: "#/components/schemas/TwoWayMediaS3BucketName" + description: The name of the S3 bucket where inbound RCS media files are stored. + TwoWayMediaS3KeyPrefix: + $ref: "#/components/schemas/TwoWayMediaS3KeyPrefix" + description: The key prefix used for inbound RCS media objects in the S3 bucket. + TwoWayMediaS3Role: + $ref: "#/components/schemas/IamRoleArn" + description: The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. + TwoWayRcsEventsEnabled: + $ref: "#/components/schemas/RcsEventTypeList" + description: The list of RCS event types enabled for two-way messaging on the agent. required: - RcsAgentArn - RcsAgentId @@ -10274,6 +10938,44 @@ components: - $ref: "#/components/x-stackQL-resources/protect_configuration_rule_set_number_overrides/methods/put_protect_configuration_rule_set_number_override" delete: - $ref: "#/components/x-stackQL-resources/protect_configuration_rule_set_number_overrides/methods/delete_protect_configuration_rule_set_number_override" + rcs_message_spend_limit_overrides: + id: aws.pinpoint_sms_voice_v2.rcs_message_spend_limit_overrides + name: rcs_message_spend_limit_overrides + title: rcs_message_spend_limit_overrides + methods: + delete_rcs_message_spend_limit_override: + operation: + $ref: "#/paths/~1DeleteRcsMessageSpendLimitOverride/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + set_rcs_message_spend_limit_override: + operation: + $ref: "#/paths/~1SetRcsMessageSpendLimitOverride/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/rcs_message_spend_limit_overrides/methods/set_rcs_message_spend_limit_override" + delete: + - $ref: "#/components/x-stackQL-resources/rcs_message_spend_limit_overrides/methods/delete_rcs_message_spend_limit_override" registration_field_values: id: aws.pinpoint_sms_voice_v2.registration_field_values name: registration_field_values diff --git a/providers/src/aws/v00.00.00000/services/pricing_plan_manager.yaml b/providers/src/aws/v00.00.00000/services/pricing_plan_manager.yaml new file mode 100644 index 00000000..02a091b9 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/pricing_plan_manager.yaml @@ -0,0 +1,697 @@ +openapi: 3.0.0 +info: + version: "2025-08-05" + title: PricingPlanManager + description: PricingPlanManager + x-serviceName: pricingplanmanager + x-serviceAlias: pricing_plan_manager + x-protocol: rest-json + x-apiVersion: "2025-08-05" + x-endpointPrefix: pricingplanmanager +servers: + - url: https://pricingplanmanager.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for pricing-plan-manager +paths: + /v1/ApprovePaidSubscription: + post: + operationId: ApprovePaidSubscription + description: Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing. This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are approving the expected version of the subscription. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ApprovePaidSubscriptionOutput" + /v1/AssociateResourcesToSubscription: + post: + operationId: AssociateResourcesToSubscription + description: Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes. For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + resourceArns: + $ref: "#/components/schemas/ResourceArns" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + - resourceArns + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AssociateResourcesToSubscriptionOutput" + /v1/CancelSubscription: + post: + operationId: CancelSubscription + description: Cancels a flat-rate pricing subscription. For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange. For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelSubscriptionOutput" + /v1/CancelSubscriptionChange: + post: + operationId: CancelSubscriptionChange + description: Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled. You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CancelSubscriptionChangeOutput" + /v1/CreateSubscription: + post: + operationId: CreateSubscription + description: Creates a flat-rate pricing subscription for the specified resources. When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode. When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + planFamily: + $ref: "#/components/schemas/String" + planTier: + $ref: "#/components/schemas/String" + usageLevel: + $ref: "#/components/schemas/String" + resourceArns: + $ref: "#/components/schemas/ResourceArns" + approvalMode: + $ref: "#/components/schemas/ApprovalMode" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - planFamily + - planTier + - resourceArns + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateSubscriptionOutput" + /v1/DisassociateResourcesFromSubscription: + post: + operationId: DisassociateResourcesFromSubscription + description: Removes one or more resources from an existing subscription. For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + resourceArns: + $ref: "#/components/schemas/ResourceArns" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + - resourceArns + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisassociateResourcesFromSubscriptionOutput" + /v1/GetSubscription: + post: + operationId: GetSubscription + description: Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + required: + - arn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSubscriptionOutput" + /v1/ListSubscriptions: + post: + operationId: ListSubscriptions + description: Returns a summary of all flat-rate pricing subscriptions in the calling account. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSubscriptionsOutput" + /v1/UpdateSubscription: + post: + operationId: UpdateSubscription + description: Changes the plan tier of an existing subscription. Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange. This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default. + parameters: + - name: If-Match + in: header + required: true + schema: + $ref: "#/components/schemas/String" + description: The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are updating the expected version of the subscription. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + planTier: + $ref: "#/components/schemas/String" + usageLevel: + $ref: "#/components/schemas/String" + clientToken: + $ref: "#/components/schemas/IdempotencyToken" + required: + - arn + - planTier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSubscriptionOutput" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + String: + type: string + SubscriptionArn: + description: The Amazon Resource Name (ARN) of a flat-rate pricing subscription. + type: string + minLength: 1 + maxLength: 2048 + IdempotencyToken: + description: A unique, case-sensitive identifier that you provide to ensure a request is handled only once. + type: string + minLength: 1 + maxLength: 64 + ApprovePaidSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the approved subscription. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + Subscription: + description: The full details of a flat-rate pricing subscription, including its current configuration, status, and associated resources. + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + description: The Amazon Resource Name (ARN) that uniquely identifies this subscription. + planFamily: + $ref: "#/components/schemas/String" + description: The pricing plan family for the subscription, such as CloudFront. + planTier: + $ref: "#/components/schemas/String" + description: The current tier level of the pricing plan, such as FREE, PRO, BUSINESS, or PREMIUM. + usageLevel: + $ref: "#/components/schemas/String" + description: The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier. + scheduledChange: + $ref: "#/components/schemas/ScheduledChange" + description: A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled. + status: + $ref: "#/components/schemas/Status" + description: The current status of the subscription. For the list of possible values, see the Status type. + statusReason: + $ref: "#/components/schemas/String" + description: A human-readable explanation of the current status, present when additional context is available. + resourceArns: + $ref: "#/components/schemas/ResourceArns" + description: The ARNs of the AWS resources covered by this subscription. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the subscription was created, in ISO 8601 format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the subscription was last modified, in ISO 8601 format. + required: + - arn + - planFamily + - planTier + - status + - resourceArns + - createdAt + - updatedAt + ScheduledChange: + description: A pending change on a subscription that takes effect at the end of the current billing period, such as a tier downgrade or cancellation. + type: object + properties: + changeType: + $ref: "#/components/schemas/ScheduledChangeType" + description: The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination). + effectiveDate: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system. + planTier: + $ref: "#/components/schemas/String" + description: For downgrades, the tier level that the subscription will change to. Not present for cancellations. + usageLevel: + $ref: "#/components/schemas/String" + description: For downgrades, the target usage level after the change takes effect. + required: + - changeType + ScheduledChangeType: + description: "The type of pending change on a subscription. Possible values: DOWNGRADE — The subscription tier is being lowered at the end of the billing period. CANCELLATION — The subscription is being terminated at the end of the billing period." + type: string + enum: + - DOWNGRADE + - CANCELLATION + SyntheticTimestamp_date_time: + type: string + format: date-time + Status: + description: "The status of a flat-rate pricing subscription. Possible values: PENDING_APPROVAL — The subscription was created with manual approval and is waiting for an ApprovePaidSubscription call. ACTIVE — The subscription is active and resources are covered by flat-rate pricing. SYNC_IN_PROGRESS — A change is being applied to the subscription. Wait for the operation to complete before making additional changes. FAILED — The subscription encountered an error. Check the statusReason field for details." + type: string + enum: + - PENDING_APPROVAL + - ACTIVE + - SYNC_IN_PROGRESS + - FAILED + ResourceArns: + description: A list of 1 to 10 AWS resource ARNs to include in the subscription. + type: array + items: + $ref: "#/components/schemas/String" + AssociateResourcesToSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the subscription with the newly added resources. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + CancelSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the subscription with the pending cancellation. For active subscriptions, a scheduledChange of type CANCELLATION is included. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + CancelSubscriptionChangeOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the subscription with the pending change removed. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + ApprovalMode: + description: Determines whether a subscription requires explicit approval before billing starts. + type: string + enum: + - MANUAL + - IMMEDIATE + CreateSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the newly created subscription. + eTag: + $ref: "#/components/schemas/String" + description: The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription. + required: + - subscription + - eTag + DisassociateResourcesFromSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the subscription with the specified resources removed. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + GetSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the requested subscription. + eTag: + $ref: "#/components/schemas/String" + description: The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription. + required: + - subscription + - eTag + ListSubscriptionsOutput: + type: object + properties: + subscriptionSummaries: + $ref: "#/components/schemas/SubscriptionSummaryList" + description: The list of subscription summaries for the calling account. + nextToken: + $ref: "#/components/schemas/String" + description: A token that indicates there are more results available. Pass this value in a subsequent ListSubscriptions request to retrieve the next page of results. + required: + - subscriptionSummaries + SubscriptionSummaryList: + type: array + items: + $ref: "#/components/schemas/SubscriptionSummary" + SubscriptionSummary: + description: Summary information for a flat-rate pricing subscription, as returned by list operations. + type: object + properties: + arn: + $ref: "#/components/schemas/SubscriptionArn" + description: The Amazon Resource Name (ARN) that uniquely identifies this subscription. + planFamily: + $ref: "#/components/schemas/String" + description: The pricing plan family for the subscription, such as CloudFront. + planTier: + $ref: "#/components/schemas/String" + description: The current tier level of the pricing plan. + usageLevel: + $ref: "#/components/schemas/String" + description: The usage level within the plan tier. + scheduledChange: + $ref: "#/components/schemas/ScheduledChange" + description: A pending change that will take effect at the end of the current billing period, if any. + status: + $ref: "#/components/schemas/Status" + description: The current status of the subscription. + statusReason: + $ref: "#/components/schemas/String" + description: A human-readable explanation of the current status, present when additional context is available. + resourceArns: + $ref: "#/components/schemas/ResourceArns" + description: The ARNs of the AWS resources covered by this subscription. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the subscription was created, in ISO 8601 format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time when the subscription was last modified, in ISO 8601 format. + eTag: + $ref: "#/components/schemas/String" + description: The entity tag for concurrency control. Pass this value in the If-Match header when making changes to this subscription. + required: + - arn + - planFamily + - planTier + - status + - resourceArns + - createdAt + - updatedAt + - eTag + UpdateSubscriptionOutput: + type: object + properties: + subscription: + $ref: "#/components/schemas/Subscription" + description: The details of the updated subscription. For downgrades, the current tier remains unchanged and a scheduledChange indicates the pending change. + eTag: + $ref: "#/components/schemas/String" + description: The updated entity tag for concurrency control. + required: + - subscription + - eTag + x-stackQL-resources: + subscriptions: + id: aws.pricing_plan_manager.subscriptions + name: subscriptions + title: subscriptions + methods: + associate_resources_to_subscription: + operation: + $ref: "#/paths/~1v1~1AssociateResourcesToSubscription/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + cancel_subscription_change: + operation: + $ref: "#/paths/~1v1~1CancelSubscriptionChange/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_subscription: + operation: + $ref: "#/paths/~1v1~1CreateSubscription/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + disassociate_resources_from_subscription: + operation: + $ref: "#/paths/~1v1~1DisassociateResourcesFromSubscription/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_subscription: + operation: + $ref: "#/paths/~1v1~1GetSubscription/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_subscriptions: + operation: + $ref: "#/paths/~1v1~1ListSubscriptions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.subscriptionSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_subscription: + operation: + $ref: "#/paths/~1v1~1UpdateSubscription/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/get_subscription" + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/list_subscriptions" + insert: + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/create_subscription" + update: + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/associate_resources_to_subscription" + - $ref: "#/components/x-stackQL-resources/subscriptions/methods/update_subscription" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/qconnect.yaml b/providers/src/aws/v00.00.00000/services/qconnect.yaml index edf33e36..fb6948c6 100644 --- a/providers/src/aws/v00.00.00000/services/qconnect.yaml +++ b/providers/src/aws/v00.00.00000/services/qconnect.yaml @@ -8119,6 +8119,9 @@ components: timeToFirstTokenMs: $ref: "#/components/schemas/Integer" description: Time to first token in milliseconds, measured from when Amazon Bedrock was invoked to when the first token was returned + guardrailAssessments: + $ref: "#/components/schemas/SpanGuardrailAssessmentList" + description: Guardrail assessments for the inference span. Absent on other span types and when no AI Guardrail is attached to the AI Agent. Integer: type: integer SpanAttributesTemperatureFloat: @@ -8256,6 +8259,77 @@ components: description: The reasoning text content required: - value + SpanGuardrailAssessmentList: + type: array + items: + $ref: "#/components/schemas/SpanGuardrailAssessment" + SpanGuardrailAssessment: + description: Result of a single guardrail assessment, covering either the input (customer/user message) or the output (LLM response) of a Bedrock Converse call. + type: object + properties: + guardrailId: + $ref: "#/components/schemas/NonEmptyString" + description: Unique AI Guardrail identifier. + guardrailName: + $ref: "#/components/schemas/NonEmptyString" + description: Customer-defined display name of the AI Guardrail resource. + source: + $ref: "#/components/schemas/GuardrailSource" + description: Content source the guardrail was evaluated against. + action: + $ref: "#/components/schemas/GuardrailAction" + description: Outcome of the guardrail assessment. + policies: + $ref: "#/components/schemas/GuardrailPolicyResultList" + description: Per-policy assessment results. Absent or empty when action is NONE. + required: + - guardrailId + - guardrailName + - source + - action + GuardrailSource: + description: Content source for a guardrail assessment. + type: string + enum: + - INPUT + - OUTPUT + GuardrailAction: + description: The outcome of a guardrail assessment. + type: string + enum: + - NONE + - BLOCKED + - MASKED + GuardrailPolicyResultList: + type: array + items: + $ref: "#/components/schemas/GuardrailPolicyResult" + GuardrailPolicyResult: + description: Per-policy guardrail assessment result. Captures which policy triggered, its outcome, and a policy-specific detail string. + type: object + properties: + policyType: + $ref: "#/components/schemas/GuardrailPolicyType" + description: The type of guardrail policy that was evaluated. + action: + $ref: "#/components/schemas/GuardrailAction" + description: Outcome of this specific policy. + details: + $ref: "#/components/schemas/NonEmptyString" + description: Policy-specific detail. + required: + - policyType + - action + GuardrailPolicyType: + description: Classification of a guardrail policy. + type: string + enum: + - CONTENT_FILTER + - TOPIC + - WORD + - SENSITIVE_INFORMATION_PII + - SENSITIVE_INFORMATION_REGEX + - CONTEXTUAL_GROUNDING ListTagsForResourceResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/quicksight.yaml b/providers/src/aws/v00.00.00000/services/quicksight.yaml index 2b0dd135..697701c5 100644 --- a/providers/src/aws/v00.00.00000/services/quicksight.yaml +++ b/providers/src/aws/v00.00.00000/services/quicksight.yaml @@ -52,6 +52,35 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchCreateTopicReviewedAnswerResponse" + /v1/accounts/{aws_account_id}/knowledge-bases/batch-delete: + post: + operationId: BatchDeleteKnowledgeBase + description: Deletes one or more knowledge bases. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + KnowledgeBaseIds: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseRequestKnowledgeBaseIdsList" + required: + - KnowledgeBaseIds + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseResponse" /accounts/{aws_account_id}/topics/{topic_id}/batch-delete-reviewed-answers: post: operationId: BatchDeleteTopicReviewedAnswer @@ -85,6 +114,35 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchDeleteTopicReviewedAnswerResponse" + /governance/limits/accounts/{account_id}/user-limits: + post: + operationId: BatchDescribeUserLimits + description: Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments. + parameters: + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the users. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + users: + $ref: "#/components/schemas/BatchDescribeUserLimitsRequestUsersList" + resourceTypes: + $ref: "#/components/schemas/ResourceTypeList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDescribeUserLimitsResponse" /accounts/{aws_account_id}/data-sets/{data_set_id}/ingestions/{ingestion_id}: delete: operationId: CancelIngestion @@ -477,6 +535,83 @@ paths: application/json: schema: $ref: "#/components/schemas/ListActionConnectorsResponse" + /accounts/{aws_account_id}/agents: + post: + operationId: CreateAgent + description: Creates an agent in Amazon QuickSight. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agent. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Spaces: + $ref: "#/components/schemas/CreateAgentRequestSpacesList" + ActionConnectors: + $ref: "#/components/schemas/CreateAgentRequestActionConnectorsList" + AgentId: + $ref: "#/components/schemas/AgentId" + Name: + $ref: "#/components/schemas/AgentName" + Description: + $ref: "#/components/schemas/AgentDescription" + IconId: + $ref: "#/components/schemas/IconId" + StarterPrompts: + $ref: "#/components/schemas/StarterPromptList" + WelcomeMessage: + $ref: "#/components/schemas/WelcomeMessage" + AgentLifecycle: + $ref: "#/components/schemas/AgentLifecycle" + CustomPromptInput: + $ref: "#/components/schemas/CustomPromptInput" + required: + - AgentId + - Name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAgentResponse" + get: + operationId: ListAgents + description: Lists all agents in an Amazon QuickSight account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agents. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentsRequestMaxResultsInteger" + description: The maximum number of results to return. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentsResponse" /accounts/{aws_account_id}/analyses/{analysis_id}: post: operationId: CreateAnalysis @@ -630,6 +765,67 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateAnalysisResponse" + /governance/approvalworkflows/policies: + post: + operationId: CreateApprovalPolicy + description: Creates an approval policy in Quick Sight. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + PolicyId: + $ref: "#/components/schemas/PolicyId" + Name: + $ref: "#/components/schemas/PolicyName" + Description: + $ref: "#/components/schemas/PolicyDescription" + Actions: + $ref: "#/components/schemas/GovernedActionList" + AssetTypes: + $ref: "#/components/schemas/AssetTypeList" + ApplicableTo: + $ref: "#/components/schemas/ApplicableTo" + ApprovalGroups: + $ref: "#/components/schemas/ApprovalGroupList" + required: + - PolicyId + - AssetTypes + - ApplicableTo + - ApprovalGroups + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateApprovalPolicyResponse" + get: + operationId: ListApprovalPolicies + description: Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results. + parameters: + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next set of results, or null if there are no more results. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. If you don't specify a value, the service returns a default number of results. Use the NextToken value in the response to retrieve additional results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListApprovalPoliciesResponse" /accounts/{aws_account_id}/brands/{brand_id}: post: operationId: CreateBrand @@ -771,6 +967,8 @@ paths: $ref: "#/components/schemas/CustomPermissionsName" Capabilities: $ref: "#/components/schemas/Capabilities" + Governance: + $ref: "#/components/schemas/Governance" Tags: $ref: "#/components/schemas/TagList" required: @@ -1150,6 +1348,206 @@ paths: application/json: schema: $ref: "#/components/schemas/ListDataSourcesResponse" + /accounts/{aws_account_id}/data-loss-prevention/settings/{dlp_setting_id}: + post: + operationId: CreateDlpSetting + description: Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account in which to create the DLP setting. + - name: dlp_setting_id + in: path + required: true + schema: + $ref: "#/components/schemas/DlpSettingId" + description: A unique identifier for the DLP setting. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/DlpSettingName" + ProviderType: + $ref: "#/components/schemas/DlpProviderType" + ProviderConfig: + $ref: "#/components/schemas/ProviderConfig" + ProviderOutageAction: + $ref: "#/components/schemas/DlpAction" + Enabled: + $ref: "#/components/schemas/Boolean" + Tags: + $ref: "#/components/schemas/TagList" + required: + - ProviderType + - ProviderConfig + - ProviderOutageAction + - Enabled + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDlpSettingResponse" + delete: + operationId: DeleteDlpSetting + description: Deletes a DLP setting configuration from an Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the DLP setting that you want to delete. + - name: dlp_setting_id + in: path + required: true + schema: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the DLP setting that you want to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDlpSettingResponse" + get: + operationId: DescribeDlpSetting + description: Describes the full configuration of a DLP setting in an Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the DLP setting that you want to describe. + - name: dlp_setting_id + in: path + required: true + schema: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the DLP setting that you want to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeDlpSettingResponse" + put: + operationId: UpdateDlpSetting + description: Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the DLP setting that you want to update. + - name: dlp_setting_id + in: path + required: true + schema: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the DLP setting that you want to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/DlpSettingName" + ProviderType: + $ref: "#/components/schemas/DlpProviderType" + ProviderConfig: + $ref: "#/components/schemas/ProviderConfig" + ProviderOutageAction: + $ref: "#/components/schemas/DlpAction" + Enabled: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDlpSettingResponse" + /accounts/{aws_account_id}/flows: + post: + operationId: CreateFlow + description: Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version. This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account where you want to create the flow. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/TitleInput" + Description: + $ref: "#/components/schemas/FlowDescriptionInput" + FlowDefinition: + $ref: "#/components/schemas/SensitiveDocument" + Permissions: + $ref: "#/components/schemas/PermissionsList" + ClientToken: + $ref: "#/components/schemas/CreateFlowRequestClientTokenString" + required: + - FlowDefinition + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateFlowResponse" + get: + operationId: ListFlows + description: Lists flows in an Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account that contains the flow list that you are getting. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token to request the next set of results, or null if you want to retrieve the first set. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/FlowMaxResults" + description: The maximum number of results to be returned per request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListFlowsOutput" /accounts/{aws_account_id}/folders/{folder_id}: post: operationId: CreateFolder @@ -1562,6 +1960,127 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateIAMPolicyAssignmentResponse" + /v1/accounts/{aws_account_id}/knowledge-bases: + post: + operationId: CreateKnowledgeBase + description: "Creates a knowledge base from a specified data source. Supported data source connector types include: S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source. WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source. GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only. SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only. ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only." + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + Name: + $ref: "#/components/schemas/KnowledgeBaseName" + DataSourceArn: + $ref: "#/components/schemas/DataSourceArn" + KnowledgeBaseConfiguration: + $ref: "#/components/schemas/KnowledgeBaseConfiguration" + Description: + $ref: "#/components/schemas/KnowledgeBaseDescription" + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + MediaExtractionConfiguration: + $ref: "#/components/schemas/MediaExtractionConfiguration" + AccessControlConfiguration: + $ref: "#/components/schemas/AccessControlConfiguration" + PrimaryOwnerArn: + $ref: "#/components/schemas/String" + Tags: + $ref: "#/components/schemas/TagList" + required: + - KnowledgeBaseId + - DataSourceArn + - KnowledgeBaseConfiguration + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateKnowledgeBaseResponse" + /governance/limits/accounts/{account_id}/profiles: + post: + operationId: CreateLimitsProfile + description: Creates a limits profile that defines resource usage limits for Amazon Quick Sight users. + parameters: + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profile. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profileName: + $ref: "#/components/schemas/ProfileName" + description: + $ref: "#/components/schemas/ProfileDescription" + resourceLimits: + $ref: "#/components/schemas/CreateLimitsProfileRequestResourceLimitsMap" + clientToken: + $ref: "#/components/schemas/CreateLimitsProfileRequestClientTokenString" + required: + - profileName + - resourceLimits + - clientToken + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateLimitsProfileResponse" + get: + operationId: ListLimitsProfiles + description: Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page of results. + parameters: + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profiles. + - name: resourceType + in: query + required: false + schema: + $ref: "#/components/schemas/ResourceType" + description: An optional filter that limits the results to profiles that contain the specified resource type. If you don't specify a value, the operation returns all profiles. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListLimitsProfilesRequestMaxResultsInteger" + description: The maximum number of results to return in a single call. If you don't specify a value, the service uses the default maximum. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListLimitsProfilesResponse" /accounts/{aws_account_id}: post: operationId: CreateNamespace @@ -1595,6 +2114,88 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateNamespaceResponse" + /accounts/{aws_account_id}/oauth-client-applications: + post: + operationId: CreateOAuthClientApplication + description: Creates an OAuthClientApplication. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The Amazon Web Services account ID. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + Name: + $ref: "#/components/schemas/ResourceName" + OAuthClientAuthenticationType: + $ref: "#/components/schemas/OAuthClientAuthenticationType" + ClientId: + $ref: "#/components/schemas/OAuthClientId" + ClientSecret: + $ref: "#/components/schemas/OAuthClientSecret" + OAuthTokenEndpointUrl: + $ref: "#/components/schemas/OAuthTokenEndpointUrl" + OAuthAuthorizationEndpointUrl: + $ref: "#/components/schemas/OAuthAuthorizationEndpointUrl" + OAuthScopes: + $ref: "#/components/schemas/OAuthScopesString" + DataSourceType: + $ref: "#/components/schemas/DataSourceType" + IdentityProviderVpcConnectionProperties: + $ref: "#/components/schemas/VpcConnectionProperties" + Tags: + $ref: "#/components/schemas/TagList" + required: + - OAuthClientApplicationId + - OAuthClientAuthenticationType + - ClientId + - ClientSecret + - OAuthTokenEndpointUrl + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateOAuthClientApplicationResponse" + get: + operationId: ListOAuthClientApplications + description: Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The Amazon Web Services account ID. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: A pagination token that can be used in a subsequent request. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListOAuthClientApplicationsResponse" /accounts/{aws_account_id}/data-sets/{data_set_id}/refresh-schedules: post: operationId: CreateRefreshSchedule @@ -1758,6 +2359,69 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteRoleMembershipResponse" + /v1/accounts/{aws_account_id}/spaces: + post: + operationId: CreateSpace + description: Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + SpaceId: + $ref: "#/components/schemas/PublicSpaceId" + Name: + $ref: "#/components/schemas/SpaceName" + Description: + $ref: "#/components/schemas/SpaceDescription" + required: + - SpaceId + - Name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateSpaceResponse" + get: + operationId: ListSpaces + description: Lists all Amazon QuickSight spaces in an Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the spaces. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/SpacesMaxResults" + description: The maximum number of results to return. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSpacesResponse" /accounts/{aws_account_id}/templates/{template_id}: post: operationId: CreateTemplate @@ -2464,6 +3128,72 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTopicRefreshSchedulesResponse" + /accounts/{aws_account_id}/topicsV2: + post: + operationId: CreateTopicV2 + description: Creates a new Q topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that you want to create a topic in. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TopicId: + $ref: "#/components/schemas/TopicId" + Topic: + $ref: "#/components/schemas/TopicV2Details" + Tags: + $ref: "#/components/schemas/TagList" + FolderArns: + $ref: "#/components/schemas/FolderArnList" + CustomInstructions: + $ref: "#/components/schemas/CustomInstructions" + required: + - TopicId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTopicV2Response" + get: + operationId: ListTopicsV2 + description: Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topics that you want to list. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to be returned per request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTopicsV2Response" /accounts/{aws_account_id}/vpc-connections: post: operationId: CreateVPCConnection @@ -2688,6 +3418,176 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateActionConnectorResponse" + /accounts/{aws_account_id}/agents/{agent_id}: + delete: + operationId: DeleteAgent + description: Deletes an agent. + parameters: + - name: agent_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The unique identifier for the agent to delete. + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/String" + description: The ID of the Amazon Web Services account that contains the agent. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAgentResponse" + get: + operationId: DescribeAgent + description: Describes an agent. + parameters: + - name: agent_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agent. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAgentResponse" + put: + operationId: UpdateAgent + description: Updates an existing agent. + parameters: + - name: agent_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent to update. + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agent. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/AgentName" + Description: + $ref: "#/components/schemas/AgentDescription" + IconId: + $ref: "#/components/schemas/IconId" + StarterPrompts: + $ref: "#/components/schemas/StarterPromptList" + WelcomeMessage: + $ref: "#/components/schemas/WelcomeMessage" + CustomPromptInput: + $ref: "#/components/schemas/CustomPromptInput" + SpacesToAdd: + $ref: "#/components/schemas/UpdateAgentRequestSpacesToAddList" + SpacesToRemove: + $ref: "#/components/schemas/UpdateAgentRequestSpacesToRemoveList" + ActionConnectorsToAdd: + $ref: "#/components/schemas/UpdateAgentRequestActionConnectorsToAddList" + ActionConnectorsToRemove: + $ref: "#/components/schemas/UpdateAgentRequestActionConnectorsToRemoveList" + required: + - Name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentResponse" + /governance/approvalworkflows/policies/{policy_id}: + delete: + operationId: DeleteApprovalPolicy + description: Deletes an approval policy in Quick Sight. + parameters: + - name: policy_id + in: path + required: true + schema: + $ref: "#/components/schemas/PolicyId" + description: The unique identifier of the approval policy to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteApprovalPolicyResponse" + get: + operationId: DescribeApprovalPolicy + description: Describes an approval policy in Quick Sight. + parameters: + - name: policy_id + in: path + required: true + schema: + $ref: "#/components/schemas/PolicyId" + description: The unique identifier of the approval policy to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeApprovalPolicyResponse" + patch: + operationId: UpdateApprovalPolicy + description: Updates an approval policy in Quick Sight. + parameters: + - name: policy_id + in: path + required: true + schema: + $ref: "#/components/schemas/PolicyId" + description: The unique identifier of the approval policy to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/PolicyName" + Description: + $ref: "#/components/schemas/PolicyDescription" + Actions: + $ref: "#/components/schemas/GovernedActionList" + AssetTypes: + $ref: "#/components/schemas/AssetTypeList" + ApplicableTo: + $ref: "#/components/schemas/ApplicableTo" + ApprovalGroups: + $ref: "#/components/schemas/ApprovalGroupList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateApprovalPolicyResponse" /accounts/{aws_account_id}/brandassignments: delete: operationId: DeleteBrandAssignment @@ -2823,6 +3723,8 @@ paths: properties: Capabilities: $ref: "#/components/schemas/Capabilities" + Governance: + $ref: "#/components/schemas/Governance" responses: "200": description: Success @@ -3187,6 +4089,97 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateDefaultQBusinessApplicationResponse" + /accounts/{aws_account_id}/flows/{flow_id}: + delete: + operationId: DeleteFlow + description: Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account that contains the flow that you are deleting. + - name: flow_id + in: path + required: true + schema: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteFlowResponse" + get: + operationId: DescribeFlow + description: Returns the full details of a flow for the latest version of the requested publish state. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account that contains the flow that you are describing. + - name: flow_id + in: path + required: true + schema: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow. + - name: publish-state + in: query + required: true + schema: + $ref: "#/components/schemas/FlowPublishState" + description: The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeFlowResponse" + put: + operationId: UpdateFlow + description: Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account that contains the flow that you are updating. + - name: flow_id + in: path + required: true + schema: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/TitleInput" + Description: + $ref: "#/components/schemas/FlowDescriptionInput" + FlowDefinition: + $ref: "#/components/schemas/SensitiveDocument" + ClientToken: + $ref: "#/components/schemas/UpdateFlowRequestClientTokenString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateFlowResponse" /accounts/{aws_account_id}/namespaces/{namespace}/groups/{group_name}: delete: operationId: DeleteGroup @@ -3370,6 +4363,178 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateIdentityPropagationConfigResponse" + /v1/accounts/{aws_account_id}/knowledge-bases/{knowledge_base_id}: + delete: + operationId: DeleteKnowledgeBase + description: Deletes a knowledge base. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: knowledge_base_id + in: path + required: true + schema: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteKnowledgeBaseResponse" + get: + operationId: DescribeKnowledgeBase + description: Describes a knowledge base. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: knowledge_base_id + in: path + required: true + schema: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeKnowledgeBaseResponse" + post: + operationId: UpdateKnowledgeBase + description: Updates the properties of an existing knowledge base. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: knowledge_base_id + in: path + required: true + schema: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/KnowledgeBaseName" + Description: + $ref: "#/components/schemas/KnowledgeBaseDescription" + KnowledgeBaseConfiguration: + $ref: "#/components/schemas/KnowledgeBaseConfiguration" + MediaExtractionConfiguration: + $ref: "#/components/schemas/MediaExtractionConfiguration" + IsEmailNotificationOptedForIngestionFailures: + $ref: "#/components/schemas/Boolean" + AccessControlConfiguration: + $ref: "#/components/schemas/AccessControlConfiguration" + responses: + "202": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateKnowledgeBaseResponse" + /governance/limits/accounts/{account_id}/profiles/{profile_id}: + delete: + operationId: DeleteLimitsProfile + description: Deletes a limits profile. + parameters: + - name: profile_id + in: path + required: true + schema: + $ref: "#/components/schemas/ProfileId" + description: The unique identifier for the limits profile to delete. + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profile. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteLimitsProfileResponse" + get: + operationId: DescribeLimitsProfile + description: Describes the properties of an existing limits profile. + parameters: + - name: profile_id + in: path + required: true + schema: + $ref: "#/components/schemas/ProfileId" + description: The unique identifier for the limits profile. + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profile. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeLimitsProfileResponse" + put: + operationId: UpdateLimitsProfile + description: Updates the properties of an existing limits profile. + parameters: + - name: profile_id + in: path + required: true + schema: + $ref: "#/components/schemas/ProfileId" + description: The unique identifier for the limits profile to update. + - name: account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profile. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + profileName: + $ref: "#/components/schemas/ProfileName" + description: + $ref: "#/components/schemas/ProfileDescription" + resourceLimits: + $ref: "#/components/schemas/ResourceLimitsMap" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateLimitsProfileResponse" /accounts/{aws_account_id}/namespaces/{namespace}: delete: operationId: DeleteNamespace @@ -3417,6 +4582,99 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeNamespaceResponse" + /accounts/{aws_account_id}/oauth-client-applications/{o_auth_client_application_id}: + delete: + operationId: DeleteOAuthClientApplication + description: Deletes an OAuthClientApplication. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The Amazon Web Services account ID. + - name: o_auth_client_application_id + in: path + required: true + schema: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication that you want to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteOAuthClientApplicationResponse" + get: + operationId: DescribeOAuthClientApplication + description: Describes an OAuthClientApplication. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The Amazon Web Services account ID. + - name: o_auth_client_application_id + in: path + required: true + schema: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication that you want to describe. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeOAuthClientApplicationResponse" + put: + operationId: UpdateOAuthClientApplication + description: Updates an OAuthClientApplication. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The Amazon Web Services account ID. + - name: o_auth_client_application_id + in: path + required: true + schema: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication that you want to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/ResourceName" + ClientId: + $ref: "#/components/schemas/OAuthClientId" + ClientSecret: + $ref: "#/components/schemas/OAuthClientSecret" + OAuthTokenEndpointUrl: + $ref: "#/components/schemas/OAuthTokenEndpointUrl" + OAuthAuthorizationEndpointUrl: + $ref: "#/components/schemas/OAuthAuthorizationEndpointUrl" + OAuthScopes: + $ref: "#/components/schemas/OAuthScopesString" + DataSourceType: + $ref: "#/components/schemas/DataSourceType" + IdentityProviderVpcConnectionProperties: + $ref: "#/components/schemas/VpcConnectionProperties" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateOAuthClientApplicationResponse" /accounts/{aws_account_id}/data-sets/{data_set_id}/refresh-schedules/{schedule_id}: delete: operationId: DeleteRefreshSchedule @@ -3575,6 +4833,93 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateRoleCustomPermissionResponse" + /v1/accounts/{aws_account_id}/spaces/{space_id}: + delete: + operationId: DeleteSpace + description: Deletes an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to delete. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSpaceResponse" + get: + operationId: DescribeSpace + description: Describes an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to describe. + - name: maxContributors + in: query + required: false + schema: + $ref: "#/components/schemas/MaxContributors" + description: The maximum number of contributors to include in the response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeSpaceResponse" + put: + operationId: UpdateSpace + description: Updates the metadata of an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/SpaceName" + Description: + $ref: "#/components/schemas/SpaceDescription" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSpaceResponse" /accounts/{aws_account_id}/topics/{topic_id}: delete: operationId: DeleteTopic @@ -3755,6 +5100,89 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateTopicRefreshScheduleResponse" + /accounts/{aws_account_id}/topicsV2/{topic_id}: + delete: + operationId: DeleteTopicV2 + description: Deletes a Q topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want to delete. + - name: topic_id + in: path + required: true + schema: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteTopicV2Response" + get: + operationId: DescribeTopicV2 + description: Describes a Q topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want to describe. + - name: topic_id + in: path + required: true + schema: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeTopicV2Response" + put: + operationId: UpdateTopicV2 + description: Updates the definition of a Q topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want to update. + - name: topic_id + in: path + required: true + schema: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Topic: + $ref: "#/components/schemas/TopicV2Details" + CustomInstructions: + $ref: "#/components/schemas/CustomInstructions" + PublishOption: + $ref: "#/components/schemas/TopicV2PublishOption" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTopicV2Response" /accounts/{aws_account_id}/namespaces/{namespace}/users/{user_name}: delete: operationId: DeleteUser @@ -4164,6 +5592,64 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateActionConnectorPermissionsResponse" + /accounts/{aws_account_id}/agents/{agent_id}/permissions: + get: + operationId: DescribeAgentPermissions + description: Describes the resource permissions for an agent. + parameters: + - name: agent_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agent. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeAgentPermissionsResponse" + put: + operationId: UpdateAgentPermissions + description: Updates the resource permissions for an agent. + parameters: + - name: agent_id + in: path + required: true + schema: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agent. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + GrantPermissions: + $ref: "#/components/schemas/UpdateAgentPermissionsRequestGrantPermissionsList" + RevokePermissions: + $ref: "#/components/schemas/UpdateAgentPermissionsRequestRevokePermissionsList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentPermissionsResponse" /accounts/{aws_account_id}/analyses/{analysis_id}/definition: get: operationId: DescribeAnalysisDefinition @@ -5012,6 +6498,64 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateKeyRegistrationResponse" + /v1/accounts/{aws_account_id}/knowledge-bases/{knowledge_base_id}/permissions: + get: + operationId: DescribeKnowledgeBasePermissions + description: Describes the resource permissions for a knowledge base. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: knowledge_base_id + in: path + required: true + schema: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeKnowledgeBasePermissionsResponse" + post: + operationId: UpdateKnowledgeBasePermissions + description: Updates the resource permissions for a knowledge base. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: knowledge_base_id + in: path + required: true + schema: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + GrantPermissions: + $ref: "#/components/schemas/ResourcePermissionList" + RevokePermissions: + $ref: "#/components/schemas/ResourcePermissionList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateKnowledgeBasePermissionsResponse" /accounts/{aws_account_id}/q-personalization-configuration: get: operationId: DescribeQPersonalizationConfiguration @@ -5162,6 +6706,64 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateSelfUpgradeConfigurationResponse" + /v1/accounts/{aws_account_id}/spaces/{space_id}/permissions: + get: + operationId: DescribeSpacePermissions + description: Describes the permissions for an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to describe permissions for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeSpacePermissionsResponse" + put: + operationId: UpdateSpacePermissions + description: Updates the permissions for an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to update permissions for. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + GrantPermissions: + $ref: "#/components/schemas/ResourcePermissionList" + RevokePermissions: + $ref: "#/components/schemas/ResourcePermissionList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSpacePermissionsResponse" /accounts/{aws_account_id}/templates/{template_id}/definition: get: operationId: DescribeTemplateDefinition @@ -5372,6 +6974,64 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateTopicPermissionsResponse" + /accounts/{aws_account_id}/topicsV2/{topic_id}/permissions: + get: + operationId: DescribeTopicPermissionsV2 + description: Describes the permissions of a topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want described. + - name: topic_id + in: path + required: true + schema: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeTopicPermissionsV2Response" + put: + operationId: UpdateTopicPermissionsV2 + description: Updates the permissions of a topic. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for. + - name: topic_id + in: path + required: true + schema: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + GrantPermissions: + $ref: "#/components/schemas/UpdateResourcePermissionList" + RevokePermissions: + $ref: "#/components/schemas/UpdateResourcePermissionList" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTopicPermissionsV2Response" /accounts/{aws_account_id}/topics/{topic_id}/refresh/{refresh_id}: get: operationId: DescribeTopicRefresh @@ -5923,36 +7583,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListDashboardsResponse" - /accounts/{aws_account_id}/flows: + /accounts/{aws_account_id}/data-loss-prevention/settings: get: - operationId: ListFlows - description: Lists flows in an Amazon Web Services account. + operationId: ListDlpSettings + description: Lists all DLP settings in an Amazon Web Services account. parameters: - name: aws_account_id in: path required: true schema: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that contains the flow list that you are getting. + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the DLP settings that you want to list. - name: next-token in: query required: false schema: - $ref: "#/components/schemas/String" - description: The token to request the next set of results, or null if you want to retrieve the first set. + $ref: "#/components/schemas/PaginationToken" + description: The token for the next set of results, or null if there are no more results. - name: max-results in: query required: false schema: - $ref: "#/components/schemas/FlowMaxResults" - description: The maximum number of results to be returned per request. + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return per request. responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/ListFlowsOutput" + $ref: "#/components/schemas/ListDlpSettingsResponse" /accounts/{aws_account_id}/folders/{folder_id}/members: get: operationId: ListFolderMembers @@ -6247,6 +7907,36 @@ paths: application/json: schema: $ref: "#/components/schemas/ListIngestionsResponse" + /v1/accounts/{aws_account_id}/knowledge-bases/: + get: + operationId: ListKnowledgeBases + description: Lists all knowledge bases in an Amazon QuickSight account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListKnowledgeBasesResponse" /accounts/{aws_account_id}/namespaces: get: operationId: ListNamespaces @@ -6355,6 +8045,64 @@ paths: application/json: schema: $ref: "#/components/schemas/ListSelfUpgradesResponse" + /v1/accounts/{aws_account_id}/spaces/{space_id}/resources: + get: + operationId: ListSpaceResources + description: Lists the resources in an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to list resources for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSpaceResourcesResponse" + put: + operationId: UpdateSpaceResources + description: Adds or removes resources from an Amazon QuickSight space. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the space. + - name: space_id + in: path + required: true + schema: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space that you want to update resources for. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + AddResources: + $ref: "#/components/schemas/SpaceResourceOperations" + RemoveResources: + $ref: "#/components/schemas/SpaceResourceOperations" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSpaceResourcesResponse" /resources/{resource_arn}/tags: get: operationId: ListTagsForResource @@ -6789,6 +8537,43 @@ paths: application/json: schema: $ref: "#/components/schemas/RegisterUserResponse" + /accounts/{aws_account_id}/quick-index/user-capacity: + post: + operationId: ListUsersIndexCapacity + description: Lists per-user index capacity consumption for an account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the index capacity data. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + namespace: + $ref: "#/components/schemas/Namespace" + filters: + $ref: "#/components/schemas/UserIndexCapacityFilters" + sortBy: + $ref: "#/components/schemas/UserIndexCapacitySortBy" + sortOrder: + $ref: "#/components/schemas/UserIndexCapacitySortOrder" + maxResults: + $ref: "#/components/schemas/ListUsersIndexCapacityRequestMaxResultsInteger" + nextToken: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListUsersIndexCapacityResponse" /accounts/{aws_account_id}/qa/predict: post: operationId: PredictQAResults @@ -6895,6 +8680,47 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchActionConnectorsResponse" + /accounts/{aws_account_id}/search/agents: + post: + operationId: SearchAgents + description: Searches for agents based on specified filters. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the agents. + - name: max-results + in: query + required: false + schema: + $ref: "#/components/schemas/AgentsMaxResults" + description: The maximum number of results to return. + - name: next-token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Filters: + $ref: "#/components/schemas/AgentSearchFilterList" + required: + - Filters + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchAgentsResponse" /accounts/{aws_account_id}/search/analyses: post: operationId: SearchAnalyses @@ -7140,6 +8966,72 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchGroupsResponse" + /v1/accounts/{aws_account_id}/search/knowledge-bases: + post: + operationId: SearchKnowledgeBases + description: Searches for a subset of knowledge bases based on specified filters. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/KbAwsAccountId" + description: The ID of the Amazon Web Services account that contains the knowledge base. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/NextToken" + MaxResults: + $ref: "#/components/schemas/MaxResults" + Filters: + $ref: "#/components/schemas/KnowledgeBaseSearchFilters" + SortBy: + $ref: "#/components/schemas/KnowledgeBaseSortBy" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchKnowledgeBasesResponse" + /v1/accounts/{aws_account_id}/search/spaces: + post: + operationId: SearchSpaces + description: Searches for Amazon QuickSight spaces that match the specified filters. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the spaces. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/NextToken" + MaxResults: + $ref: "#/components/schemas/SpacesMaxResults" + Filters: + $ref: "#/components/schemas/SpaceQuicksightSearchFilters" + required: + - Filters + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchSpacesResponse" /accounts/{aws_account_id}/search/topics: post: operationId: SearchTopics @@ -7173,6 +9065,39 @@ paths: application/json: schema: $ref: "#/components/schemas/SearchTopicsResponse" + /accounts/{aws_account_id}/search/topicsV2: + post: + operationId: SearchTopicsV2 + description: Searches for any Q topic that exists in an Amazon Web Services account. + parameters: + - name: aws_account_id + in: path + required: true + schema: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the topic that you want to search. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Filters: + $ref: "#/components/schemas/TopicSearchFilterList" + NextToken: + $ref: "#/components/schemas/String" + MaxResults: + $ref: "#/components/schemas/MaxResults" + required: + - Filters + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SearchTopicsV2Response" /accounts/{aws_account_id}/asset-bundle-export-jobs/export: post: operationId: StartAssetBundleExportJob @@ -7625,7 +9550,7 @@ components: $ref: "#/components/schemas/Arn" description: The Dataset arn for the CreateTopicReviewedAnswer. Question: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The Question to be created. Mir: $ref: "#/components/schemas/TopicIR" @@ -7646,7 +9571,7 @@ components: pattern: ^[A-Za-z0-9-_.\\+]*$ Arn: type: string - LimitedString: + LimitedSensitiveString: type: string maxLength: 256 TopicIR: @@ -7714,6 +9639,9 @@ components: description: The identity of the identifier. required: - Identity + LimitedString: + type: string + maxLength: 256 AggFunction: description: The definition of an Agg function. type: object @@ -8014,6 +9942,7 @@ components: - ENFORCED_VALUE_FILTER - CONDITIONAL_VALUE_FILTER - NAMED_VALUE_FILTER + - DASHBOARD_DEFAULT_FILTER TopicIRFilterFunction: type: string enum: @@ -8304,6 +10233,81 @@ components: type: integer String: type: string + KbAwsAccountId: + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]*" + BatchDeleteKnowledgeBaseRequestKnowledgeBaseIdsList: + type: array + items: + $ref: "#/components/schemas/KnowledgeBaseId" + KnowledgeBaseId: + type: string + minLength: 1 + maxLength: 1024 + pattern: "[0-9a-zA-Z-_=.+]+" + BatchDeleteKnowledgeBaseResponse: + type: object + properties: + Deleted: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseSuccessList" + description: A list of knowledge bases that were successfully deleted. + Errors: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseFailureList" + description: A list of knowledge bases that failed to be deleted. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - Deleted + - Errors + BatchDeleteKnowledgeBaseSuccessList: + type: array + items: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseSuccess" + BatchDeleteKnowledgeBaseSuccess: + description: Information about a knowledge base that was successfully deleted in a batch operation. + type: object + properties: + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier of the successfully deleted knowledge base. + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The ARN of the successfully deleted knowledge base. + required: + - KnowledgeBaseId + - KnowledgeBaseArn + KnowledgeBaseArn: + type: string + minLength: 0 + maxLength: 1284 + pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} + BatchDeleteKnowledgeBaseFailureList: + type: array + items: + $ref: "#/components/schemas/BatchDeleteKnowledgeBaseFailure" + BatchDeleteKnowledgeBaseFailure: + description: Information about a knowledge base that failed to be deleted in a batch operation. + type: object + properties: + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier of the knowledge base that failed to be deleted. + ErrorCode: + $ref: "#/components/schemas/String" + description: The error code for the deletion failure. + ErrorMessage: + $ref: "#/components/schemas/String" + description: The error message for the deletion failure. + required: + - KnowledgeBaseId + - ErrorCode + - ErrorMessage AnswerIds: type: array items: @@ -8329,6 +10333,147 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + BatchDescribeUserLimitsRequestUsersList: + type: array + items: + $ref: "#/components/schemas/UserLimitsEntry" + UserLimitsEntry: + description: Identifies a user for the BatchDescribeUserLimits operation. + type: object + properties: + userName: + $ref: "#/components/schemas/String" + description: The name of the user. + namespace: + $ref: "#/components/schemas/String" + description: The namespace of the user. + required: + - userName + - namespace + ResourceTypeList: + type: array + items: + $ref: "#/components/schemas/ResourceType" + ResourceType: + description: The type of resource that a limit applies to. + type: string + enum: + - INDEX_STORAGE + - AGENT_HOURS + BatchDescribeUserLimitsResponse: + type: object + properties: + userLimits: + $ref: "#/components/schemas/UserLimitsList" + description: A list of user limits results. Each entry contains the effective limits for a user. + errors: + $ref: "#/components/schemas/BatchDescribeUserLimitsErrorList" + description: A list of errors for users whose limits could not be described. + required: + - userLimits + - errors + UserLimitsList: + type: array + items: + $ref: "#/components/schemas/UserLimits" + UserLimits: + description: The effective limits for an Amazon Quick Sight user. + type: object + properties: + userName: + $ref: "#/components/schemas/String" + description: The name of the user. + namespace: + $ref: "#/components/schemas/String" + description: The namespace of the user. + effectiveLimits: + $ref: "#/components/schemas/EffectiveLimitList" + description: A list of effective limits for the user. + required: + - userName + - namespace + - effectiveLimits + EffectiveLimitList: + type: array + items: + $ref: "#/components/schemas/EffectiveLimit" + EffectiveLimit: + description: The effective limit for a resource type that applies to a user, considering all applicable profile assignments and inheritance rules. + type: object + properties: + resourceType: + $ref: "#/components/schemas/ResourceType" + description: The type of resource that the limit applies to. + limitValue: + $ref: "#/components/schemas/EffectiveLimitLimitValueLong" + description: The maximum allowed value for the resource. + limitUnit: + $ref: "#/components/schemas/LimitUnit" + description: The unit of measurement for the limit. + source: + $ref: "#/components/schemas/LimitSource" + description: "The source from which this limit was inherited. Possible values: DIRECT_USER – The limit comes from a profile directly assigned to the user. GROUP – The limit comes from a profile assigned to a group the user belongs to. ROLE – The limit comes from a profile assigned to a role the user has. ACCOUNT – The limit comes from the account-level default profile. SYSTEM_DEFAULT – The limit comes from the built-in system default." + profileId: + $ref: "#/components/schemas/ProfileId" + description: The identifier of the limits profile that defines this limit. + required: + - resourceType + - limitValue + - limitUnit + - source + - profileId + EffectiveLimitLimitValueLong: + type: integer + format: int64 + minimum: 0 + LimitUnit: + description: The unit of measurement for a resource limit value. + type: string + enum: + - MB + - GB + - HOURS + - DAYS + LimitSource: + description: The source from which an effective limit was inherited. + type: string + enum: + - DIRECT_USER + - GROUP + - ROLE + - ACCOUNT + - SYSTEM_DEFAULT + ProfileId: + type: string + minLength: 1 + maxLength: 128 + pattern: lp-[a-f0-9-]+ + BatchDescribeUserLimitsErrorList: + type: array + items: + $ref: "#/components/schemas/BatchDescribeUserLimitsError" + BatchDescribeUserLimitsError: + description: Information about a user whose limits could not be described in a batch operation. + type: object + properties: + userName: + $ref: "#/components/schemas/String" + description: The name of the user that failed. + namespace: + $ref: "#/components/schemas/String" + description: The namespace of the user that failed. + userArn: + $ref: "#/components/schemas/String" + description: The ARN of the user that failed. + errorCode: + $ref: "#/components/schemas/String" + description: The error code for the failure. + message: + $ref: "#/components/schemas/String" + description: The error message for the failure. + required: + - errorCode + - message IngestionId: type: string minLength: 1 @@ -8772,6 +10917,151 @@ components: - UPDATE_SUCCESSFUL - UPDATE_FAILED - DELETED + CreateAgentRequestSpacesList: + type: array + items: + $ref: "#/components/schemas/Arn" + CreateAgentRequestActionConnectorsList: + type: array + items: + $ref: "#/components/schemas/Arn" + AgentId: + type: string + minLength: 1 + maxLength: 256 + pattern: "[0-9a-zA-Z-_.+]+" + AgentName: + type: string + minLength: 1 + maxLength: 50 + pattern: (?!\s*$).+ + AgentDescription: + type: string + minLength: 0 + maxLength: 1000 + pattern: \P{C}* + IconId: + type: string + minLength: 1 + maxLength: 200 + StarterPromptList: + type: array + items: + $ref: "#/components/schemas/StarterPrompt" + StarterPrompt: + type: string + minLength: 0 + maxLength: 100 + WelcomeMessage: + type: string + minLength: 0 + maxLength: 300 + AgentLifecycle: + type: string + enum: + - PREVIEW + - PUBLISHED + CustomPromptInput: + description: The custom prompt input for an agent. This is a union type that can be either an existing prompt profile or new prompt parameters. + type: object + properties: + ExistingPrompt: + $ref: "#/components/schemas/CustomPromptProfile" + description: An existing custom prompt profile to use for the agent. + NewPrompt: + $ref: "#/components/schemas/CustomPromptInputParameters" + description: New custom prompt parameters to configure for the agent. + CustomPromptProfile: + description: A reference to an existing custom prompt profile. + type: object + properties: + ModelProfileId: + $ref: "#/components/schemas/ModelProfileId" + description: The identifier of the model profile. + SubscriptionId: + $ref: "#/components/schemas/SubscriptionId" + description: The subscription identifier. + QbsAwsAccountId: + $ref: "#/components/schemas/QbsAwsAccountId" + description: The Amazon Web Services account ID for the Q Business service. + required: + - ModelProfileId + - SubscriptionId + - QbsAwsAccountId + ModelProfileId: + type: string + minLength: 36 + maxLength: 36 + pattern: "[a-zA-Z0-9][a-zA-Z0-9-]{35}" + SubscriptionId: + type: string + minLength: 32 + maxLength: 32 + pattern: "[a-z0-9]+" + QbsAwsAccountId: + type: string + minLength: 15 + maxLength: 15 + pattern: QBS[0-9]{12} + CustomPromptInputParameters: + description: The parameters for configuring a custom prompt for an agent. + type: object + properties: + ResponseLength: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired response length. + OutputStyle: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired output style. + Identity: + $ref: "#/components/schemas/StyleDescription" + description: Instructions that define the agent's identity and persona. + Tone: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired tone of responses. + CustomInstructions: + $ref: "#/components/schemas/StyleDescription" + description: Custom instructions for the agent's behavior. + StyleDescription: + type: string + minLength: 5 + maxLength: 350000 + pattern: "[\\s\\S]*" + CreateAgentResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + AgentStatus: + $ref: "#/components/schemas/AgentStatus" + description: The status of the agent. + AgentName: + $ref: "#/components/schemas/AgentName" + description: The name of the agent. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - AgentId + - AgentStatus + - AgentName + AgentArn: + type: string + minLength: 0 + maxLength: 1284 + pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} + AgentStatus: + type: string + enum: + - ACTIVE + - UPDATING + - FAILED + - CREATING AnalysisName: type: string minLength: 1 @@ -8904,6 +11194,9 @@ components: DataSetReferences: $ref: "#/components/schemas/DataSetReferenceList" description: The dataset references of the source template of an analysis. + TopicReferences: + $ref: "#/components/schemas/TopicReferenceList" + description: The topic references of the source template of an analysis. Arn: $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) of the source template of an analysis. @@ -8927,6 +11220,27 @@ components: required: - DataSetPlaceholder - DataSetArn + TopicReferenceList: + type: array + items: + $ref: "#/components/schemas/TopicReference" + TopicReference: + description: Topic reference. + type: object + properties: + TopicPlaceholder: + $ref: "#/components/schemas/TopicIdentifier" + description: Topic placeholder. + TopicArn: + $ref: "#/components/schemas/Arn" + description: Topic Amazon Resource Name (ARN). + required: + - TopicPlaceholder + - TopicArn + TopicIdentifier: + type: string + minLength: 1 + maxLength: 2048 AnalysisDefinition: description: The definition of an analysis. type: object @@ -8934,6 +11248,9 @@ components: DataSetIdentifierDeclarations: $ref: "#/components/schemas/DataSetIdentifierDeclarationList" description: An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures. + TopicIdentifierDeclarations: + $ref: "#/components/schemas/TopicIdentifierDeclarationList" + description: An array of topic identifier declarations. This mapping allows the usage of topic identifiers instead of topic ARNs throughout analysis sub-structures. Sheets: $ref: "#/components/schemas/SheetDefinitionList" description: An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis. @@ -8983,8 +11300,25 @@ components: - DataSetArn DataSetIdentifier: type: string - minLength: 1 + minLength: 0 maxLength: 2048 + TopicIdentifierDeclarationList: + type: array + items: + $ref: "#/components/schemas/TopicIdentifierDeclaration" + TopicIdentifierDeclaration: + description: A topic. + type: object + properties: + Identifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The identifier of the topic, typically the topic's name. + TopicArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + required: + - Identifier + - TopicArn SheetDefinitionList: type: array items: @@ -9336,11 +11670,13 @@ components: DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" description: The data set that the column belongs to. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that the column belongs to. ColumnName: $ref: "#/components/schemas/ColumnName" description: The name of the column. required: - - DataSetIdentifier - ColumnName ColumnName: type: string @@ -14985,13 +17321,15 @@ components: description: The configuration settings of the visual. DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" - description: The dataset that is used to create the layer map visual. You can't create a visual without a dataset. + description: The dataset that is used to create the layer map visual. You can't create a visual without a dataset or a topic. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that is used in the layer map visual. You can't create a visual without a dataset or a topic. VisualContentAltText: $ref: "#/components/schemas/LongPlainText" description: The alt text for the visual. required: - VisualId - - DataSetIdentifier GeospatialLayerMapConfiguration: description: The map definition that defines map state, map style, and geospatial layers. type: object @@ -16398,12 +18736,14 @@ components: DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" description: The dataset that is used in the insight visual. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that is used in the insight visual. VisualContentAltText: $ref: "#/components/schemas/LongPlainText" description: The alt text for the visual. required: - VisualId - - DataSetIdentifier InsightConfiguration: description: The configuration of an insight visual. type: object @@ -16825,13 +19165,15 @@ components: description: The list of custom actions that are configured for a visual. DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" - description: The dataset that is used to create the custom content visual. You can't create a visual without a dataset. + description: The dataset that is used to create the custom content visual. You can't create a visual without a dataset or a topic. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that is used in the custom content visual. You can't create a visual without a dataset or a topic. VisualContentAltText: $ref: "#/components/schemas/LongPlainText" description: The alt text for the visual. required: - VisualId - - DataSetIdentifier CustomContentConfiguration: description: The configuration of a CustomContentVisual. type: object @@ -16869,13 +19211,15 @@ components: description: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers. DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" - description: The data set that is used in the empty visual. Every visual requires a dataset to render. + description: The data set that is used in the empty visual. Every visual requires a dataset or a topic to render. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that is used in the empty visual. Every visual requires a dataset or a topic to render. Actions: $ref: "#/components/schemas/VisualCustomActionList" description: The list of custom actions that are configured for a visual. required: - VisualId - - DataSetIdentifier RadarChartVisual: description: A radar chart visual. type: object @@ -18025,6 +20369,9 @@ components: DataSetIdentifier: $ref: "#/components/schemas/DataSetIdentifier" description: The data set that is used in this calculated field. + TopicIdentifier: + $ref: "#/components/schemas/TopicIdentifier" + description: The topic that is used in this calculated field. Name: $ref: "#/components/schemas/ColumnName" description: The name of the calculated field. @@ -18032,7 +20379,6 @@ components: $ref: "#/components/schemas/CalculatedFieldExpression" description: The expression of the calculated field. required: - - DataSetIdentifier - Name - Expression CalculatedFieldExpression: @@ -19129,6 +21475,9 @@ components: CustomActionDefaults: $ref: "#/components/schemas/VisualCustomActionDefaults" description: A list of visual custom actions for the analysis. + VisualMessages: + $ref: "#/components/schemas/VisualMessages" + description: The configuration options for the messages that are displayed on visuals in the analysis. DayOfTheWeek: type: string enum: @@ -19148,6 +21497,49 @@ components: type: array items: $ref: "#/components/schemas/Arn" + VisualMessages: + description: The messages that are displayed on a visual under specific conditions, such as when the visual returns no data. + type: object + properties: + NoDataMessage: + $ref: "#/components/schemas/VisualMessageConfiguration" + description: The message that is displayed on a visual when there is no data to display. + VisualMessageConfiguration: + description: The configuration for a customizable message displayed on a visual. Supports parameter substitution in text fields. + type: object + properties: + Enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed. + Title: + $ref: "#/components/schemas/VisualMessageText" + description: The title text of the message that is displayed on the visual. + TitleVisibility: + $ref: "#/components/schemas/Visibility" + description: Specifies whether the title of the message is displayed. + Description: + $ref: "#/components/schemas/VisualMessageText" + description: The description text of the message that is displayed on the visual. + DescriptionVisibility: + $ref: "#/components/schemas/Visibility" + description: Specifies whether the description of the message is displayed. + LinkText: + $ref: "#/components/schemas/VisualMessageText" + description: The display text of the hyperlink that is shown in the message. + LinkUrl: + $ref: "#/components/schemas/VisualMessageLinkUrl" + description: The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported. + LinkVisibility: + $ref: "#/components/schemas/Visibility" + description: Specifies whether the hyperlink in the message is displayed. + VisualMessageText: + type: string + maxLength: 120 + pattern: \A[\p{L}\p{M}\p{N}\s.,/\\:_()\[\]<>$!?'"#@%+&|^\-]*\z + VisualMessageLinkUrl: + type: string + maxLength: 120 + pattern: (?i)\A(?:(?:https?://|mailto:)\S*<<\$.+?>>\S*|https?://[a-z\d.-]+\.[a-z]{2,63}(?::\d+)?(?:[/?#][^\s]*)?|mailto:[^\s@]+@[a-z\d.-]+\.[a-z]{2,63})\z QueryExecutionOptions: description: A structure that describes the query execution options. type: object @@ -19270,6 +21662,113 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + PolicyId: + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-zA-Z0-9\\-_]+" + PolicyName: + type: string + minLength: 1 + maxLength: 256 + PolicyDescription: + type: string + minLength: 0 + maxLength: 1024 + GovernedActionList: + type: array + items: + $ref: "#/components/schemas/GovernedAction" + GovernedAction: + type: string + enum: + - SHARE + AssetTypeList: + type: array + items: + $ref: "#/components/schemas/AssetType" + AssetType: + type: string + enum: + - AGENT + - SPACE + - KNOWLEDGE_BASE + ApplicableTo: + description: The scoping configuration that determines which principals an approval policy applies to. + type: object + properties: + Type: + $ref: "#/components/schemas/ApplicableToType" + description: "The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows: GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns." + GroupArns: + $ref: "#/components/schemas/GroupArnList" + description: The list of group ARNs that the policy applies to. Required when type is GROUP. + required: + - Type + ApplicableToType: + type: string + enum: + - GROUP + GroupArnList: + type: array + items: + $ref: "#/components/schemas/Arn" + ApprovalGroupList: + type: array + items: + $ref: "#/components/schemas/Arn" + CreateApprovalPolicyResponse: + type: object + properties: + Policy: + $ref: "#/components/schemas/ApprovalPolicy" + description: The approval policy that was created. + required: + - Policy + ApprovalPolicy: + description: A governance approval policy that specifies which principals and governed actions require approval, and which assets the policy applies to. + type: object + properties: + PolicyId: + $ref: "#/components/schemas/PolicyId" + description: The unique identifier of the approval policy. + PolicyArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the approval policy. + Name: + $ref: "#/components/schemas/PolicyName" + description: The name of the approval policy. + Description: + $ref: "#/components/schemas/PolicyDescription" + description: A description of the approval policy. + Actions: + $ref: "#/components/schemas/GovernedActionList" + description: The list of governed actions that trigger the approval workflow. + AssetTypes: + $ref: "#/components/schemas/AssetTypeList" + description: The list of asset types that the approval policy applies to. + ApplicableTo: + $ref: "#/components/schemas/ApplicableTo" + description: The scoping configuration that determines who the approval policy applies to. + ApprovalGroups: + $ref: "#/components/schemas/ApprovalGroupList" + description: The list of group ARNs whose members can approve requests. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the approval policy was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the approval policy was last updated. + required: + - PolicyId + - PolicyArn + - Name + - Actions + - AssetTypes + - ApplicableTo + - ApprovalGroups + - CreatedAt + - UpdatedAt BrandDefinition: description: The definition of the brand. type: object @@ -19675,6 +22174,90 @@ components: KnowledgeBase: $ref: "#/components/schemas/CapabilityState" description: The ability to use knowledge bases to specify content from external applications. + CreateAndUpdateKnowledgeBases: + $ref: "#/components/schemas/CapabilityState" + ShareKnowledgeBases: + $ref: "#/components/schemas/CapabilityState" + SharePointKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateSharePointKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareSharePointKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseSharePointKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + GoogleDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateGoogleDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareGoogleDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseGoogleDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + WebCrawlerKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateWebCrawlerKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareWebCrawlerKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseWebCrawlerKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + S3KnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateS3KnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareS3KnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseS3KnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ConfluenceKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateConfluenceKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareConfluenceKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseConfluenceKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + OneDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateOneDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareOneDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseOneDriveKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + QBusinessKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateQBusinessKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareQBusinessKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseQBusinessKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + BedrockManagedKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateBedrockManagedKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareBedrockManagedKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseBedrockManagedKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + BoxKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateBoxKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareBoxKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseBoxKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + IDCKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + CreateAndUpdateIDCKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + ShareIDCKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" + UseIDCKnowledgeBase: + $ref: "#/components/schemas/CapabilityState" Action: $ref: "#/components/schemas/CapabilityState" description: The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems. @@ -20233,6 +22816,21 @@ components: Extension: $ref: "#/components/schemas/CapabilityState" description: The ability to perform Extension-related actions. + UseBrowserExtension: + $ref: "#/components/schemas/CapabilityState" + description: The ability to use Amazon Quick through the browser extension for Chrome, Firefox, and Edge. + UseWordAddInExtension: + $ref: "#/components/schemas/CapabilityState" + description: The ability to use Amazon Quick through the Microsoft Word add-in. + UseOutlookAddInExtension: + $ref: "#/components/schemas/CapabilityState" + description: The ability to use Amazon Quick through the Microsoft Outlook add-in. + UseExcelAddInExtension: + $ref: "#/components/schemas/CapabilityState" + description: The ability to use Amazon Quick through the Microsoft Excel add-in. + UsePowerpointAddInExtension: + $ref: "#/components/schemas/CapabilityState" + description: The ability to use Amazon Quick through the Microsoft PowerPoint add-in. ManageSharedFolders: $ref: "#/components/schemas/CapabilityState" description: "The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders. Note: This does not prevent inheriting access to assets that others share with them through folder membership." @@ -20245,10 +22843,32 @@ components: Scenario: $ref: "#/components/schemas/CapabilityState" description: The ability to perform Scenario-related actions. + Trigger: + $ref: "#/components/schemas/CapabilityState" + description: The ability to manage trigger-related settings for flows and automations. + ScheduleTrigger: + $ref: "#/components/schemas/CapabilityState" + description: The ability to create, view, edit, delete, and run schedule triggers for flows and automations. + InboundEmailTrigger: + $ref: "#/components/schemas/CapabilityState" + description: The ability to create, view, edit, delete, and run inbound email triggers for flows and automations. + QuickEventTrigger: + $ref: "#/components/schemas/CapabilityState" + description: The ability to create, view, edit, delete, and run Quick event triggers for flows and automations. CapabilityState: + description: "The permission state of a capability in a custom permissions profile. Valid values: DENY – Amazon Quick denies this capability for users assigned to the profile. ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only." type: string enum: - DENY + - ALLOW + Governance: + description: Contains the governance configuration for a custom permissions profile. When governance controls are defined for a category, any capabilities in that category not explicitly set to ALLOW in Capabilities are denied. Even newly added capabilities in the category are implicitly disabled when Amazon Quick releases them. + type: object + properties: + DefaultCategoryEffects: + type: object + properties: {} + description: A map of DefaultCategoryEffects. CreateCustomPermissionsResponse: type: object properties: @@ -20279,6 +22899,9 @@ components: DataSetReferences: $ref: "#/components/schemas/DataSetReferenceList" description: Dataset references. + TopicReferences: + $ref: "#/components/schemas/TopicReferenceList" + description: The topic references for the source template of a dashboard. Arn: $ref: "#/components/schemas/Arn" description: The Amazon Resource Name (ARN) of the resource. @@ -20455,6 +23078,9 @@ components: DataSetIdentifierDeclarations: $ref: "#/components/schemas/DataSetIdentifierDeclarationList" description: An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures. + TopicIdentifierDeclarations: + $ref: "#/components/schemas/TopicIdentifierDeclarationList" + description: An array of topic identifier declarations. With this mapping, you can use topic identifiers instead of topic Amazon Resource Names (ARNs) throughout the dashboard's sub-structures. Sheets: $ref: "#/components/schemas/SheetDefinitionList" description: An array of sheet definitions for a dashboard. @@ -20941,6 +23567,74 @@ components: type: object properties: {} description: A map of semantic tables that define the analytical structure. + SemanticMetadata: + $ref: "#/components/schemas/DataSetSemanticMetadataList" + description: The dataset-level semantic metadata, including a description and custom instructions. + DataSetSemanticMetadataList: + type: array + items: + $ref: "#/components/schemas/DataSetSemanticMetadata" + DataSetSemanticMetadata: + description: Semantic metadata for a dataset, including a description and custom instructions. + type: object + properties: + Description: + $ref: "#/components/schemas/DataSetSemanticDescription" + description: A description of the dataset. + CustomInstructions: + $ref: "#/components/schemas/CustomInstructionList" + description: A list of custom instructions that guide how the dataset should be consumed. + DataSetSemanticDescription: + description: A description structure for dataset-level semantic metadata. + type: object + properties: + Text: + $ref: "#/components/schemas/DataSetDescriptiveText" + description: The descriptive text for the dataset. + required: + - Text + DataSetDescriptiveText: + type: string + minLength: 1 + maxLength: 500 + CustomInstructionList: + type: array + items: + $ref: "#/components/schemas/CustomInstruction" + CustomInstruction: + description: A custom instruction that provides guidance on how the dataset should be consumed. + type: object + properties: + InlineCustomInstruction: + $ref: "#/components/schemas/InlineCustomInstruction" + description: An inline custom instruction containing text and optional uploaded document metadata. + InlineCustomInstruction: + description: An inline custom instruction with text content and optional file upload metadata. + type: object + properties: + InstructionText: + $ref: "#/components/schemas/InlineCustomInstructionText" + description: The instruction text content. + UploadedDocumentMetadata: + $ref: "#/components/schemas/UploadedDocumentMetadata" + description: Metadata about an uploaded document associated with this instruction. + required: + - InstructionText + InlineCustomInstructionText: + type: string + minLength: 0 + maxLength: 50000 + UploadedDocumentMetadata: + description: Metadata for an uploaded document associated with a custom instruction. + type: object + properties: + Name: + $ref: "#/components/schemas/UploadedDocumentName" + description: The name of the uploaded document. + UploadedDocumentName: + type: string + minLength: 1 + maxLength: 127 CreateDataSetResponse: type: object properties: @@ -21106,6 +23800,18 @@ components: QBusinessParameters: $ref: "#/components/schemas/QBusinessParameters" description: The parameters for Amazon Q Business. + SharePointParameters: + $ref: "#/components/schemas/SharePointParameters" + description: The parameters for a SharePoint data source. + GoogleDriveParameters: + $ref: "#/components/schemas/GoogleDriveParameters" + description: The parameters for a Google Drive data source. + OneDriveParameters: + $ref: "#/components/schemas/OneDriveParameters" + description: The parameters for an OneDrive data source. + FMKBParameters: + $ref: "#/components/schemas/FMKBParameters" + description: The parameters for a fully managed knowledge base data source. AmazonElasticsearchParameters: description: The parameters for OpenSearch. type: object @@ -21816,6 +24522,96 @@ components: minLength: 1 maxLength: 1284 pattern: ^arn:[-a-z0-9]*:qbusiness:[-a-z0-9]*:[0-9]{12}:application/.+ + SharePointParameters: + description: The connection parameters for a SharePoint data source. Provide these parameters in the DataSourceParameters object when you create or update a data source that uses SharePoint. + type: object + properties: + SharePointDomain: + $ref: "#/components/schemas/SharePointDomain" + description: The SharePoint domain for the data source. + TenantId: + $ref: "#/components/schemas/SharePointTenantId" + description: The tenant ID for the SharePoint data source. + ClientId: + $ref: "#/components/schemas/SharePointClientId" + description: The client ID for the SharePoint data source. + AuthType: + $ref: "#/components/schemas/AuthType" + description: "The authentication type for the SharePoint data source. Valid values include: TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction. THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent." + required: + - SharePointDomain + SharePointDomain: + type: string + minLength: 1 + maxLength: 1024 + SharePointTenantId: + type: string + minLength: 1 + maxLength: 100 + SharePointClientId: + type: string + minLength: 1 + maxLength: 100 + AuthType: + type: string + enum: + - THREE_LEGGED_OAUTH + - TWO_LEGGED_OAUTH + - SERVICE_ACCOUNT + GoogleDriveParameters: + description: The connection parameters for a Google Drive data source. Provide these parameters in the DataSourceParameters object when you create or update a data source that uses Google Drive. + type: object + properties: + AuthType: + $ref: "#/components/schemas/AuthType" + description: "The authentication type for the Google Drive data source. Valid values include: SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key. THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent." + OneDriveParameters: + description: The connection parameters for an OneDrive data source. Provide these parameters in the DataSourceParameters object when you create or update a data source that uses OneDrive. + type: object + properties: + TenantId: + $ref: "#/components/schemas/OneDriveTenantId" + description: The tenant ID for the OneDrive data source. + ClientId: + $ref: "#/components/schemas/OneDriveClientId" + description: The client ID for the OneDrive data source. + AuthType: + $ref: "#/components/schemas/AuthType" + description: "The authentication type for the OneDrive data source. Valid values include: TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction. THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent." + OneDriveTenantId: + type: string + minLength: 1 + maxLength: 100 + OneDriveClientId: + type: string + minLength: 1 + maxLength: 100 + FMKBParameters: + description: The connection parameters for a fully managed knowledge base data source. Provide these parameters in the DataSourceParameters object when you create or update a data source that uses a fully managed knowledge base. + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/FMKBKnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base. + LinkedDataSourceIds: + $ref: "#/components/schemas/LinkedDataSourceIds" + description: The IDs of the linked data sources. + required: + - KnowledgeBaseArn + FMKBKnowledgeBaseArn: + type: string + minLength: 47 + maxLength: 128 + pattern: ^arn:aws(-cn|-us-gov)?:bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+ + LinkedDataSourceIds: + type: array + items: + $ref: "#/components/schemas/LinkedDataSourceId" + LinkedDataSourceId: + type: string + minLength: 1 + maxLength: 10 + pattern: ^[0-9a-zA-Z]+$ DataSourceCredentials: description: Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. type: object @@ -21928,10 +24724,12 @@ components: type: string minLength: 1 maxLength: 256 + pattern: "[^\\p{Cc}]+" OAuthClientSecret: type: string minLength: 1 maxLength: 2048 + pattern: "[^\\p{Cc}]+" OAuthUsername: type: string minLength: 1 @@ -21961,6 +24759,179 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + DlpSettingId: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9\\-_]+" + DlpSettingName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[A-Za-z0-9](?:[\\w- &]*[A-Za-z0-9])?" + DlpProviderType: + type: string + enum: + - MICROSOFT_PURVIEW + ProviderConfig: + description: The provider-specific configuration for a DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined. + type: object + properties: + MicrosoftPurview: + $ref: "#/components/schemas/MicrosoftPurviewProviderConfig" + description: The configuration for a Microsoft Purview DLP integration. + MicrosoftPurviewProviderConfig: + description: The full configuration for Microsoft Purview DLP integration, including the provider credentials and the label-action mappings that define the enforcement policy. + type: object + properties: + Credentials: + $ref: "#/components/schemas/MicrosoftPurviewCredentials" + description: The credentials used to authenticate with Microsoft Purview. + LabelActionMappings: + $ref: "#/components/schemas/LabelActionMappingList" + description: The mappings from Microsoft Purview sensitivity labels to enforcement actions. + UnmappedAction: + $ref: "#/components/schemas/DlpAction" + description: The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW, BLOCK, and WARN. + required: + - Credentials + - LabelActionMappings + - UnmappedAction + MicrosoftPurviewCredentials: + description: The credentials for Microsoft Purview DLP integration. The credentials are stored in Amazon Web Services Secrets Manager and referenced by ARN. + type: object + properties: + SecretArn: + $ref: "#/components/schemas/SecretManagerArn" + description: The ARN of the Amazon Web Services Secrets Manager secret that contains the Microsoft Purview OAuth credentials. The secret includes the Azure tenant ID, client ID, and client secret or certificate. + required: + - SecretArn + SecretManagerArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws(-[\w]+)*:secretsmanager:[a-z0-9\-]+:\d{12}:secret:.+ + LabelActionMappingList: + type: array + items: + $ref: "#/components/schemas/LabelActionMapping" + LabelActionMapping: + description: Maps a sensitivity label from Microsoft Purview to an enforcement action. + type: object + properties: + LabelId: + $ref: "#/components/schemas/LabelId" + description: The identifier of the sensitivity label from the DLP provider. + LabelName: + $ref: "#/components/schemas/LabelName" + description: The display name of the sensitivity label from the DLP provider. + Action: + $ref: "#/components/schemas/DlpAction" + description: The enforcement action to apply when content with this sensitivity label is detected. Valid values are ALLOW, BLOCK, and WARN. + required: + - LabelId + - LabelName + - Action + LabelId: + type: string + minLength: 1 + maxLength: 512 + LabelName: + type: string + minLength: 1 + maxLength: 512 + DlpAction: + type: string + enum: + - ALLOW + - WARN + - BLOCK + CreateDlpSettingResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the created DLP setting. + DlpSettingId: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the created DLP setting. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - DlpSettingId + AccountId: + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]{12}" + TitleInput: + type: string + minLength: 1 + maxLength: 128 + pattern: (?!\s+$)[^{}"\\<>]* + FlowDescriptionInput: + type: string + minLength: 0 + maxLength: 1024 + pattern: (?!\s+$)[^{}"\\<>]* + SensitiveDocument: + type: object + PermissionsList: + type: array + items: + $ref: "#/components/schemas/Permission" + Permission: + description: A structure that contains the permission information for one principal against one flow. + type: object + properties: + Actions: + $ref: "#/components/schemas/ActionsList" + description: "A list of actions that the principal can perform against the flow. The following are the list of values to set a principal as a flow owner: quicksight:PublishFlow quicksight:GetFlow quicksight:UpdateFlowPermissions quicksight:GetFlowSession quicksight:StartFlowSession quicksight:StopFlowSession quicksight:UpdateFlowSession quicksight:UnpublishFlow quicksight:GetFlowStages quicksight:DeleteFlow quicksight:DescribeFlowPermissions quicksight:UpdateFlow quicksight:CreatePresignedUrl The following are the list of values to set a principal as a flow viewer: quicksight:GetFlow quicksight:UpdateFlowSession quicksight:StartFlowSession quicksight:StopFlowSession quicksight:GetFlowSession quicksight:CreatePresignedUrl quicksight:GetFlowStages" + Principal: + $ref: "#/components/schemas/PermissionPrincipalString" + description: The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions. + required: + - Actions + - Principal + ActionsList: + type: array + items: + $ref: "#/components/schemas/ActionsListMemberString" + ActionsListMemberString: + type: string + minLength: 1 + maxLength: 64 + PermissionPrincipalString: + type: string + minLength: 1 + maxLength: 256 + CreateFlowRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateFlowResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the flow. + FlowId: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - Arn + - FlowId + FlowId: + type: string + pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" RestrictiveResourceId: type: string minLength: 1 @@ -22160,6 +25131,166 @@ components: - FAILED - COMPLETED - CANCELLED + KnowledgeBaseName: + type: string + minLength: 0 + maxLength: 128 + pattern: "[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.]*" + DataSourceArn: + type: string + minLength: 0 + maxLength: 1284 + pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} + KnowledgeBaseConfiguration: + description: The configuration settings for a knowledge base. + type: object + properties: + templateConfiguration: + $ref: "#/components/schemas/KbTemplateConfiguration" + description: The template configuration that defines how the data source connector crawls and indexes data for the knowledge base. The template structure varies by connector type. See KbTemplateConfiguration for connector-specific details. + KbTemplateConfiguration: + description: The template configuration for a knowledge base. This object contains connector-specific configuration that defines how data is crawled and indexed. + type: object + properties: + template: + $ref: "#/components/schemas/KbTemplate" + description: "The connector configuration for the knowledge base data source. The structure depends on the connector type of the data source referenced by DataSourceArn. The template must be a JSON object. The required fields vary by connector type: Amazon S3 (S3V2) – Requires connectionConfiguration with bucketName. Supports filterConfiguration for inclusion and exclusion prefixes and patterns. Supports accessControlConfiguration and deletionProtectionConfiguration. Google Drive (GOOGLEDRIVEV3) – Requires connectionConfiguration with authType set to SERVICE_ACCOUNT. Supports dataEntityConfiguration with crawlMyDrive, crawlSharedWithMe, and crawlSharedDrives. OneDrive (ONEDRIVEV3) – Requires authType at the template root level set to TWO_LEGGED_OAUTH. Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with crawlPersonalDrives and crawlSharedWithMe. SharePoint (SHAREPOINTV3) – Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with siteUrls, crawlFiles, and crawlPages. Web Crawler (WEBCRAWLERV3) – Requires connectionConfiguration with seedUrls or siteMapUrls (mutually exclusive) and authType. Supports crawlConfiguration for crawl depth, rate limits, and scope. Supports filterConfiguration for file size limits and URL patterns. Valid values for authType: NO_AUTH, BASIC_AUTH, FORM, SAML. The optional deletionProtectionConfiguration object is supported by all connector types. It contains enableDeletionProtection and deletionProtectionThreshold." + KbTemplate: + type: object + KnowledgeBaseDescription: + type: string + minLength: 0 + maxLength: 1000 + pattern: \P{C}* + MediaExtractionConfiguration: + description: The configuration for media extraction from knowledge base documents. + type: object + properties: + imageExtractionConfiguration: + $ref: "#/components/schemas/ImageExtractionConfiguration" + description: The configuration for image extraction. + audioExtractionConfiguration: + $ref: "#/components/schemas/AudioExtractionConfiguration" + description: The configuration for audio extraction. + videoExtractionConfiguration: + $ref: "#/components/schemas/VideoExtractionConfiguration" + description: The configuration for video extraction. + ImageExtractionConfiguration: + description: The configuration for image extraction from knowledge base documents. + type: object + properties: + imageExtractionStatus: + $ref: "#/components/schemas/ImageExtractionStatus" + description: The status of image extraction. Valid values are ENABLED and DISABLED. + required: + - imageExtractionStatus + ImageExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + AudioExtractionConfiguration: + description: The configuration for audio extraction from knowledge base documents. + type: object + properties: + audioExtractionStatus: + $ref: "#/components/schemas/AudioExtractionStatus" + description: The status of audio extraction. Valid values are ENABLED and DISABLED. + required: + - audioExtractionStatus + AudioExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + VideoExtractionConfiguration: + description: The configuration for video extraction from knowledge base documents. + type: object + properties: + videoExtractionStatus: + $ref: "#/components/schemas/VideoExtractionStatus" + description: The status of video extraction. Valid values are ENABLED and DISABLED. + videoExtractionType: + $ref: "#/components/schemas/VideoExtractionType" + description: The type of video extraction to perform. + required: + - videoExtractionStatus + VideoExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + VideoExtractionType: + type: string + enum: + - AUDIO_TRANSCRIPTION_ONLY + - VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION + AccessControlConfiguration: + description: The access control settings for a knowledge base. Use this structure to enable or disable document-level access control lists (ACLs) that filter query results based on the permissions from the source data connector. + type: object + properties: + isACLEnabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether ACLs are enabled for the knowledge base. + CreateKnowledgeBaseResponse: + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + CreationStatus: + $ref: "#/components/schemas/DataSetStatus" + description: The creation status of the knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + - CreationStatus + DataSetStatus: + type: string + enum: + - CREATING + - UPDATING + - ACTIVE + - FAILED + - DELETING + ProfileName: + type: string + minLength: 1 + maxLength: 256 + ProfileDescription: + type: string + minLength: 0 + maxLength: 1024 + CreateLimitsProfileRequestResourceLimitsMap: + type: object + properties: {} + CreateLimitsProfileRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + CreateLimitsProfileResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the created limits profile. + profileId: + $ref: "#/components/schemas/ProfileId" + description: The unique identifier for the created limits profile. + required: + - arn + - profileId + ResourceArn: + type: string IdentityStore: type: string enum: @@ -22196,6 +25327,48 @@ components: - DELETING - RETRYABLE_FAILURE - NON_RETRYABLE_FAILURE + OAuthClientApplicationId: + type: string + minLength: 1 + maxLength: 256 + pattern: "[^/][^\\p{Cc}]*" + OAuthClientAuthenticationType: + type: string + enum: + - TOKEN + OAuthTokenEndpointUrl: + type: string + minLength: 1 + maxLength: 2048 + pattern: ^https://[^\p{Cc}]+ + OAuthAuthorizationEndpointUrl: + type: string + minLength: 1 + maxLength: 2048 + pattern: ^https://[^\p{Cc}]+ + OAuthScopesString: + type: string + minLength: 1 + maxLength: 4096 + pattern: "[^\\p{Cc}]+" + CreateOAuthClientApplicationResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the OAuthClientApplication. + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + CreationStatus: + $ref: "#/components/schemas/ResourceStatus" + description: The status of creating the OAuthClientApplication. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. RefreshSchedule: description: The refresh schedule of a dataset. type: object @@ -22304,6 +25477,40 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + PublicSpaceId: + type: string + minLength: 1 + maxLength: 256 + pattern: "[0-9a-zA-Z-_=.+]+" + SpaceName: + type: string + minLength: 1 + maxLength: 1000 + pattern: "[\\P{C}\\n\\r\\t\\f\\v\\p{Cf}]*" + SpaceDescription: + type: string + minLength: 0 + maxLength: 1000 + pattern: "[\\P{C}\\n\\r\\t\\f\\v\\p{Cf}]*" + CreateSpaceResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + PublicSpaceArn: + type: string + minLength: 0 + maxLength: 512 + pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} TemplateName: type: string minLength: 1 @@ -22328,6 +25535,9 @@ components: DataSetReferences: $ref: "#/components/schemas/DataSetReferenceList" description: A structure containing information about the dataset references used as placeholders in the template. + TopicReferences: + $ref: "#/components/schemas/TopicReferenceList" + description: A structure containing information about the topic references used as placeholders in the template. required: - Arn - DataSetReferences @@ -22347,6 +25557,9 @@ components: DataSetConfigurations: $ref: "#/components/schemas/DataSetConfigurationList" description: An array of dataset configurations. These configurations define the required columns for each dataset used within a template. + TopicConfigurations: + $ref: "#/components/schemas/TopicConfigurationList" + description: An array of topic configurations. These configurations define the required columns for each topic used within a template. Sheets: $ref: "#/components/schemas/SheetDefinitionList" description: An array of sheet definitions for a template. @@ -22443,6 +25656,23 @@ components: Name: $ref: "#/components/schemas/String" description: The name of the column group's column schema. + TopicConfigurationList: + type: array + items: + $ref: "#/components/schemas/TopicConfiguration" + TopicConfiguration: + description: The configuration of a topic. + type: object + properties: + Placeholder: + $ref: "#/components/schemas/String" + description: The placeholder for the topic configuration. + DataSetSchema: + $ref: "#/components/schemas/DataSetSchema" + description: Topic schema. + ColumnGroupSchemaList: + $ref: "#/components/schemas/ColumnGroupSchemaList" + description: The list of column group schemas in the topic configuration. CreateTemplateResponse: type: object properties: @@ -22863,7 +26093,7 @@ components: type: object properties: FilterDescription: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/DescriptionSensitiveString" description: A description of the filter used to select items for a topic. FilterClass: $ref: "#/components/schemas/FilterClass" @@ -22901,10 +26131,18 @@ components: required: - FilterName - OperandFieldName + DescriptionSensitiveString: + type: string + minLength: 0 + maxLength: 500 Synonyms: type: array items: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/SynonymString" + SynonymString: + type: string + minLength: 0 + maxLength: 256 NamedFilterType: type: string enum: @@ -22930,6 +26168,9 @@ components: Inverse: $ref: "#/components/schemas/Boolean" description: A Boolean value that indicates if the filter is inverse. + NullFilter: + $ref: "#/components/schemas/NullFilterType" + description: The null filter that is applied to the category filter. CategoryFilterFunction: type: string enum: @@ -22949,7 +26190,7 @@ components: $ref: "#/components/schemas/ConstantType" description: The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE. SingularConstant: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: A singular constant used in a category filter. This element is used to specify a single value for the constant. CollectiveConstant: $ref: "#/components/schemas/CollectiveConstant" @@ -22965,6 +26206,12 @@ components: type: array items: $ref: "#/components/schemas/String" + NullFilterType: + type: string + enum: + - ALL_VALUES + - NON_NULLS_ONLY + - NULLS_ONLY TopicNumericEqualityFilter: description: A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value. type: object @@ -22975,6 +26222,12 @@ components: Aggregation: $ref: "#/components/schemas/NamedFilterAggType" description: An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP. + Inverse: + $ref: "#/components/schemas/Boolean" + description: A Boolean value that indicates if the filter is inverse. + NullFilter: + $ref: "#/components/schemas/NullFilterType" + description: The null filter that is applied to the numeric equality filter. TopicSingularFilterConstant: description: A structure that represents a singular filter constant, used in filters to specify a single value to match against. type: object @@ -22983,7 +26236,7 @@ components: $ref: "#/components/schemas/ConstantType" description: The type of the singular filter constant. Valid values for this structure are SINGULAR. SingularConstant: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The value of the singular filter constant. NamedFilterAggType: type: string @@ -23013,6 +26266,12 @@ components: Aggregation: $ref: "#/components/schemas/NamedFilterAggType" description: An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP. + Inverse: + $ref: "#/components/schemas/Boolean" + description: A Boolean value that indicates if the filter is inverse. + NullFilter: + $ref: "#/components/schemas/NullFilterType" + description: The null filter that is applied to the numeric range filter. TopicRangeFilterConstant: description: A constant value that is used in a range filter to specify the endpoints of the range. type: object @@ -23028,10 +26287,10 @@ components: type: object properties: Minimum: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The minimum value for a range constant. Maximum: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The maximum value for a range constant. TopicDateRangeFilter: description: A filter used to restrict data based on a range of dates or times. @@ -23043,6 +26302,9 @@ components: Constant: $ref: "#/components/schemas/TopicRangeFilterConstant" description: The constant used in a date range filter. + NullFilter: + $ref: "#/components/schemas/NullFilterType" + description: The null filter that is applied to the date range filter. TopicRelativeDateFilter: description: A structure that represents a relative date filter. type: object @@ -23056,6 +26318,9 @@ components: Constant: $ref: "#/components/schemas/TopicSingularFilterConstant" description: The constant used in a relative date filter. + NullFilter: + $ref: "#/components/schemas/NullFilterType" + description: The null filter that is applied to the relative date filter. TopicRelativeDateFilterFunction: type: string enum: @@ -23076,12 +26341,6 @@ components: Inverse: $ref: "#/components/schemas/Boolean" description: A Boolean value that indicates if the filter is inverse. - NullFilterType: - type: string - enum: - - ALL_VALUES - - NON_NULLS_ONLY - - NULLS_ONLY TopicColumns: type: array items: @@ -23094,10 +26353,10 @@ components: $ref: "#/components/schemas/LimitedString" description: The name of the column. ColumnFriendlyName: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: A user-friendly name for the column. ColumnDescription: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/DescriptionSensitiveString" description: A description of the column and its contents. ColumnSynonyms: $ref: "#/components/schemas/Synonyms" @@ -23252,10 +26511,10 @@ components: type: object properties: CellValue: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/SynonymString" description: The cell value. Synonyms: - $ref: "#/components/schemas/StringList" + $ref: "#/components/schemas/SensitiveStringList" description: Other names or aliases for the cell value. TopicCalculatedFields: type: array @@ -23266,10 +26525,10 @@ components: type: object properties: CalculatedFieldName: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The calculated field name. CalculatedFieldDescription: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/DescriptionSensitiveString" description: The calculated field description. Expression: $ref: "#/components/schemas/Expression" @@ -23331,7 +26590,7 @@ components: $ref: "#/components/schemas/LimitedString" description: The name of the named entity. EntityDescription: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/DescriptionSensitiveString" description: The description of the named entity. EntitySynonyms: $ref: "#/components/schemas/Synonyms" @@ -23342,6 +26601,15 @@ components: Definition: $ref: "#/components/schemas/NamedEntityDefinitions" description: The definition of a named entity. + Sort: + $ref: "#/components/schemas/NamedEntitySortList" + description: The sort configuration of the named entity. + RankOrder: + $ref: "#/components/schemas/NullableInteger" + description: The rank order of the named entity. + PresentationOrder: + $ref: "#/components/schemas/NullableInteger" + description: The presentation order of the named entity. required: - EntityName SemanticEntityType: @@ -23381,6 +26649,15 @@ components: Metric: $ref: "#/components/schemas/NamedEntityDefinitionMetric" description: The definition of a metric. + RankOrder: + $ref: "#/components/schemas/NullableInteger" + description: The rank order of the named entity definition. + PresentationOrder: + $ref: "#/components/schemas/NullableInteger" + description: The presentation order of the named entity definition. + IsHidden: + $ref: "#/components/schemas/NullableBoolean" + description: A Boolean value that indicates whether the named entity definition is hidden. PropertyRole: type: string enum: @@ -23419,6 +26696,25 @@ components: - PERCENTILE - MEDIAN - CUSTOM + NullableInteger: + type: integer + NamedEntitySortList: + type: array + items: + $ref: "#/components/schemas/NamedEntitySort" + NamedEntitySort: + description: A structure that represents a sort for a named entity. + type: object + properties: + FieldName: + $ref: "#/components/schemas/LimitedString" + description: The name of the field that is used for the sort. + Direction: + $ref: "#/components/schemas/TopicSortDirection" + description: The direction of the sort. Valid values are ASCENDING and DESCENDING. + required: + - FieldName + - Direction TopicConfigOptions: description: Configuration options for a Topic. type: object @@ -23506,6 +26802,89 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + TopicV2Details: + description: The definition of a topic. + type: object + properties: + Name: + $ref: "#/components/schemas/ResourceName" + description: The name of the topic. + Description: + $ref: "#/components/schemas/LimitedString" + description: The description of the topic. + DataSets: + $ref: "#/components/schemas/TopicV2DataSetReferences" + description: The data sets that the topic is associated with. + DataSetRelations: + $ref: "#/components/schemas/TopicV2DataSetRelationList" + description: The relations between the data sets that the topic is associated with. + required: + - Name + TopicV2DataSetReferences: + type: array + items: + $ref: "#/components/schemas/TopicV2DataSetReference" + TopicV2DataSetReference: + description: A structure that represents a data set reference of a topic. + type: object + properties: + DataSetArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the data set. + DataSetName: + $ref: "#/components/schemas/LimitedString" + description: The name of the data set. + required: + - DataSetArn + TopicV2DataSetRelationList: + type: array + items: + $ref: "#/components/schemas/TopicV2DataSetRelation" + TopicV2DataSetRelation: + description: A structure that represents a relation between two data sets of a topic. + type: object + properties: + Left: + $ref: "#/components/schemas/TopicV2DataSetRelationEndpoint" + description: The left endpoint of the data set relation. + Right: + $ref: "#/components/schemas/TopicV2DataSetRelationEndpoint" + description: The right endpoint of the data set relation. + required: + - Left + - Right + TopicV2DataSetRelationEndpoint: + description: A structure that represents an endpoint of a data set relation of a topic. + type: object + properties: + DataSetArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the data set at this endpoint of the relation. + ColumnNames: + $ref: "#/components/schemas/TopicV2DataSetRelationColumnNames" + description: The names of the columns that are used in the data set relation. + required: + - DataSetArn + - ColumnNames + TopicV2DataSetRelationColumnNames: + type: array + items: + $ref: "#/components/schemas/String" + CreateTopicV2Response: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. VPCConnectionResourceIdRestricted: type: string minLength: 1 @@ -23618,6 +26997,12 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status code of the request. + DeleteAgentResponse: + type: object + properties: + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. RecoveryWindowInDays: type: integer format: int64 @@ -23641,6 +27026,8 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + DeleteApprovalPolicyResponse: + type: object DeleteBrandResponse: type: object properties: @@ -23728,6 +27115,30 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + DeleteDlpSettingResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the deleted DLP setting. + DlpSettingId: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the deleted DLP setting. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - DlpSettingId + DeleteFlowResponse: + type: object + properties: + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. DeleteFolderResponse: type: object properties: @@ -23788,6 +27199,7 @@ components: - REDSHIFT - QBUSINESS - ATHENA + - GLUE_DATA_CATALOG DeleteIdentityPropagationConfigResponse: type: object properties: @@ -23797,6 +27209,32 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + DeleteKnowledgeBaseResponse: + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The ARN of the deleted knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The ID of the deleted knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + DeleteLimitsProfileResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the deleted limits profile. + required: + - arn DeleteNamespaceResponse: type: object properties: @@ -23806,6 +27244,21 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + DeleteOAuthClientApplicationResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the OAuthClientApplication that you deleted. + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. DeleteRefreshScheduleResponse: type: object properties: @@ -23839,6 +27292,20 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + DeleteSpaceResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId DeleteTemplateResponse: type: object properties: @@ -23938,6 +27405,21 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + DeleteTopicV2Response: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. UserName: type: string minLength: 1 @@ -24329,8 +27811,6 @@ components: required: - RoleArn - SourceArn - ResourceArn: - type: string ActionIdList: type: array items: @@ -24356,6 +27836,143 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status code of the request. + DescribeAgentResponse: + type: object + properties: + Agent: + $ref: "#/components/schemas/Agent" + description: The full details of the agent, including its configuration, status, and associations. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Agent + Agent: + description: An agent resource in Amazon QuickSight that provides AI-powered conversational experiences. + type: object + properties: + Spaces: + $ref: "#/components/schemas/AgentSpacesList" + description: The Amazon Resource Names (ARNs) of the spaces attached to the agent. + ActionConnectors: + $ref: "#/components/schemas/AgentActionConnectorsList" + description: The Amazon Resource Names (ARNs) of the action connectors attached to the agent. + Description: + $ref: "#/components/schemas/AgentDescription" + description: A description of the agent. + IconId: + $ref: "#/components/schemas/IconId" + description: The icon identifier for the agent. + Name: + $ref: "#/components/schemas/AgentName" + description: The name of the agent. + StarterPrompts: + $ref: "#/components/schemas/StarterPromptList" + description: A list of starter prompts that are displayed to users when they begin interacting with the agent. + WelcomeMessage: + $ref: "#/components/schemas/WelcomeMessage" + description: The welcome message that is displayed when a user starts a conversation with the agent. + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + AgentLifecycle: + $ref: "#/components/schemas/AgentLifecycle" + description: The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED. + AgentStatus: + $ref: "#/components/schemas/AgentStatus" + description: The status of the agent. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the agent was created. + Creator: + $ref: "#/components/schemas/String" + description: The identity of the user who created the agent. + CustomPromptInterface: + $ref: "#/components/schemas/CustomPromptInterface" + description: The custom prompt interface configuration for the agent. + ErrorMessage: + $ref: "#/components/schemas/String" + description: An error message associated with the agent, if applicable. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the agent was last updated. + required: + - Name + - Arn + - AgentId + - AgentLifecycle + - AgentStatus + - CreatedAt + - Creator + - UpdatedAt + AgentSpacesList: + type: array + items: + $ref: "#/components/schemas/Arn" + AgentActionConnectorsList: + type: array + items: + $ref: "#/components/schemas/Arn" + CustomPromptInterface: + description: The custom prompt interface configuration that defines how an agent's prompt is configured. + type: object + properties: + ModelProfileId: + $ref: "#/components/schemas/ModelProfileId" + description: The identifier of the model profile. + SubscriptionId: + $ref: "#/components/schemas/SubscriptionId" + description: The subscription identifier. + QbsAwsAccountId: + $ref: "#/components/schemas/QbsAwsAccountId" + description: The Amazon Web Services account ID for the Q Business service. + ResponseLength: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired response length. + OutputStyle: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired output style. + Identity: + $ref: "#/components/schemas/StyleDescription" + description: Instructions that define the agent's identity and persona. + Tone: + $ref: "#/components/schemas/StyleDescription" + description: Instructions for the desired tone of responses. + CustomInstructions: + $ref: "#/components/schemas/StyleDescription" + description: Custom instructions for the agent's behavior. + promptSummary: + $ref: "#/components/schemas/SensitiveText" + description: A summary of the custom prompt configuration. + required: + - ModelProfileId + - SubscriptionId + - QbsAwsAccountId + SensitiveText: + type: string + DescribeAgentPermissionsResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: The resource permissions for the agent. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - AgentId + - Permissions + - RequestId DescribeAnalysisResponse: type: object properties: @@ -24390,6 +28007,9 @@ components: DataSetArns: $ref: "#/components/schemas/DataSetArnsList" description: The ARNs of the datasets of the analysis. + TopicArns: + $ref: "#/components/schemas/TopicArnsList" + description: The ARNs of the topics associated with the analysis. ThemeArn: $ref: "#/components/schemas/Arn" description: The ARN of the theme of the analysis. @@ -24443,6 +28063,10 @@ components: Path: $ref: "#/components/schemas/NonEmptyString" description: The hierarchical path of the entity within the analysis, template, or dashboard definition tree. + TopicArnsList: + type: array + items: + $ref: "#/components/schemas/Arn" SheetList: type: array items: @@ -24509,6 +28133,14 @@ components: type: array items: $ref: "#/components/schemas/ResourcePermission" + DescribeApprovalPolicyResponse: + type: object + properties: + Policy: + $ref: "#/components/schemas/ApprovalPolicy" + description: The approval policy. + required: + - Policy DescribeAssetBundleExportJobResponse: type: object properties: @@ -24636,6 +28268,9 @@ components: Folders: $ref: "#/components/schemas/AssetBundleExportJobFolderOverridePropertiesList" description: An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template. + TopicsV2: + $ref: "#/components/schemas/AssetBundleExportJobTopicV2OverridePropertiesList" + description: An optional list of structures that controls how Topic resources are parameterized in the returned CloudFormation template. AssetBundleExportJobResourceIdOverrideConfiguration: description: An optional structure that configures resource ID overrides for the export job. type: object @@ -24864,6 +28499,32 @@ components: enum: - Name - ParentFolderArn + AssetBundleExportJobTopicV2OverridePropertiesList: + type: array + items: + $ref: "#/components/schemas/AssetBundleExportJobTopicV2OverrideProperties" + AssetBundleExportJobTopicV2OverrideProperties: + description: Controls how a specific Topic resource is parameterized in the returned CloudFormation template. + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The ARN of the specific Topic resource whose override properties are configured in this structure. + Properties: + $ref: "#/components/schemas/AssetBundleExportJobTopicV2PropertyToOverrideList" + description: A list of Topic resource properties to generate variables for in the returned CloudFormation template. + required: + - Arn + - Properties + AssetBundleExportJobTopicV2PropertyToOverrideList: + type: array + items: + $ref: "#/components/schemas/AssetBundleExportJobTopicV2PropertyToOverride" + AssetBundleExportJobTopicV2PropertyToOverride: + type: string + enum: + - Name + - Description AssetBundleExportJobValidationStrategy: description: The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors. type: object @@ -25013,6 +28674,9 @@ components: Folders: $ref: "#/components/schemas/AssetBundleImportJobFolderOverrideParametersList" description: A list of overrides for any Folder resources that are present in the asset bundle that is imported. + TopicsV2: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverrideParametersList" + description: A list of overrides for any Topic resources that are present in the asset bundle that is imported. AssetBundleImportJobResourceIdOverrideConfiguration: description: An optional structure that configures resource ID overrides for the import job. type: object @@ -25275,6 +28939,30 @@ components: description: A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved. required: - FolderId + AssetBundleImportJobTopicV2OverrideParametersList: + type: array + items: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverrideParameters" + AssetBundleImportJobTopicV2OverrideParameters: + description: The override parameters for a single topic that is being imported. + type: object + properties: + TopicId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the topic that you want to apply overrides to. + Name: + $ref: "#/components/schemas/ResourceName" + description: A new name for the topic. + Description: + $ref: "#/components/schemas/TopicDescription" + description: A new description for the topic. + required: + - TopicId + TopicDescription: + type: string + minLength: 1 + maxLength: 256 + pattern: .*\S.* AssetBundleImportFailureAction: type: string enum: @@ -25302,6 +28990,9 @@ components: Folders: $ref: "#/components/schemas/AssetBundleImportJobFolderOverridePermissionsList" description: A list of permissions for the folders that you want to apply overrides to. + TopicsV2: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverridePermissionsList" + description: A list of permissions for the topics that you want to apply overrides to. AssetBundleImportJobDataSourceOverridePermissionsList: type: array items: @@ -25435,6 +29126,23 @@ components: $ref: "#/components/schemas/AssetBundleResourcePermissions" required: - FolderIds + AssetBundleImportJobTopicV2OverridePermissionsList: + type: array + items: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverridePermissions" + AssetBundleImportJobTopicV2OverridePermissions: + description: An object that contains a list of permissions to be applied to a list of topic IDs. + type: object + properties: + TopicIds: + $ref: "#/components/schemas/AssetBundleRestrictiveResourceIdList" + description: A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle. + Permissions: + $ref: "#/components/schemas/AssetBundleResourcePermissions" + description: A list of permissions for the topics that you want to apply overrides to. + required: + - TopicIds + - Permissions AssetBundleImportJobOverrideTags: description: A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported. type: object @@ -25460,6 +29168,9 @@ components: Folders: $ref: "#/components/schemas/AssetBundleImportJobFolderOverrideTagsList" description: A list of tag overrides for any Folder resources that are present in the asset bundle that is imported. + TopicsV2: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverrideTagsList" + description: A list of tag overrides for any Topic resources that are present in the asset bundle that is imported. AssetBundleImportJobVPCConnectionOverrideTagsList: type: array items: @@ -25579,6 +29290,23 @@ components: required: - FolderIds - Tags + AssetBundleImportJobTopicV2OverrideTagsList: + type: array + items: + $ref: "#/components/schemas/AssetBundleImportJobTopicV2OverrideTags" + AssetBundleImportJobTopicV2OverrideTags: + description: An object that contains a list of tags to be assigned to a list of topic IDs. + type: object + properties: + TopicIds: + $ref: "#/components/schemas/AssetBundleRestrictiveResourceIdList" + description: A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle. + Tags: + $ref: "#/components/schemas/TagList" + description: A list of tags for the topics that you want to apply overrides to. + required: + - TopicIds + - Tags AssetBundleImportJobOverrideValidationStrategy: description: An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported. type: object @@ -25704,6 +29432,9 @@ components: Capabilities: $ref: "#/components/schemas/Capabilities" description: A set of actions in the custom permissions profile. + Governance: + $ref: "#/components/schemas/Governance" + description: The governance configuration for the custom permissions profile. When you enable governance for a category, Amazon Quick denies access to any current or new capability in that category unless you explicitly set that capability to ALLOW in Capabilities. DescribeDashboardResponse: type: object properties: @@ -25768,7 +29499,10 @@ components: description: Source entity ARN. DataSetArns: $ref: "#/components/schemas/DataSetArnsList" - description: The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard. + description: The Amazon Resource Names (ARNs) for the datasets that are associated with this version of the dashboard. + TopicArns: + $ref: "#/components/schemas/TopicArnsList" + description: The Amazon Resource Names (ARNs) for the topics that are associated with this version of the dashboard. Description: $ref: "#/components/schemas/VersionDescription" description: Description. @@ -26379,6 +30113,12 @@ components: SecretArn: $ref: "#/components/schemas/SecretArn" description: The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager. + CredentialStatus: + $ref: "#/components/schemas/CredentialStatus" + description: "The credential verification status of the data source. Valid values include: CONNECTED – Credential validation succeeded. AUTH_FAILED – Credential validation failed. NOT_VERIFIED – Credential validation has not been performed." + LastCredentialVerifiedAt: + $ref: "#/components/schemas/Timestamp" + description: The time that the credentials were last verified. DataSourceErrorInfo: description: Error information for the data source creation or update. type: object @@ -26400,6 +30140,12 @@ components: - GENERIC_SQL_FAILURE - CONFLICT - UNKNOWN + CredentialStatus: + type: string + enum: + - CONNECTED + - AUTH_FAILED + - NOT_VERIFIED DescribeDataSourcePermissionsResponse: type: object properties: @@ -26430,6 +30176,156 @@ components: ApplicationId: $ref: "#/components/schemas/String" description: The ID of the Amazon Q Business application that is linked to the Quick Sight account. + DescribeDlpSettingResponse: + type: object + properties: + DlpSetting: + $ref: "#/components/schemas/DlpSettingDetails" + description: The full configuration of the requested DLP setting, returned as a DlpSettingDetails object. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - DlpSetting + DlpSettingDetails: + description: The full configuration details of a DLP setting. + type: object + properties: + DlpSettingId: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the DLP setting. + Name: + $ref: "#/components/schemas/DlpSettingName" + description: The display name of the DLP setting. + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the DLP setting. + Status: + $ref: "#/components/schemas/DlpSettingStatus" + description: The status of the DLP setting. Valid values are ACTIVE and INACTIVE. + ProviderType: + $ref: "#/components/schemas/DlpProviderType" + description: The type of external DLP provider used for sensitivity label classification. + ProviderConfig: + $ref: "#/components/schemas/ProviderConfig" + description: The provider-specific configuration for the DLP integration. + ProviderOutageAction: + $ref: "#/components/schemas/DlpAction" + description: The behavior applied when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the DLP setting was created, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the DLP setting was most recently updated, in ISO 8601 format. + required: + - DlpSettingId + - Name + - Arn + - Status + - ProviderType + - ProviderConfig + - ProviderOutageAction + - CreatedAt + - UpdatedAt + DlpSettingStatus: + type: string + enum: + - ACTIVE + - INACTIVE + FlowPublishState: + type: string + enum: + - PUBLISHED + - DRAFT + - PENDING_APPROVAL + DescribeFlowResponse: + type: object + properties: + Flow: + $ref: "#/components/schemas/FlowDetail" + description: The full details of the flow. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - Flow + FlowDetail: + description: The full details of a flow, including its definition specifying the steps. + type: object + properties: + Arn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the flow. + FlowId: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow. + Name: + $ref: "#/components/schemas/Title" + description: The display name of the flow. + Description: + $ref: "#/components/schemas/FlowDescription" + description: The description of the flow. + PublishState: + $ref: "#/components/schemas/FlowPublishState" + description: The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL. + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time this flow was created. + CreatedBy: + $ref: "#/components/schemas/String" + description: The identifier of the principal who created the flow. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The last time this flow was modified. + LastUpdatedBy: + $ref: "#/components/schemas/String" + description: The identifier of the last principal who updated the flow. + FlowDefinition: + $ref: "#/components/schemas/SensitiveDocument" + description: The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change. + StepAliases: + $ref: "#/components/schemas/StepAliasList" + description: A list of step alias mappings for the flow. + required: + - Arn + - FlowId + - Name + - PublishState + - CreatedTime + - FlowDefinition + Title: + type: string + minLength: 1 + maxLength: 128 + FlowDescription: + type: string + minLength: 0 + maxLength: 1024 + StepAliasList: + type: array + items: + $ref: "#/components/schemas/StepAliasMapping" + StepAliasMapping: + description: A mapping between a step identifier and its alias in a flow. + type: object + properties: + StepId: + $ref: "#/components/schemas/StepId" + description: The unique identifier of the step. + StepAlias: + $ref: "#/components/schemas/String" + description: The alias for the step. + required: + - StepId + - StepAlias + StepId: + type: string + minLength: 1 + maxLength: 64 DescribeFolderResponse: type: object properties: @@ -26800,6 +30696,192 @@ components: enum: - AWS_OWNED - CMK + DescribeKnowledgeBaseResponse: + type: object + properties: + KnowledgeBase: + $ref: "#/components/schemas/KnowledgeBase" + description: The knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBase + KnowledgeBase: + description: A knowledge base resource that provides data from connected sources for AI-powered experiences in Amazon QuickSight. + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + Name: + $ref: "#/components/schemas/KnowledgeBaseName" + description: The name of the knowledge base. + Status: + $ref: "#/components/schemas/DataSetStatus" + description: The status of the knowledge base. + DataSourceArn: + $ref: "#/components/schemas/DataSourceArn" + description: The ARN of the data source associated with the knowledge base. + KnowledgeBaseConfiguration: + $ref: "#/components/schemas/KnowledgeBaseConfiguration" + description: The configuration settings for the knowledge base. + MediaExtractionConfiguration: + $ref: "#/components/schemas/MediaExtractionConfiguration" + description: The media extraction configuration for the knowledge base. + AccessControlConfiguration: + $ref: "#/components/schemas/AccessControlConfiguration" + description: The access control configuration for the knowledge base. + Type: + $ref: "#/components/schemas/String" + description: The type of the knowledge base. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the knowledge base was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the knowledge base was last updated. + Description: + $ref: "#/components/schemas/KnowledgeBaseDescription" + description: The description of the knowledge base. + IsEmailNotificationOptedForIngestionFailures: + $ref: "#/components/schemas/Boolean" + description: Specifies whether email notifications are enabled for ingestion failures. + FirstCompletedIngestionSummary: + $ref: "#/components/schemas/KnowledgeBaseIngestionSummary" + description: A summary of the first completed ingestion for the knowledge base. + FirstIncompleteIngestionSummary: + $ref: "#/components/schemas/KnowledgeBaseIngestionSummary" + description: A summary of the first incomplete ingestion for the knowledge base. + LatestIngestionSummary: + $ref: "#/components/schemas/KnowledgeBaseIngestionSummary" + description: A summary of the most recent ingestion for the knowledge base. + KnowledgeBaseSizeBytes: + $ref: "#/components/schemas/Long" + description: The size of the knowledge base in bytes. + DocumentCount: + $ref: "#/components/schemas/Long" + description: The number of documents in the knowledge base. + PrimaryOwnerArn: + $ref: "#/components/schemas/String" + description: The ARN of the primary owner of the knowledge base. + PrimaryOwnerUsername: + $ref: "#/components/schemas/SensitiveString" + description: The username of the primary owner of the knowledge base. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + - Name + - Status + - DataSourceArn + - KnowledgeBaseConfiguration + KnowledgeBaseIngestionSummary: + description: A summary of an ingestion job for a knowledge base. + type: object + properties: + IngestionId: + $ref: "#/components/schemas/KbIngestionId" + description: The unique identifier for the ingestion job. + IngestionStatus: + $ref: "#/components/schemas/KbIngestionStatus" + description: The status of the ingestion job. + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The start time of the ingestion job. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The end time of the ingestion job. + required: + - IngestionId + - IngestionStatus + KbIngestionId: + type: string + minLength: 1 + maxLength: 1024 + pattern: "[0-9a-zA-Z-_=.+]+" + KbIngestionStatus: + type: string + enum: + - QUEUED + - RUNNING + - FAILED + - COMPLETED + - INCOMPLETE + - CANCELLED + - CANCELLING + - TIMEOUT + DescribeKnowledgeBasePermissionsResponse: + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: The resource permissions for the knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + DescribeLimitsProfileResponse: + type: object + properties: + profile: + $ref: "#/components/schemas/LimitsProfile" + description: The details of the requested limits profile, including its name, description, resource limits, and metadata. + required: + - profile + LimitsProfile: + description: A limits profile that defines resource usage limits for Amazon Quick Sight users. Limits profiles can be assigned to users, groups, or roles to control resource consumption. + type: object + properties: + profileId: + $ref: "#/components/schemas/ProfileId" + description: The unique identifier for the limits profile. + arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the limits profile. + accountId: + $ref: "#/components/schemas/AwsAccountId" + description: The ID of the Amazon Web Services account that contains the limits profile. + profileName: + $ref: "#/components/schemas/ProfileName" + description: The display name of the limits profile. + description: + $ref: "#/components/schemas/ProfileDescription" + description: The description of the limits profile. + resourceLimits: + type: object + properties: {} + description: A map of resource types to their limit values. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the limits profile was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the limits profile was last updated. + required: + - profileId + - arn + - accountId + - profileName + - resourceLimits + - createdAt + - updatedAt DescribeNamespaceResponse: type: object properties: @@ -26855,6 +30937,54 @@ components: enum: - PERMISSION_DENIED - INTERNAL_SERVICE_ERROR + DescribeOAuthClientApplicationResponse: + type: object + properties: + OAuthClientApplication: + $ref: "#/components/schemas/OAuthClientApplication" + description: The information about the OAuthClientApplication. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + OAuthClientApplication: + description: An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider. + type: object + properties: + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + Name: + $ref: "#/components/schemas/ResourceName" + description: The display name of the OAuthClientApplication. + OAuthClientAuthenticationType: + $ref: "#/components/schemas/OAuthClientAuthenticationType" + description: The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN. + OAuthTokenEndpointUrl: + $ref: "#/components/schemas/OAuthTokenEndpointUrl" + description: The token endpoint URL of the identity provider that is used to obtain access tokens. + OAuthAuthorizationEndpointUrl: + $ref: "#/components/schemas/OAuthAuthorizationEndpointUrl" + description: The authorization endpoint URL of the identity provider that is used to obtain authorization codes. + OAuthScopes: + $ref: "#/components/schemas/OAuthScopesString" + description: The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider. + DataSourceType: + $ref: "#/components/schemas/DataSourceType" + description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE. + IdentityProviderVpcConnectionProperties: + $ref: "#/components/schemas/VpcConnectionProperties" + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time that the OAuthClientApplication was created. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time that the OAuthClientApplication was last updated. + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the OAuthClientApplication. DescribeQPersonalizationConfigurationResponse: type: object properties: @@ -26945,6 +31075,130 @@ components: enum: - AUTO_APPROVAL - ADMIN_APPROVAL + MaxContributors: + type: integer + minimum: 1 + maximum: 100 + DescribeSpaceResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + Space: + $ref: "#/components/schemas/SpaceDetails" + description: The details of the space. + Contributors: + $ref: "#/components/schemas/SpaceContributorList" + description: A list of contributors to the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + - Space + SpaceDetails: + description: The details of an Amazon QuickSight space. + type: object + properties: + name: + $ref: "#/components/schemas/SpaceName" + description: The display name of the space. + description: + $ref: "#/components/schemas/SpaceDescription" + description: The description of the space. + resources: + $ref: "#/components/schemas/SpaceQuickSightResources" + description: The resources in the space. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the space was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the space was last updated. + consumedSourceSize: + $ref: "#/components/schemas/Long" + description: The total consumed source size in bytes. + consumedSourceDocCount: + $ref: "#/components/schemas/Integer" + description: The number of consumed source documents. + createdBy: + $ref: "#/components/schemas/String" + description: The user who created the space. + createdByArn: + $ref: "#/components/schemas/String" + description: The ARN of the user who created the space. + SpaceQuickSightResources: + type: array + items: + $ref: "#/components/schemas/SpaceQuickSightResource" + SpaceQuickSightResource: + description: A QuickSight resource that is associated with a space. + type: object + properties: + resourceType: + $ref: "#/components/schemas/SpaceQuickSightResourceType" + description: The type of the QuickSight resource. + resourceDetails: + $ref: "#/components/schemas/SpaceQuickSightResourceDetails" + description: The details of the QuickSight resource. + required: + - resourceType + - resourceDetails + SpaceQuickSightResourceType: + type: string + enum: + - TOPIC + - DASHBOARD + - KNOWLEDGE_BASE + - ACTION_CONNECTOR + - DATA_SET + SpaceQuickSightResourceDetails: + description: The details of a QuickSight resource in a space. + type: object + properties: + resourceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the QuickSight resource. + SpaceContributorList: + type: array + items: + $ref: "#/components/schemas/SpaceContributor" + SpaceContributor: + description: A contributor to an Amazon QuickSight space. + type: object + properties: + userName: + $ref: "#/components/schemas/String" + description: The user name of the contributor. + rawFileSizeBytes: + $ref: "#/components/schemas/Long" + description: The raw file size in bytes contributed by the user. + percentage: + $ref: "#/components/schemas/Double" + description: The percentage of total contributions made by the user. + required: + - rawFileSizeBytes + DescribeSpacePermissionsResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: A list of resource permissions for the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId DescribeTemplateResponse: type: object properties: @@ -26998,6 +31252,9 @@ components: DataSetConfigurations: $ref: "#/components/schemas/DataSetConfigurationList" description: Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation. + TopicConfigurations: + $ref: "#/components/schemas/TopicConfigurationList" + description: Schema of the topic identified by the placeholder. Any dashboard created from this template should be bound to new topics matching the same schema described through this API operation. Description: $ref: "#/components/schemas/VersionDescription" description: The description of the template. @@ -27251,6 +31508,24 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + DescribeTopicPermissionsV2Response: + type: object + properties: + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + TopicArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: A list of resource permissions that are configured to the topic. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. DescribeTopicRefreshResponse: type: object properties: @@ -27305,6 +31580,26 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + DescribeTopicV2Response: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + Topic: + $ref: "#/components/schemas/TopicV2Details" + description: The definition of a topic. + CustomInstructions: + $ref: "#/components/schemas/CustomInstructions" + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. DescribeUserResponse: type: object properties: @@ -27916,14 +32211,6 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. - AccountId: - type: string - minLength: 12 - maxLength: 12 - pattern: "[0-9]{12}" - FlowId: - type: string - pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" GetFlowMetadataOutput: type: object properties: @@ -27965,20 +32252,6 @@ components: - FlowId - Name - CreatedTime - Title: - type: string - minLength: 1 - maxLength: 128 - FlowDescription: - type: string - minLength: 0 - maxLength: 1024 - FlowPublishState: - type: string - enum: - - PUBLISHED - - DRAFT - - PENDING_APPROVAL GetFlowPermissionsOutput: type: object properties: @@ -28001,35 +32274,6 @@ components: - Arn - FlowId - Permissions - PermissionsList: - type: array - items: - $ref: "#/components/schemas/Permission" - Permission: - description: A structure that contains the permission information for one principal against one flow. - type: object - properties: - Actions: - $ref: "#/components/schemas/ActionsList" - description: "A list of actions that the principal can perform against the flow. The following are the list of values to set a principal as a flow owner: quicksight:PublishFlow quicksight:GetFlow quicksight:UpdateFlowPermissions quicksight:GetFlowSession quicksight:StartFlowSession quicksight:StopFlowSession quicksight:UpdateFlowSession quicksight:UnpublishFlow quicksight:GetFlowStages quicksight:DeleteFlow quicksight:DescribeFlowPermissions quicksight:UpdateFlow quicksight:CreatePresignedUrl The following are the list of values to set a principal as a flow viewer: quicksight:GetFlow quicksight:UpdateFlowSession quicksight:StartFlowSession quicksight:StopFlowSession quicksight:GetFlowSession quicksight:CreatePresignedUrl quicksight:GetFlowStages" - Principal: - $ref: "#/components/schemas/PermissionPrincipalString" - description: The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions. - required: - - Actions - - Principal - ActionsList: - type: array - items: - $ref: "#/components/schemas/ActionsListMemberString" - ActionsListMemberString: - type: string - minLength: 1 - maxLength: 64 - PermissionPrincipalString: - type: string - minLength: 1 - maxLength: 256 UserIdentifier: description: A structure that contains information to identify a user. type: object @@ -28134,6 +32378,59 @@ components: - Type - Name - LastUpdatedTime + ListAgentsRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListAgentsResponse: + type: object + properties: + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + AgentSummaries: + $ref: "#/components/schemas/AgentSummaries" + description: A list of agent summaries. + NextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + required: + - AgentSummaries + AgentSummaries: + type: array + items: + $ref: "#/components/schemas/AgentSummary" + AgentSummary: + description: A summary of an agent, including its identifier, name, and metadata. + type: object + properties: + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + Name: + $ref: "#/components/schemas/AgentName" + description: The name of the agent. + Description: + $ref: "#/components/schemas/AgentDescription" + description: A description of the agent. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the agent was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the agent was last updated. + IconId: + $ref: "#/components/schemas/IconId" + description: The icon identifier for the agent. + required: + - Arn + - AgentId + - Name + - CreatedAt + - UpdatedAt ListAnalysesResponse: type: object properties: @@ -28175,6 +32472,25 @@ components: LastUpdatedTime: $ref: "#/components/schemas/Timestamp" description: The time that the analysis was last updated. + PaginationToken: + type: string + minLength: 1 + maxLength: 4096 + ListApprovalPoliciesResponse: + type: object + properties: + Policies: + $ref: "#/components/schemas/ApprovalPolicyList" + description: The list of approval policies. + NextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next set of results, or null if there are no more results. + required: + - Policies + ApprovalPolicyList: + type: array + items: + $ref: "#/components/schemas/ApprovalPolicy" ListAssetBundleExportJobsResponse: type: object properties: @@ -28478,6 +32794,57 @@ components: type: array items: $ref: "#/components/schemas/DataSource" + ListDlpSettingsResponse: + type: object + properties: + DlpSettingSummaries: + $ref: "#/components/schemas/DlpSettingSummaryList" + description: A list of DlpSettingSummary objects for the DLP settings in the account. The list is empty if no DLP settings have been configured. + NextToken: + $ref: "#/components/schemas/PaginationToken" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - DlpSettingSummaries + DlpSettingSummaryList: + type: array + items: + $ref: "#/components/schemas/DlpSettingSummary" + DlpSettingSummary: + description: A summary of a DLP setting returned by list operations. + type: object + properties: + DlpSettingId: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the DLP setting. + Name: + $ref: "#/components/schemas/DlpSettingName" + description: The display name of the DLP setting. + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the DLP setting. + Status: + $ref: "#/components/schemas/DlpSettingStatus" + description: The status of the DLP setting. Valid values are ACTIVE and INACTIVE. + ProviderType: + $ref: "#/components/schemas/DlpProviderType" + description: The type of external DLP provider used for sensitivity label classification. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the DLP setting was created, in ISO 8601 format. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the DLP setting was most recently updated, in ISO 8601 format. + required: + - DlpSettingId + - Name + - Arn + - Status + - ProviderType + - CreatedAt + - UpdatedAt FlowMaxResults: type: integer minimum: 1 @@ -28791,6 +33158,96 @@ components: type: array items: $ref: "#/components/schemas/Ingestion" + NextToken: + type: string + minLength: 1 + maxLength: 800 + ListKnowledgeBasesResponse: + type: object + properties: + KnowledgeBaseSummaries: + $ref: "#/components/schemas/KnowledgeBaseSummaries" + description: A list of knowledge base summaries. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseSummaries + KnowledgeBaseSummaries: + type: array + items: + $ref: "#/components/schemas/KnowledgeBaseSummary" + KnowledgeBaseSummary: + description: A summary of a knowledge base, including its identifier, name, status, and metadata. + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + Name: + $ref: "#/components/schemas/KnowledgeBaseName" + description: The name of the knowledge base. + Status: + $ref: "#/components/schemas/DataSetStatus" + description: The status of the knowledge base. + DataSourceArn: + $ref: "#/components/schemas/DataSourceArn" + description: The ARN of the data source associated with the knowledge base. + Type: + $ref: "#/components/schemas/String" + description: The type of the knowledge base. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the knowledge base was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the knowledge base was last updated. + KnowledgeBaseSizeBytes: + $ref: "#/components/schemas/Long" + description: The size of the knowledge base in bytes. + DocumentCount: + $ref: "#/components/schemas/Long" + description: The number of documents in the knowledge base. + PrimaryOwnerArn: + $ref: "#/components/schemas/String" + description: The ARN of the primary owner of the knowledge base. + PrimaryOwnerUsername: + $ref: "#/components/schemas/SensitiveString" + description: The username of the primary owner of the knowledge base. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + - Name + - Status + - DataSourceArn + ListLimitsProfilesRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListLimitsProfilesResponse: + type: object + properties: + profiles: + $ref: "#/components/schemas/LimitsProfileList" + description: A list of limits profiles. + nextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + required: + - profiles + LimitsProfileList: + type: array + items: + $ref: "#/components/schemas/LimitsProfile" ListNamespacesResponse: type: object properties: @@ -28810,6 +33267,52 @@ components: type: array items: $ref: "#/components/schemas/NamespaceInfoV2" + ListOAuthClientApplicationsResponse: + type: object + properties: + OAuthClientApplications: + $ref: "#/components/schemas/OAuthClientApplicationSummaryList" + description: A list of OAuthClientApplication summaries. + NextToken: + $ref: "#/components/schemas/String" + description: A pagination token that can be used in a subsequent request. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + OAuthClientApplicationSummaryList: + type: array + items: + $ref: "#/components/schemas/OAuthClientApplicationSummary" + OAuthClientApplicationSummary: + description: A summary of an OAuthClientApplication. + type: object + properties: + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + Name: + $ref: "#/components/schemas/ResourceName" + description: The display name of the OAuthClientApplication. + OAuthClientAuthenticationType: + $ref: "#/components/schemas/OAuthClientAuthenticationType" + description: The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN. + DataSourceType: + $ref: "#/components/schemas/DataSourceType" + description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE. + IdentityProviderVpcConnectionProperties: + $ref: "#/components/schemas/VpcConnectionProperties" + CreatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time that the OAuthClientApplication was created. + LastUpdatedTime: + $ref: "#/components/schemas/Timestamp" + description: The time that the OAuthClientApplication was last updated. + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the OAuthClientApplication. ListRefreshSchedulesResponse: type: object properties: @@ -28897,6 +33400,115 @@ components: - DENIED - UPDATE_FAILED - VERIFY_FAILED + ListSpaceResourcesResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + SpaceResources: + $ref: "#/components/schemas/SpaceResourceSummaries" + description: A list of resource summaries in the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + - SpaceResources + SpaceResourceSummaries: + type: array + items: + $ref: "#/components/schemas/SpaceResourceSummary" + SpaceResourceSummary: + description: A summary of a resource in a space. + type: object + properties: + ResourceType: + $ref: "#/components/schemas/SpaceQuickSightResourceType" + description: The type of the resource. + ResourceDetails: + $ref: "#/components/schemas/SpaceQuickSightResourceDetails" + description: The details of the resource. + ResourceName: + $ref: "#/components/schemas/String" + description: The name of the resource. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the resource was last updated. + required: + - ResourceType + - ResourceDetails + SpacesMaxResults: + type: integer + minimum: 1 + maximum: 500 + ListSpacesResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + SpaceSummaries: + $ref: "#/components/schemas/SpaceSummaries" + description: A list of space summaries. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + - SpaceSummaries + SpaceSummaries: + type: array + items: + $ref: "#/components/schemas/SpaceSummary" + SpaceSummary: + description: A summary of an Amazon QuickSight space. + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + name: + $ref: "#/components/schemas/SpaceName" + description: The display name of the space. + description: + $ref: "#/components/schemas/SpaceDescription" + description: The description of the space. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the space was last updated. + consumedSourceSize: + $ref: "#/components/schemas/Long" + description: The total consumed source size in bytes. + consumedSourceDocCount: + $ref: "#/components/schemas/Integer" + description: The number of consumed source documents. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the space was created. + createdBy: + $ref: "#/components/schemas/String" + description: The user who created the space. + createdByArn: + $ref: "#/components/schemas/String" + description: The ARN of the user who created the space. + resourcesCount: + $ref: "#/components/schemas/Integer" + description: The number of resources in the space. + required: + - spaceId ListTagsForResourceResponse: type: object properties: @@ -29179,7 +33791,7 @@ components: $ref: "#/components/schemas/Arn" description: The Dataset ARN for the TopicReviewedAnswer. Question: - $ref: "#/components/schemas/LimitedString" + $ref: "#/components/schemas/LimitedSensitiveString" description: The question for the TopicReviewedAnswer. Mir: $ref: "#/components/schemas/TopicIR" @@ -29229,6 +33841,38 @@ components: UserExperienceVersion: $ref: "#/components/schemas/TopicUserExperienceVersion" description: The user experience version of the topic. + ListTopicsV2Response: + type: object + properties: + TopicSummaryList: + $ref: "#/components/schemas/TopicV2Summaries" + description: A list of topic summaries. + NextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + TopicV2Summaries: + type: array + items: + $ref: "#/components/schemas/TopicV2Summary" + TopicV2Summary: + description: A summary of the topic. + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + Name: + $ref: "#/components/schemas/ResourceName" + description: The name of the topic. ListUserGroupsResponse: type: object properties: @@ -29263,6 +33907,118 @@ components: type: array items: $ref: "#/components/schemas/User" + UserIndexCapacityFilters: + type: array + items: + $ref: "#/components/schemas/UserIndexCapacityFilter" + UserIndexCapacityFilter: + description: A filter for user index capacity queries. Only one filter type can be specified per request. + type: object + properties: + userNameOrEmail: + $ref: "#/components/schemas/UserNameOrEmailFilter" + description: Filter users by username or email prefix. + totalCapacityBytes: + $ref: "#/components/schemas/CapacityBytesRangeFilter" + description: Filter users by total capacity range in bytes. + UserNameOrEmailFilter: + description: A filter that matches users by username or email prefix. + type: object + properties: + prefix: + $ref: "#/components/schemas/FilterValue" + description: The prefix to match against username or email (starts-with match). + required: + - prefix + FilterValue: + type: string + minLength: 0 + maxLength: 256 + CapacityBytesRangeFilter: + description: A filter that matches users by total capacity range in bytes. + type: object + properties: + minBytes: + $ref: "#/components/schemas/CapacityBytesRangeFilterMinBytesLong" + description: The minimum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required. + maxBytes: + $ref: "#/components/schemas/CapacityBytesRangeFilterMaxBytesLong" + description: The maximum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required. + CapacityBytesRangeFilterMinBytesLong: + type: integer + format: int64 + minimum: 1 + CapacityBytesRangeFilterMaxBytesLong: + type: integer + format: int64 + minimum: 1 + UserIndexCapacitySortBy: + description: The field to sort user index capacity results by. + type: string + enum: + - TOTAL_CAPACITY_BYTES + UserIndexCapacitySortOrder: + description: The sort order for user index capacity results. + type: string + enum: + - ASC + - DESC + ListUsersIndexCapacityRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 100 + ListUsersIndexCapacityResponse: + type: object + properties: + users: + $ref: "#/components/schemas/UserIndexCapacityList" + description: The list of users with their index capacity metrics. + nextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + requestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + UserIndexCapacityList: + type: array + items: + $ref: "#/components/schemas/UserIndexCapacity" + UserIndexCapacity: + description: A summary of a user's index capacity consumption. + type: object + properties: + userArn: + $ref: "#/components/schemas/String" + description: The ARN of the user. + userName: + $ref: "#/components/schemas/String" + description: The username of the user. + email: + $ref: "#/components/schemas/String" + description: The email address of the user. + role: + $ref: "#/components/schemas/String" + description: The role of the user. + totalCapacityBytes: + $ref: "#/components/schemas/LongValue" + description: The total index capacity consumed by the user in bytes. + totalKBCapacityBytes: + $ref: "#/components/schemas/LongValue" + description: The total index capacity consumed by the user's knowledge bases in bytes. + totalSpaceCapacityBytes: + $ref: "#/components/schemas/LongValue" + description: The total index capacity consumed by the user's spaces in bytes. + kbCount: + $ref: "#/components/schemas/IntegerValue" + description: The number of knowledge bases owned by the user. + spaceCount: + $ref: "#/components/schemas/IntegerValue" + description: The number of spaces owned by the user. + LongValue: + type: integer + format: int64 + IntegerValue: + type: integer ListVPCConnectionsResponse: type: object properties: @@ -29557,6 +34313,55 @@ components: ActionConnectorSummaries: $ref: "#/components/schemas/ActionConnectorSummaryList" description: A list of action connector summaries that match the search criteria. + AgentsMaxResults: + type: integer + minimum: 1 + maximum: 100 + AgentSearchFilterList: + type: array + items: + $ref: "#/components/schemas/AgentSearchFilter" + AgentSearchFilter: + description: A filter to apply when searching agents. + type: object + properties: + Name: + $ref: "#/components/schemas/AgentOwnershipFilterAttribute" + description: The name of the field to filter on. + Operator: + $ref: "#/components/schemas/ComparisonOperator" + description: The comparison operator to use for the filter. + Value: + $ref: "#/components/schemas/String" + description: The value to filter on. + AgentOwnershipFilterAttribute: + type: string + enum: + - DIRECT_QUICKSIGHT_OWNER + - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER + - DIRECT_QUICKSIGHT_SOLE_OWNER + - AGENT_NAME + ComparisonOperator: + type: string + enum: + - StringEquals + - StringLike + SearchAgentsResponse: + type: object + properties: + AgentSummaries: + $ref: "#/components/schemas/AgentSummaryList" + description: A list of agent summaries. + NextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + AgentSummaryList: + type: array + items: + $ref: "#/components/schemas/AgentSummary" AnalysisSearchFilterList: type: array items: @@ -29894,6 +34699,145 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + KnowledgeBaseSearchFilters: + type: array + items: + $ref: "#/components/schemas/KnowledgeBaseSearchFilter" + KnowledgeBaseSearchFilter: + description: A filter to apply when searching knowledge bases. + type: object + properties: + name: + $ref: "#/components/schemas/KnowledgeBaseSearchFilterName" + description: The name of the field to filter on. + operator: + $ref: "#/components/schemas/KnowledgeBaseSearchOperator" + description: The comparison operator to use for the filter. + value: + $ref: "#/components/schemas/String" + description: The value to filter on. + required: + - name + - operator + - value + KnowledgeBaseSearchFilterName: + description: "The name of a field that you can use to filter knowledge base search results. Valid values include: DATASOURCE_ARN – The Amazon Resource Name (ARN) of the associated data source. DIRECT_QUICKSIGHT_OWNER – An Amazon QuickSight user or group with direct owner permissions. DIRECT_QUICKSIGHT_SOLE_OWNER – An Amazon QuickSight user or group that is the sole direct owner. DIRECT_QUICKSIGHT_VIEWER_OR_OWNER – An Amazon QuickSight user or group with direct viewer or owner permissions. KNOWLEDGE_BASE_ID – The unique identifier of the knowledge base. KNOWLEDGE_BASE_NAME – The display name of the knowledge base. KNOWLEDGE_BASE_SIZE_BYTES – The size of the knowledge base in bytes. PRIMARY_OWNER – The Amazon Resource Name (ARN) of the primary owner of the knowledge base." + type: string + enum: + - KNOWLEDGE_BASE_ID + - KNOWLEDGE_BASE_NAME + - DIRECT_QUICKSIGHT_OWNER + - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER + - DIRECT_QUICKSIGHT_SOLE_OWNER + - KNOWLEDGE_BASE_SIZE_BYTES + - PRIMARY_OWNER + - DATASOURCE_ARN + KnowledgeBaseSearchOperator: + type: string + enum: + - STRING_EQUALS + - STRING_LIKE + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + KnowledgeBaseSortBy: + description: The sort configuration for searching knowledge bases. + type: object + properties: + sortByField: + $ref: "#/components/schemas/KnowledgeBaseSortByField" + description: The field to sort by. + sortOrder: + $ref: "#/components/schemas/SortOrder" + description: The sort order (ascending or descending). + required: + - sortByField + - sortOrder + KnowledgeBaseSortByField: + type: string + enum: + - KNOWLEDGE_BASE_SIZE_BYTES + - CREATED_AT + SortOrder: + type: string + enum: + - ASC + - DESC + SearchKnowledgeBasesResponse: + type: object + properties: + KnowledgeBaseSummaries: + $ref: "#/components/schemas/KnowledgeBaseSummaries" + description: A list of knowledge base summaries. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseSummaries + SpaceQuicksightSearchFilters: + type: array + items: + $ref: "#/components/schemas/SpaceQuicksightSearchFilter" + SpaceQuicksightSearchFilter: + description: A filter to use when searching for spaces. + type: object + properties: + name: + $ref: "#/components/schemas/SpaceQuickSightSearchFilterName" + description: The name of the filter field to use. + operator: + $ref: "#/components/schemas/SpaceSearchOperator" + description: The comparison operator to use for the filter. + value: + $ref: "#/components/schemas/String" + description: The value to use for the filter. + required: + - name + - operator + - value + SpaceQuickSightSearchFilterName: + type: string + enum: + - SPACE_ID + - SPACE_NAME + - DIRECT_QUICKSIGHT_OWNER + - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER + - DIRECT_QUICKSIGHT_SOLE_OWNER + - CONTRIBUTED_BY + - CONSUMED_SOURCE_SIZE + - CREATED_BY + SpaceSearchOperator: + type: string + enum: + - STRING_EQUALS + - STRING_LIKE + - NUMBER_RANGE + SearchSpacesResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + SpaceSummaries: + $ref: "#/components/schemas/SpaceSummaries" + description: A list of space summaries that match the search criteria. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of results, or null if there are no more results. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + - SpaceSummaries TopicSearchFilterList: type: array items: @@ -29909,7 +34853,7 @@ components: $ref: "#/components/schemas/TopicFilterAttribute" description: The name of the topic search filter. Value: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/SensitiveString" description: The value of the topic search filter. required: - Operator @@ -29945,6 +34889,21 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + SearchTopicsV2Response: + type: object + properties: + TopicSummaryList: + $ref: "#/components/schemas/TopicV2Summaries" + description: A list of topic summaries that is returned by the search topic request. + NextToken: + $ref: "#/components/schemas/String" + description: The token for the next set of results, or null if there are no more results. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. StartAssetBundleExportJobResponse: type: object properties: @@ -30147,6 +35106,96 @@ components: Permissions: $ref: "#/components/schemas/ResourcePermissionList" description: The updated permissions configuration for the action connector. + UpdateAgentRequestSpacesToAddList: + type: array + items: + $ref: "#/components/schemas/Arn" + UpdateAgentRequestSpacesToRemoveList: + type: array + items: + $ref: "#/components/schemas/Arn" + UpdateAgentRequestActionConnectorsToAddList: + type: array + items: + $ref: "#/components/schemas/Arn" + UpdateAgentRequestActionConnectorsToRemoveList: + type: array + items: + $ref: "#/components/schemas/Arn" + UpdateAgentResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + AgentStatus: + $ref: "#/components/schemas/AgentStatus" + description: The status of the agent. + FailedToAddSpaces: + $ref: "#/components/schemas/FailedToUpdateAssociationList" + description: A list of per-ARN failures from the spaces that were requested to be added. + FailedToRemoveSpaces: + $ref: "#/components/schemas/FailedToUpdateAssociationList" + description: A list of per-ARN failures from the spaces that were requested to be removed. + FailedToAddActionConnectors: + $ref: "#/components/schemas/FailedToUpdateAssociationList" + description: A list of per-ARN failures from the action connectors that were requested to be added. + FailedToRemoveActionConnectors: + $ref: "#/components/schemas/FailedToUpdateAssociationList" + description: A list of per-ARN failures from the action connectors that were requested to be removed. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - AgentId + - AgentStatus + FailedToUpdateAssociationList: + type: array + items: + $ref: "#/components/schemas/FailedToUpdateAssociation" + FailedToUpdateAssociation: + description: Information about a per-ARN failure when updating agent associations. + type: object + properties: + Arn: + $ref: "#/components/schemas/String" + description: The ARN that could not be added or removed. + ErrorMessage: + $ref: "#/components/schemas/String" + description: A description of the failure. + ErrorCode: + $ref: "#/components/schemas/String" + description: The error code for the failure. + UpdateAgentPermissionsRequestGrantPermissionsList: + type: array + items: + $ref: "#/components/schemas/ResourcePermission" + UpdateAgentPermissionsRequestRevokePermissionsList: + type: array + items: + $ref: "#/components/schemas/ResourcePermission" + UpdateAgentPermissionsResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/AgentArn" + description: The Amazon Resource Name (ARN) of the agent. + AgentId: + $ref: "#/components/schemas/AgentId" + description: The unique identifier for the agent. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: The resource permissions for the agent. + required: + - Arn + - AgentId UpdateAnalysisResponse: type: object properties: @@ -30192,6 +35241,14 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + UpdateApprovalPolicyResponse: + type: object + properties: + Policy: + $ref: "#/components/schemas/ApprovalPolicy" + description: The updated approval policy. + required: + - Policy UpdateBrandResponse: type: object properties: @@ -30400,6 +35457,43 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + UpdateDlpSettingResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the updated DLP setting. + DlpSettingId: + $ref: "#/components/schemas/DlpSettingId" + description: The ID of the updated DLP setting. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - Arn + - DlpSettingId + UpdateFlowRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + UpdateFlowResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the flow. + FlowId: + $ref: "#/components/schemas/FlowId" + description: The unique identifier of the flow. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - Arn + - FlowId UpdateFlowPermissionsInputGrantPermissionsList: type: array items: @@ -30584,6 +35678,74 @@ components: required: - KeyArn - StatusCode + UpdateKnowledgeBaseResponse: + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + UpdateKnowledgeBasePermissionsResponse: + type: object + properties: + KnowledgeBaseArn: + $ref: "#/components/schemas/KnowledgeBaseArn" + description: The Amazon Resource Name (ARN) of the knowledge base. + KnowledgeBaseId: + $ref: "#/components/schemas/KnowledgeBaseId" + description: The unique identifier for the knowledge base. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: The resource permissions for the knowledge base. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + required: + - KnowledgeBaseArn + - KnowledgeBaseId + ResourceLimitsMap: + type: object + properties: {} + UpdateLimitsProfileResponse: + type: object + properties: + arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the updated limits profile. + required: + - arn + UpdateOAuthClientApplicationResponse: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the OAuthClientApplication. + OAuthClientApplicationId: + $ref: "#/components/schemas/OAuthClientApplicationId" + description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + UpdateStatus: + $ref: "#/components/schemas/ResourceStatus" + description: The status of updating the OAuthClientApplication. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. UpdatePublicSharingSettingsResponse: type: object properties: @@ -30682,6 +35844,91 @@ components: Status: $ref: "#/components/schemas/StatusCode" description: The HTTP status of the request. + UpdateSpaceResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + UpdateSpacePermissionsResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: The updated permissions for the space. + requestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + SpaceResourceOperations: + type: array + items: + $ref: "#/components/schemas/SpaceResourceOperation" + SpaceResourceOperation: + description: An operation to perform on a resource in a space. + type: object + properties: + ResourceType: + $ref: "#/components/schemas/SpaceQuickSightResourceType" + description: The type of the resource. + ResourceDetails: + $ref: "#/components/schemas/SpaceQuickSightResourceDetails" + description: The details of the resource. + required: + - ResourceType + - ResourceDetails + UpdateSpaceResourcesResponse: + type: object + properties: + spaceId: + $ref: "#/components/schemas/PublicSpaceId" + description: The ID of the space. + spaceArn: + $ref: "#/components/schemas/PublicSpaceArn" + description: The ARN of the space. + FailedResourceOperations: + $ref: "#/components/schemas/FailedSpaceResourceOperations" + description: A list of resource operations that failed. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + required: + - spaceId + FailedSpaceResourceOperations: + type: array + items: + $ref: "#/components/schemas/FailedSpaceResourceOperation" + FailedSpaceResourceOperation: + description: A resource operation that failed. + type: object + properties: + ResourceType: + $ref: "#/components/schemas/SpaceQuickSightResourceType" + description: The type of the resource. + ResourceDetails: + $ref: "#/components/schemas/SpaceQuickSightResourceDetails" + description: The details of the resource. + ErrorMessage: + $ref: "#/components/schemas/String" + description: The error message that describes why the operation failed. + required: + - ResourceType + - ErrorMessage UpdateTemplateResponse: type: object properties: @@ -30820,6 +36067,24 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + UpdateTopicPermissionsV2Response: + type: object + properties: + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + TopicArn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + Permissions: + $ref: "#/components/schemas/ResourcePermissionList" + description: A list of resource permissions on the topic. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. UpdateTopicRefreshScheduleResponse: type: object properties: @@ -30838,6 +36103,26 @@ components: RequestId: $ref: "#/components/schemas/String" description: The Amazon Web Services request ID for this operation. + TopicV2PublishOption: + type: string + enum: + - DRAFT + - PUBLISH + UpdateTopicV2Response: + type: object + properties: + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the topic. + TopicId: + $ref: "#/components/schemas/TopicId" + description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. + RequestId: + $ref: "#/components/schemas/String" + description: The Amazon Web Services request ID for this operation. + Status: + $ref: "#/components/schemas/StatusCode" + description: The HTTP status of the request. UpdateUserResponse: type: object properties: @@ -30980,6 +36265,102 @@ components: - $ref: "#/components/x-stackQL-resources/topics/methods/update_topic" delete: - $ref: "#/components/x-stackQL-resources/topics/methods/delete_topic" + knowledge_bases: + id: aws.quicksight.knowledge_bases + name: knowledge_bases + title: knowledge_bases + methods: + batch_delete_knowledge_base: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1batch-delete/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_knowledge_base: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_knowledge_base: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1{knowledge_base_id}/delete" + response: + openAPIDocKey: "202" + mediaType: application/json + describe_knowledge_base: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1{knowledge_base_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_knowledge_base: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1{knowledge_base_id}/post" + response: + openAPIDocKey: "202" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_knowledge_bases: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.KnowledgeBaseSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + search_knowledge_bases: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1search~1knowledge-bases/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.KnowledgeBaseSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/knowledge_bases/methods/describe_knowledge_base" + - $ref: "#/components/x-stackQL-resources/knowledge_bases/methods/list_knowledge_bases" + insert: + - $ref: "#/components/x-stackQL-resources/knowledge_bases/methods/create_knowledge_base" + update: + - $ref: "#/components/x-stackQL-resources/knowledge_bases/methods/update_knowledge_base" + delete: + - $ref: "#/components/x-stackQL-resources/knowledge_bases/methods/delete_knowledge_base" ingestions: id: aws.quicksight.ingestions name: ingestions @@ -31207,6 +36588,75 @@ components: - $ref: "#/components/x-stackQL-resources/action_connectors/methods/update_action_connector" delete: - $ref: "#/components/x-stackQL-resources/action_connectors/methods/delete_action_connector" + agents: + id: aws.quicksight.agents + name: agents + title: agents + methods: + create_agent: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_agents: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + delete_agent: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents~1{agent_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_agent: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents~1{agent_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_agent: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents~1{agent_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + search_agents: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1search~1agents/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agents/methods/describe_agent" + - $ref: "#/components/x-stackQL-resources/agents/methods/search_agents" + - $ref: "#/components/x-stackQL-resources/agents/methods/list_agents" + insert: + - $ref: "#/components/x-stackQL-resources/agents/methods/create_agent" + update: + - $ref: "#/components/x-stackQL-resources/agents/methods/update_agent" + delete: + - $ref: "#/components/x-stackQL-resources/agents/methods/delete_agent" analysis: id: aws.quicksight.analysis name: analysis @@ -31263,6 +36713,73 @@ components: - $ref: "#/components/x-stackQL-resources/analysis/methods/update_analysis" delete: - $ref: "#/components/x-stackQL-resources/analysis/methods/delete_analysis" + approval_policies: + id: aws.quicksight.approval_policies + name: approval_policies + title: approval_policies + methods: + create_approval_policy: + operation: + $ref: "#/paths/~1governance~1approvalworkflows~1policies/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_approval_policies: + operation: + $ref: "#/paths/~1governance~1approvalworkflows~1policies/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Policies + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + delete_approval_policy: + operation: + $ref: "#/paths/~1governance~1approvalworkflows~1policies~1{policy_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_approval_policy: + operation: + $ref: "#/paths/~1governance~1approvalworkflows~1policies~1{policy_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Policy + update_approval_policy: + operation: + $ref: "#/paths/~1governance~1approvalworkflows~1policies~1{policy_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/approval_policies/methods/describe_approval_policy" + - $ref: "#/components/x-stackQL-resources/approval_policies/methods/list_approval_policies" + insert: + - $ref: "#/components/x-stackQL-resources/approval_policies/methods/create_approval_policy" + update: + - $ref: "#/components/x-stackQL-resources/approval_policies/methods/update_approval_policy" + delete: + - $ref: "#/components/x-stackQL-resources/approval_policies/methods/delete_approval_policy" brands: id: aws.quicksight.brands name: brands @@ -31708,6 +37225,160 @@ components: - $ref: "#/components/x-stackQL-resources/data_sources/methods/update_data_source" delete: - $ref: "#/components/x-stackQL-resources/data_sources/methods/delete_data_source" + dlp_settings: + id: aws.quicksight.dlp_settings + name: dlp_settings + title: dlp_settings + methods: + create_dlp_setting: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1data-loss-prevention~1settings~1{dlp_setting_id}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_dlp_setting: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1data-loss-prevention~1settings~1{dlp_setting_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_dlp_setting: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1data-loss-prevention~1settings~1{dlp_setting_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_dlp_setting: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1data-loss-prevention~1settings~1{dlp_setting_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_dlp_settings: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1data-loss-prevention~1settings/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.DlpSettingSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dlp_settings/methods/describe_dlp_setting" + - $ref: "#/components/x-stackQL-resources/dlp_settings/methods/list_dlp_settings" + insert: + - $ref: "#/components/x-stackQL-resources/dlp_settings/methods/create_dlp_setting" + update: + - $ref: "#/components/x-stackQL-resources/dlp_settings/methods/update_dlp_setting" + delete: + - $ref: "#/components/x-stackQL-resources/dlp_settings/methods/delete_dlp_setting" + flows: + id: aws.quicksight.flows + name: flows + title: flows + methods: + create_flow: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_flows: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.FlowSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + delete_flow: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows~1{flow_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_flow: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows~1{flow_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_flow: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows~1{flow_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + search_flows: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1flows~1searchFlows/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.FlowSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/flows/methods/describe_flow" + - $ref: "#/components/x-stackQL-resources/flows/methods/search_flows" + - $ref: "#/components/x-stackQL-resources/flows/methods/list_flows" + insert: + - $ref: "#/components/x-stackQL-resources/flows/methods/create_flow" + update: + - $ref: "#/components/x-stackQL-resources/flows/methods/update_flow" + delete: + - $ref: "#/components/x-stackQL-resources/flows/methods/delete_flow" folders: id: aws.quicksight.folders name: folders @@ -32009,6 +37680,73 @@ components: - $ref: "#/components/x-stackQL-resources/iam_policy_assignments/methods/update_iam_policy_assignment" delete: - $ref: "#/components/x-stackQL-resources/iam_policy_assignments/methods/delete_iam_policy_assignment" + limits_profiles: + id: aws.quicksight.limits_profiles + name: limits_profiles + title: limits_profiles + methods: + create_limits_profile: + operation: + $ref: "#/paths/~1governance~1limits~1accounts~1{account_id}~1profiles/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_limits_profiles: + operation: + $ref: "#/paths/~1governance~1limits~1accounts~1{account_id}~1profiles/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.profiles + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_limits_profile: + operation: + $ref: "#/paths/~1governance~1limits~1accounts~1{account_id}~1profiles~1{profile_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_limits_profile: + operation: + $ref: "#/paths/~1governance~1limits~1accounts~1{account_id}~1profiles~1{profile_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.profile + update_limits_profile: + operation: + $ref: "#/paths/~1governance~1limits~1accounts~1{account_id}~1profiles~1{profile_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/limits_profiles/methods/describe_limits_profile" + - $ref: "#/components/x-stackQL-resources/limits_profiles/methods/list_limits_profiles" + insert: + - $ref: "#/components/x-stackQL-resources/limits_profiles/methods/create_limits_profile" + update: + - $ref: "#/components/x-stackQL-resources/limits_profiles/methods/update_limits_profile" + delete: + - $ref: "#/components/x-stackQL-resources/limits_profiles/methods/delete_limits_profile" namespaces: id: aws.quicksight.namespaces name: namespaces @@ -32063,6 +37801,72 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/namespaces/methods/delete_namespace" + o_auth_client_applications: + id: aws.quicksight.o_auth_client_applications + name: o_auth_client_applications + title: o_auth_client_applications + methods: + create_o_auth_client_application: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1oauth-client-applications/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_o_auth_client_applications: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1oauth-client-applications/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.OAuthClientApplications + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + delete_o_auth_client_application: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1oauth-client-applications~1{o_auth_client_application_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_o_auth_client_application: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1oauth-client-applications~1{o_auth_client_application_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_o_auth_client_application: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1oauth-client-applications~1{o_auth_client_application_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/o_auth_client_applications/methods/describe_o_auth_client_application" + - $ref: "#/components/x-stackQL-resources/o_auth_client_applications/methods/list_o_auth_client_applications" + insert: + - $ref: "#/components/x-stackQL-resources/o_auth_client_applications/methods/create_o_auth_client_application" + update: + - $ref: "#/components/x-stackQL-resources/o_auth_client_applications/methods/update_o_auth_client_application" + delete: + - $ref: "#/components/x-stackQL-resources/o_auth_client_applications/methods/delete_o_auth_client_application" refresh_schedules: id: aws.quicksight.refresh_schedules name: refresh_schedules @@ -32166,6 +37970,77 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/role_memberships/methods/delete_role_membership" + spaces: + id: aws.quicksight.spaces + name: spaces + title: spaces + methods: + create_space: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_spaces: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + delete_space: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + describe_space: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + update_space: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + search_spaces: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1search~1spaces/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/spaces/methods/describe_space" + - $ref: "#/components/x-stackQL-resources/spaces/methods/search_spaces" + - $ref: "#/components/x-stackQL-resources/spaces/methods/list_spaces" + insert: + - $ref: "#/components/x-stackQL-resources/spaces/methods/create_space" + update: + - $ref: "#/components/x-stackQL-resources/spaces/methods/update_space" + delete: + - $ref: "#/components/x-stackQL-resources/spaces/methods/delete_space" templates: id: aws.quicksight.templates name: templates @@ -32457,6 +38332,102 @@ components: - $ref: "#/components/x-stackQL-resources/topic_refresh_schedules/methods/update_topic_refresh_schedule" delete: - $ref: "#/components/x-stackQL-resources/topic_refresh_schedules/methods/delete_topic_refresh_schedule" + topic_v2s: + id: aws.quicksight.topic_v2s + name: topic_v2s + title: topic_v2s + methods: + create_topic_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_topic_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2~1{topic_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + describe_topic_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2~1{topic_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_topic_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2~1{topic_id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/topic_v2s/methods/describe_topic_v2" + insert: + - $ref: "#/components/x-stackQL-resources/topic_v2s/methods/create_topic_v2" + update: + - $ref: "#/components/x-stackQL-resources/topic_v2s/methods/update_topic_v2" + delete: + - $ref: "#/components/x-stackQL-resources/topic_v2s/methods/delete_topic_v2" + topics_v2s: + id: aws.quicksight.topics_v2s + name: topics_v2s + title: topics_v2s + methods: + list_topics_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.TopicSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next-token + location: query + responseToken: + key: $.NextToken + location: body + search_topics_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1search~1topicsV2/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.TopicSummaryList + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/topics_v2s/methods/search_topics_v2" + - $ref: "#/components/x-stackQL-resources/topics_v2s/methods/list_topics_v2" + insert: [] + update: [] + delete: [] vpc_connections: id: aws.quicksight.vpc_connections name: vpc_connections @@ -32879,6 +38850,35 @@ components: update: - $ref: "#/components/x-stackQL-resources/action_connector_permissions/methods/update_action_connector_permissions" delete: [] + agent_permissions: + id: aws.quicksight.agent_permissions + name: agent_permissions + title: agent_permissions + methods: + describe_agent_permissions: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents~1{agent_id}~1permissions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_agent_permissions: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1agents~1{agent_id}~1permissions/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_permissions/methods/describe_agent_permissions" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/agent_permissions/methods/update_agent_permissions" + delete: [] analysis_definitions: id: aws.quicksight.analysis_definitions name: analysis_definitions @@ -33368,6 +39368,35 @@ components: update: - $ref: "#/components/x-stackQL-resources/key_registrations/methods/update_key_registration" delete: [] + knowledge_base_permissions: + id: aws.quicksight.knowledge_base_permissions + name: knowledge_base_permissions + title: knowledge_base_permissions + methods: + describe_knowledge_base_permissions: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1{knowledge_base_id}~1permissions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_knowledge_base_permissions: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1knowledge-bases~1{knowledge_base_id}~1permissions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/knowledge_base_permissions/methods/describe_knowledge_base_permissions" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/knowledge_base_permissions/methods/update_knowledge_base_permissions" + delete: [] q_personalization_configurations: id: aws.quicksight.q_personalization_configurations name: q_personalization_configurations @@ -33455,6 +39484,35 @@ components: update: - $ref: "#/components/x-stackQL-resources/self_upgrade_configurations/methods/update_self_upgrade_configuration" delete: [] + space_permissions: + id: aws.quicksight.space_permissions + name: space_permissions + title: space_permissions + methods: + describe_space_permissions: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}~1permissions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_space_permissions: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}~1permissions/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/space_permissions/methods/describe_space_permissions" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/space_permissions/methods/update_space_permissions" + delete: [] template_definitions: id: aws.quicksight.template_definitions name: template_definitions @@ -33561,6 +39619,35 @@ components: update: - $ref: "#/components/x-stackQL-resources/topic_permissions/methods/update_topic_permissions" delete: [] + topic_permissions_v2s: + id: aws.quicksight.topic_permissions_v2s + name: topic_permissions_v2s + title: topic_permissions_v2s + methods: + describe_topic_permissions_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2~1{topic_id}~1permissions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_topic_permissions_v2: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1topicsV2~1{topic_id}~1permissions/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/topic_permissions_v2s/methods/describe_topic_permissions_v2" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/topic_permissions_v2s/methods/update_topic_permissions_v2" + delete: [] topic_refreshes: id: aws.quicksight.topic_refreshes name: topic_refreshes @@ -33760,54 +39847,6 @@ components: insert: [] update: [] delete: [] - flows: - id: aws.quicksight.flows - name: flows - title: flows - methods: - list_flows: - operation: - $ref: "#/paths/~1accounts~1{aws_account_id}~1flows/get" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.FlowSummaryList - request: - nativeCasing: pascal - config: - pagination: - requestToken: - key: next-token - location: query - responseToken: - key: $.NextToken - location: body - search_flows: - operation: - $ref: "#/paths/~1accounts~1{aws_account_id}~1flows~1searchFlows/post" - response: - openAPIDocKey: "200" - mediaType: application/json - objectKey: $.FlowSummaryList - request: - nativeCasing: pascal - config: - pagination: - requestToken: - key: NextToken - location: body - responseToken: - key: $.NextToken - location: body - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/flows/methods/search_flows" - - $ref: "#/components/x-stackQL-resources/flows/methods/list_flows" - insert: [] - update: [] - delete: [] folder_members: id: aws.quicksight.folder_members name: folder_members @@ -33929,6 +39968,35 @@ components: update: - $ref: "#/components/x-stackQL-resources/self_upgrades/methods/update_self_upgrade" delete: [] + space_resources: + id: aws.quicksight.space_resources + name: space_resources + title: space_resources + methods: + list_space_resources: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}~1resources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_space_resources: + operation: + $ref: "#/paths/~1v1~1accounts~1{aws_account_id}~1spaces~1{space_id}~1resources/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/space_resources/methods/list_space_resources" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/space_resources/methods/update_space_resources" + delete: [] tags: id: aws.quicksight.tags name: tags @@ -34115,6 +40183,28 @@ components: insert: [] update: [] delete: [] + users_index_capacities: + id: aws.quicksight.users_index_capacities + name: users_index_capacities + title: users_index_capacities + methods: + list_users_index_capacity: + operation: + $ref: "#/paths/~1accounts~1{aws_account_id}~1quick-index~1user-capacity/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/users_index_capacities/methods/list_users_index_capacity" + insert: [] + update: [] + delete: [] application_with_token_exchange_grants: id: aws.quicksight.application_with_token_exchange_grants name: application_with_token_exchange_grants diff --git a/providers/src/aws/v00.00.00000/services/rds.yaml b/providers/src/aws/v00.00.00000/services/rds.yaml index 264d7f1b..14045b97 100644 --- a/providers/src/aws/v00.00.00000/services/rds.yaml +++ b/providers/src/aws/v00.00.00000/services/rds.yaml @@ -40,7 +40,7 @@ paths: required: true description: The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/IAMRoleArn" - name: FeatureName in: query required: false @@ -891,13 +891,13 @@ paths: - name: Engine in: query required: false - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" schema: $ref: "#/components/schemas/CustomEngineName" - name: EngineVersion in: query required: true - description: The name of your custom engine version (CEV). For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. For RDS for SQL Server and RDS Custom for SQL Server, the name format is major engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1. The CEV name is unique per customer per Amazon Web Services Regions. + description: The name of your custom engine version (CEV). For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. For RDS Custom for SQL Server and RDS for SQL Server sqlserver-dev-ee, the name format is *major_engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), specify the RDS engine version that you want to use. For example, 16.00.4175.1.v1. The CEV name is unique per customer per Amazon Web Services Regions. schema: $ref: "#/components/schemas/CustomEngineVersion" - name: DatabaseInstallationFilesS3BucketName @@ -915,7 +915,7 @@ paths: - name: DatabaseInstallationFiles in: query required: false - description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. + description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), provide the SQL Server RTM ISO file once per major version and edition combination. Minor versions reuse the same file. schema: $ref: "#/components/schemas/StringList" - name: ImageId @@ -993,7 +993,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_CreateDBCluster - description: Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. You can use the WithExpressConfiguration parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. + description: Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. You can use the WithExpressConfiguration parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster. Each associated role lets the DB cluster access other Amazon Web Services on your behalf, such as Amazon S3 for data import and export, or Amazon Web Services Lambda for invoking functions. parameters: - name: AvailabilityZones in: query @@ -1327,7 +1327,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: TagSpecifications @@ -1348,6 +1348,12 @@ paths: description: "Specifies to create an Aurora DB Cluster with express configuration in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. Valid for Cluster Type: Aurora DB clusters" schema: $ref: "#/components/schemas/BooleanOptional" + - name: AssociatedRoles + in: query + required: false + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" + schema: + $ref: "#/components/schemas/DBClusterAssociatedRoles" responses: "200": description: Success @@ -1357,7 +1363,7 @@ paths: $ref: "#/components/schemas/CreateDBClusterOutputDisplay" post: operationId: POST_CreateDBCluster - description: Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. You can use the WithExpressConfiguration parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. + description: Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. You can use the WithExpressConfiguration parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster. Each associated role lets the DB cluster access other Amazon Web Services on your behalf, such as Amazon S3 for data import and export, or Amazon Web Services Lambda for invoking functions. responses: "200": description: Success @@ -1597,7 +1603,7 @@ paths: - name: Engine in: query required: false - description: "The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-oracle-se2 (for RDS Custom for Oracle DB instances) custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) custom-sqlserver-dev (for RDS Custom for SQL Server DB instances) db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-dev-ee sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-oracle-se2 (for RDS Custom for Oracle DB instances) custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) custom-sqlserver-dev (for RDS Custom for SQL Server DB instances) db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-dev-ee sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: MasterUsername @@ -1687,7 +1693,7 @@ paths: - name: LicenseModel in: query required: false - description: "The license model information for this DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is bring-your-own-license. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" + description: "The license model information for this DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is bring-your-own-license. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" schema: $ref: "#/components/schemas/String" - name: Iops @@ -1951,7 +1957,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: AdditionalStorageVolumes @@ -2226,7 +2232,7 @@ paths: - name: ReplicaMode in: query required: false - description: The open mode of the replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. + description: The open mode of the replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. schema: $ref: "#/components/schemas/ReplicaMode" - name: EnableCustomerOwnedIp @@ -2346,7 +2352,7 @@ paths: - name: DBParameterGroupFamily in: query required: true - description: 'The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql The output contains duplicates. The following are the valid DB engine values: aurora-mysql aurora-postgresql db2-ae db2-se mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web' + description: 'The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql The output contains duplicates. The following are the valid DB engine values: aurora-mysql aurora-postgresql db2-ae db2-ce db2-se mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web' schema: $ref: "#/components/schemas/String" - name: Description @@ -2936,7 +2942,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this global database cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this global database cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: DeletionProtection @@ -3091,7 +3097,7 @@ paths: - name: EngineName in: query required: true - description: "The name of the engine to associate this option group with. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the engine to associate this option group with. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: MajorEngineVersion @@ -3288,7 +3294,7 @@ paths: - name: Engine in: query required: false - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" schema: $ref: "#/components/schemas/CustomEngineName" - name: EngineVersion @@ -4892,7 +4898,7 @@ paths: - name: Engine in: query required: false - description: "The database engine to return version details for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to return version details for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web sqlserver-dev-ee" schema: $ref: "#/components/schemas/String" - name: EngineVersion @@ -5198,7 +5204,7 @@ paths: - name: Engine in: query required: false - description: "The database engine to return major version details for. Valid Values: aurora-mysql aurora-postgresql custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to return major version details for. Valid Values: aurora-mysql aurora-postgresql custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/Engine" - name: MajorEngineVersion @@ -6164,7 +6170,7 @@ paths: - name: DBParameterGroupFamily in: query required: true - description: "The name of the DB parameter group family. Valid Values: aurora-mysql5.7 aurora-mysql8.0 aurora-postgresql10 aurora-postgresql11 aurora-postgresql12 aurora-postgresql13 aurora-postgresql14 custom-oracle-ee-19 custom-oracle-ee-cdb-19 db2-ae db2-se mariadb10.2 mariadb10.3 mariadb10.4 mariadb10.5 mariadb10.6 mysql5.7 mysql8.0 oracle-ee-19 oracle-ee-cdb-19 oracle-ee-cdb-21 oracle-se2-19 oracle-se2-cdb-19 oracle-se2-cdb-21 postgres10 postgres11 postgres12 postgres13 postgres14 sqlserver-ee-11.0 sqlserver-ee-12.0 sqlserver-ee-13.0 sqlserver-ee-14.0 sqlserver-ee-15.0 sqlserver-ex-11.0 sqlserver-ex-12.0 sqlserver-ex-13.0 sqlserver-ex-14.0 sqlserver-ex-15.0 sqlserver-se-11.0 sqlserver-se-12.0 sqlserver-se-13.0 sqlserver-se-14.0 sqlserver-se-15.0 sqlserver-web-11.0 sqlserver-web-12.0 sqlserver-web-13.0 sqlserver-web-14.0 sqlserver-web-15.0" + description: "The name of the DB parameter group family. Valid Values: aurora-mysql5.7 aurora-mysql8.0 aurora-postgresql10 aurora-postgresql11 aurora-postgresql12 aurora-postgresql13 aurora-postgresql14 custom-oracle-ee-19 custom-oracle-ee-cdb-19 db2-ae db2-ce db2-se mariadb10.2 mariadb10.3 mariadb10.4 mariadb10.5 mariadb10.6 mysql5.7 mysql8.0 oracle-ee-19 oracle-ee-cdb-19 oracle-ee-cdb-21 oracle-se2-19 oracle-se2-cdb-19 oracle-se2-cdb-21 postgres10 postgres11 postgres12 postgres13 postgres14 sqlserver-ee-11.0 sqlserver-ee-12.0 sqlserver-ee-13.0 sqlserver-ee-14.0 sqlserver-ee-15.0 sqlserver-ex-11.0 sqlserver-ex-12.0 sqlserver-ex-13.0 sqlserver-ex-14.0 sqlserver-ex-15.0 sqlserver-se-11.0 sqlserver-se-12.0 sqlserver-se-13.0 sqlserver-se-14.0 sqlserver-se-15.0 sqlserver-web-11.0 sqlserver-web-12.0 sqlserver-web-13.0 sqlserver-web-14.0 sqlserver-web-15.0" schema: $ref: "#/components/schemas/String" - name: Filters @@ -6614,7 +6620,7 @@ paths: - name: EngineName in: query required: true - description: "The name of the engine to describe options for. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the engine to describe options for. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: MajorEngineVersion @@ -6704,7 +6710,7 @@ paths: - name: EngineName in: query required: false - description: "A filter to only include option groups associated with this database engine. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "A filter to only include option groups associated with this database engine. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: MajorEngineVersion @@ -6752,7 +6758,7 @@ paths: - name: Engine in: query required: false - description: "The name of the database engine to describe DB instance options for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the database engine to describe DB instance options for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: EngineVersion @@ -7796,7 +7802,7 @@ paths: - name: Engine in: query required: false - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" schema: $ref: "#/components/schemas/CustomEngineName" - name: EngineVersion @@ -8134,6 +8140,12 @@ paths: description: "Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication. You can specify one of the following values: password - Use standard database authentication with a password. iam-db-auth - Use IAM database authentication for the master user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines." schema: $ref: "#/components/schemas/MasterUserAuthenticationType" + - name: EngineLifecycleSupport + in: query + required: false + description: "The lifecycle type for this DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support or to opt out. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled" + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -8437,7 +8449,7 @@ paths: - name: LicenseModel in: query required: false - description: "The license model for the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" + description: "The license model for the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" schema: $ref: "#/components/schemas/String" - name: Iops @@ -8635,7 +8647,7 @@ paths: - name: ReplicaMode in: query required: false - description: The open mode of a replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. + description: The open mode of a replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. schema: $ref: "#/components/schemas/ReplicaMode" - name: AutomationMode @@ -8722,6 +8734,12 @@ paths: description: "Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication. You can specify one of the following values: password - Use standard database authentication with a password. iam-db-auth - Use IAM database authentication for the master user. This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines." schema: $ref: "#/components/schemas/MasterUserAuthenticationType" + - name: EngineLifecycleSupport + in: query + required: false + description: "The lifecycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support or to opt out. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled This setting doesn't apply to RDS Custom DB instances." + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -10040,7 +10058,7 @@ paths: required: true description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. schema: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/IAMRoleArn" - name: FeatureName in: query required: false @@ -10315,7 +10333,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_RestoreDBClusterFromS3 - description: Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters. The source DB engine must be MySQL. + description: Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters. The source DB engine must be MySQL. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with the Aurora DB cluster when you restore it from Amazon S3. parameters: - name: AvailabilityZones in: query @@ -10534,7 +10552,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: TagSpecifications @@ -10543,6 +10561,12 @@ paths: description: "Tags to assign to resources associated with the DB cluster. Valid Values: cluster-auto-backup - The DB cluster's automated backup." schema: $ref: "#/components/schemas/TagSpecificationList" + - name: AssociatedRoles + in: query + required: false + description: A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from Amazon S3. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). + schema: + $ref: "#/components/schemas/DBClusterAssociatedRoles" responses: "200": description: Success @@ -10552,7 +10576,7 @@ paths: $ref: "#/components/schemas/RestoreDBClusterFromS3OutputDisplay" post: operationId: POST_RestoreDBClusterFromS3 - description: Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters. The source DB engine must be MySQL. + description: Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters. The source DB engine must be MySQL. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with the Aurora DB cluster when you restore it from Amazon S3. responses: "200": description: Success @@ -10577,7 +10601,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_RestoreDBClusterFromSnapshot - description: Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. + description: Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster when you restore it from a snapshot. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. parameters: - name: AvailabilityZones in: query @@ -10797,7 +10821,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: TagSpecifications @@ -10818,6 +10842,12 @@ paths: description: "Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC. This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication. Valid for Cluster Type: Aurora PostgreSQL clusters" schema: $ref: "#/components/schemas/BooleanOptional" + - name: AssociatedRoles + in: query + required: false + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from a snapshot. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" + schema: + $ref: "#/components/schemas/DBClusterAssociatedRoles" responses: "200": description: Success @@ -10827,7 +10857,7 @@ paths: $ref: "#/components/schemas/RestoreDBClusterFromSnapshotOutputDisplay" post: operationId: POST_RestoreDBClusterFromSnapshot - description: Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. + description: Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster when you restore it from a snapshot. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. responses: "200": description: Success @@ -10852,7 +10882,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_RestoreDBClusterToPointInTime - description: Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. + description: Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster when you restore it to a point in time. For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. parameters: - name: DBClusterIdentifier in: query @@ -11071,7 +11101,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: TagSpecifications @@ -11092,6 +11122,12 @@ paths: description: "Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC. This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication. Valid for Cluster Type: Aurora PostgreSQL clusters" schema: $ref: "#/components/schemas/BooleanOptional" + - name: AssociatedRoles + in: query + required: false + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored to a point in time. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" + schema: + $ref: "#/components/schemas/DBClusterAssociatedRoles" responses: "200": description: Success @@ -11101,7 +11137,7 @@ paths: $ref: "#/components/schemas/RestoreDBClusterToPointInTimeOutputDisplay" post: operationId: POST_RestoreDBClusterToPointInTime - description: Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. + description: Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. You can use the EnableVPCNetworking and EnableInternetAccessGateway parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set EnableVPCNetworking to false to disable the VPC network interface (ENI) for the cluster. EnableInternetAccessGateway enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using EnableIAMDatabaseAuthentication. Once the cluster is restored, you need to modify the DB cluster to update MasterUserAuthenticationType to iam-db-auth. You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster when you restore it to a point in time. For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. responses: "200": description: Success @@ -11185,7 +11221,7 @@ paths: - name: LicenseModel in: query required: false - description: "License model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." + description: "License model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." schema: $ref: "#/components/schemas/String" - name: DBName @@ -11197,7 +11233,7 @@ paths: - name: Engine in: query required: false - description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" schema: $ref: "#/components/schemas/String" - name: Iops @@ -11388,7 +11424,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: AdditionalStorageVolumes @@ -11760,7 +11796,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: AdditionalStorageVolumes @@ -11880,7 +11916,7 @@ paths: - name: LicenseModel in: query required: false - description: "The license model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." + description: "The license model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." schema: $ref: "#/components/schemas/String" - name: DBName @@ -11892,7 +11928,7 @@ paths: - name: Engine in: query required: false - description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web Default: The same as source Constraints: Must be compatible with the engine of the source." + description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web Default: The same as source Constraints: Must be compatible with the engine of the source." schema: $ref: "#/components/schemas/String" - name: Iops @@ -12095,7 +12131,7 @@ paths: - name: EngineLifecycleSupport in: query required: false - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" schema: $ref: "#/components/schemas/String" - name: AdditionalStorageVolumes @@ -12870,6 +12906,11 @@ components: schemas: String: type: string + IAMRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws[a-z-]*:iam::[0-9]*:role/.* AddRoleToDBClusterMessage: type: object properties: @@ -12877,7 +12918,7 @@ components: $ref: "#/components/schemas/String" description: The name of the DB cluster to associate the IAM role with. RoleArn: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/IAMRoleArn" description: The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. FeatureName: $ref: "#/components/schemas/String" @@ -13792,7 +13833,7 @@ components: description: The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. DatabaseInstallationFiles: type: string - description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. Required for sqlserver-dev-ee. + description: The database installation files (ISO and EXE) that were uploaded to Amazon S3 and used to import the database engine version to Amazon RDS. Returned for RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee) created from customer-supplied installation media. CustomDBEngineVersionManifest: type: string description: JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide. @@ -13813,13 +13854,13 @@ components: description: The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified. FailureReason: type: string - description: The reason that the custom engine version creation for sqlserver-dev-ee failed with an incompatible-installation-media status. + description: The reason that the custom engine version creation failed with an incompatible-installation-media status. Applicable to RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee). Image: type: string description: The EC2 image DBEngineMediaType: type: string - description: A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server. + description: The source of the installation media for this engine version. A value of Customer Provided indicates that the engine version was created from customer-supplied installation media using CreateCustomDBEngineVersion. Applicable to RDS Custom for SQL Server and to RDS for SQL Server engine versions (sqlserver-ee and sqlserver-se with the bring-your-own-media license model, and sqlserver-dev-ee). KMSKeyId: type: string description: The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. @@ -13898,10 +13939,10 @@ components: properties: Engine: $ref: "#/components/schemas/CustomEngineName" - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" EngineVersion: $ref: "#/components/schemas/CustomEngineVersion" - description: The name of your custom engine version (CEV). For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. For RDS for SQL Server and RDS Custom for SQL Server, the name format is major engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1. The CEV name is unique per customer per Amazon Web Services Regions. + description: The name of your custom engine version (CEV). For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. For RDS Custom for SQL Server and RDS for SQL Server sqlserver-dev-ee, the name format is *major_engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), specify the RDS engine version that you want to use. For example, 16.00.4175.1.v1. The CEV name is unique per customer per Amazon Web Services Regions. DatabaseInstallationFilesS3BucketName: $ref: "#/components/schemas/BucketName" description: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files. @@ -13910,7 +13951,7 @@ components: description: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed. DatabaseInstallationFiles: $ref: "#/components/schemas/StringList" - description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. + description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), provide the SQL Server RTM ISO file once per major version and edition combination. Minor versions reuse the same file. ImageId: $ref: "#/components/schemas/String255" description: The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation. @@ -14038,6 +14079,22 @@ components: enum: - password - iam-db-auth + DBClusterAssociatedRoles: + type: array + items: + $ref: "#/components/schemas/DBClusterAssociatedRole" + DBClusterAssociatedRole: + description: Contains information about an Amazon Web Services Identity and Access Management (IAM) role to associate with a DB cluster. You can specify this structure in the AssociatedRoles parameter of CreateDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime. + type: object + properties: + RoleArn: + $ref: "#/components/schemas/IAMRoleArn" + description: The Amazon Resource Name (ARN) of the IAM role to associate with the DB cluster. + FeatureName: + $ref: "#/components/schemas/String" + description: The name of the feature associated with the IAM role. For information about supported feature names, see DBEngineVersion. + required: + - RoleArn DBClusterDisplay: type: object properties: @@ -14481,7 +14538,7 @@ components: description: "The CA certificate identifier to use for the DB cluster's server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters" EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" TagSpecifications: $ref: "#/components/schemas/TagSpecificationList" description: "Tags to assign to resources associated with the DB cluster. Valid Values: cluster-auto-backup - The DB cluster's automated backup." @@ -14491,6 +14548,9 @@ components: WithExpressConfiguration: $ref: "#/components/schemas/BooleanOptional" description: "Specifies to create an Aurora DB Cluster with express configuration in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. Valid for Cluster Type: Aurora DB clusters" + AssociatedRoles: + $ref: "#/components/schemas/DBClusterAssociatedRoles" + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" required: - DBClusterIdentifier - Engine @@ -14929,6 +14989,12 @@ components: StorageVolumeStatus: type: string description: The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state. + StorageOperationStatus: + type: string + description: "The status of an in-progress storage operation on the DB instance. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. Possible values: Initializing - The volume is initializing from a snapshot, such as during a snapshot restore, point-in-time restore, read replica creation, or blue/green deployment. Performance can be lower than provisioned until initialization completes. Optimizing - The volume is optimizing following a storage scaling or modification operation." + StorageOperationPercentProgress: + type: integer + description: The percentage of the in-progress storage operation on the DB instance that has completed, from 0 to 100. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. CreateDBInstanceOutputDisplay: type: object properties: @@ -14953,7 +15019,7 @@ components: description: The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. Engine: $ref: "#/components/schemas/String" - description: "The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-oracle-se2 (for RDS Custom for Oracle DB instances) custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) custom-sqlserver-dev (for RDS Custom for SQL Server DB instances) db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-dev-ee sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-oracle-se2 (for RDS Custom for Oracle DB instances) custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) custom-sqlserver-dev (for RDS Custom for SQL Server DB instances) db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-dev-ee sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" MasterUsername: $ref: "#/components/schemas/String" description: "The name for the master user. This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster. This setting is required for RDS DB instances. Constraints: Must be 1 to 16 letters, numbers, or underscores. First character must be a letter. Can't be a reserved word for the chosen database engine." @@ -14998,7 +15064,7 @@ components: description: Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. LicenseModel: $ref: "#/components/schemas/String" - description: "The license model information for this DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is bring-your-own-license. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" + description: "The license model information for this DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is bring-your-own-license. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" Iops: $ref: "#/components/schemas/IntegerOptional" description: "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Constraints: For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance." @@ -15130,7 +15196,7 @@ components: description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" AdditionalStorageVolumes: $ref: "#/components/schemas/AdditionalStorageVolumesList" description: A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only. @@ -15263,7 +15329,7 @@ components: description: "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: 123.124.125.126,234.235.236.237" ReplicaMode: $ref: "#/components/schemas/ReplicaMode" - description: The open mode of the replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. + description: The open mode of the replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. EnableCustomerOwnedIp: $ref: "#/components/schemas/BooleanOptional" description: Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide. @@ -15317,7 +15383,7 @@ components: description: "The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string." DBParameterGroupFamily: $ref: "#/components/schemas/String" - description: 'The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql The output contains duplicates. The following are the valid DB engine values: aurora-mysql aurora-postgresql db2-ae db2-se mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web' + description: 'The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql The output contains duplicates. The following are the valid DB engine values: aurora-mysql aurora-postgresql db2-ae db2-ce db2-se mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web' Description: $ref: "#/components/schemas/String" description: The description for the DB parameter group. @@ -15883,7 +15949,7 @@ components: description: "The engine version to use for this global database cluster. Constraints: Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster." EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this global database cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this global database cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" DeletionProtection: $ref: "#/components/schemas/BooleanOptional" description: Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled. @@ -16013,7 +16079,7 @@ components: description: "Specifies the name of the option group to be created. Constraints: Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: myoptiongroup" EngineName: $ref: "#/components/schemas/String" - description: "The name of the engine to associate this option group with. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the engine to associate this option group with. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" MajorEngineVersion: $ref: "#/components/schemas/String" description: Specifies the major version of the engine that this option group should be associated with. @@ -16148,7 +16214,7 @@ components: properties: Engine: $ref: "#/components/schemas/CustomEngineName" - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" EngineVersion: $ref: "#/components/schemas/CustomEngineVersion" description: The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region. @@ -17049,7 +17115,7 @@ components: properties: Engine: $ref: "#/components/schemas/String" - description: "The database engine to return version details for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to return version details for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web sqlserver-dev-ee" EngineVersion: $ref: "#/components/schemas/String" description: "A specific database engine version to return details for. Example: 5.1.49" @@ -17212,7 +17278,7 @@ components: properties: Engine: $ref: "#/components/schemas/Engine" - description: "The database engine to return major version details for. Valid Values: aurora-mysql aurora-postgresql custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to return major version details for. Valid Values: aurora-mysql aurora-postgresql custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" MajorEngineVersion: $ref: "#/components/schemas/MajorEngineVersion" description: "A specific database major engine version to return details for. Example: 8.4" @@ -17765,7 +17831,7 @@ components: properties: DBParameterGroupFamily: $ref: "#/components/schemas/String" - description: "The name of the DB parameter group family. Valid Values: aurora-mysql5.7 aurora-mysql8.0 aurora-postgresql10 aurora-postgresql11 aurora-postgresql12 aurora-postgresql13 aurora-postgresql14 custom-oracle-ee-19 custom-oracle-ee-cdb-19 db2-ae db2-se mariadb10.2 mariadb10.3 mariadb10.4 mariadb10.5 mariadb10.6 mysql5.7 mysql8.0 oracle-ee-19 oracle-ee-cdb-19 oracle-ee-cdb-21 oracle-se2-19 oracle-se2-cdb-19 oracle-se2-cdb-21 postgres10 postgres11 postgres12 postgres13 postgres14 sqlserver-ee-11.0 sqlserver-ee-12.0 sqlserver-ee-13.0 sqlserver-ee-14.0 sqlserver-ee-15.0 sqlserver-ex-11.0 sqlserver-ex-12.0 sqlserver-ex-13.0 sqlserver-ex-14.0 sqlserver-ex-15.0 sqlserver-se-11.0 sqlserver-se-12.0 sqlserver-se-13.0 sqlserver-se-14.0 sqlserver-se-15.0 sqlserver-web-11.0 sqlserver-web-12.0 sqlserver-web-13.0 sqlserver-web-14.0 sqlserver-web-15.0" + description: "The name of the DB parameter group family. Valid Values: aurora-mysql5.7 aurora-mysql8.0 aurora-postgresql10 aurora-postgresql11 aurora-postgresql12 aurora-postgresql13 aurora-postgresql14 custom-oracle-ee-19 custom-oracle-ee-cdb-19 db2-ae db2-ce db2-se mariadb10.2 mariadb10.3 mariadb10.4 mariadb10.5 mariadb10.6 mysql5.7 mysql8.0 oracle-ee-19 oracle-ee-cdb-19 oracle-ee-cdb-21 oracle-se2-19 oracle-se2-cdb-19 oracle-se2-cdb-21 postgres10 postgres11 postgres12 postgres13 postgres14 sqlserver-ee-11.0 sqlserver-ee-12.0 sqlserver-ee-13.0 sqlserver-ee-14.0 sqlserver-ee-15.0 sqlserver-ex-11.0 sqlserver-ex-12.0 sqlserver-ex-13.0 sqlserver-ex-14.0 sqlserver-ex-15.0 sqlserver-se-11.0 sqlserver-se-12.0 sqlserver-se-13.0 sqlserver-se-14.0 sqlserver-se-15.0 sqlserver-web-11.0 sqlserver-web-12.0 sqlserver-web-13.0 sqlserver-web-14.0 sqlserver-web-15.0" Filters: $ref: "#/components/schemas/FilterList" description: A filter that specifies one or more parameters to describe. The only supported filter is parameter-name. The results list only includes information about the parameters with these names. @@ -18039,7 +18105,7 @@ components: properties: EngineName: $ref: "#/components/schemas/String" - description: "The name of the engine to describe options for. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the engine to describe options for. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" MajorEngineVersion: $ref: "#/components/schemas/String" description: If specified, filters the results to include only options for the specified major engine version. @@ -18078,7 +18144,7 @@ components: description: "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100." EngineName: $ref: "#/components/schemas/String" - description: "A filter to only include option groups associated with this database engine. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "A filter to only include option groups associated with this database engine. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" MajorEngineVersion: $ref: "#/components/schemas/String" description: Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. @@ -18214,7 +18280,7 @@ components: properties: Engine: $ref: "#/components/schemas/String" - description: "The name of the database engine to describe DB instance options for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The name of the database engine to describe DB instance options for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" EngineVersion: $ref: "#/components/schemas/String" description: A filter to include only the available options for the specified engine version. @@ -18851,7 +18917,7 @@ components: properties: Engine: $ref: "#/components/schemas/CustomEngineName" - description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se ccustom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports only sqlserver-dev-ee." + description: "The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee" EngineVersion: $ref: "#/components/schemas/CustomEngineVersion" description: The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region. @@ -19029,6 +19095,9 @@ components: MasterUserAuthenticationType: $ref: "#/components/schemas/MasterUserAuthenticationType" description: "Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication. You can specify one of the following values: password - Use standard database authentication with a password. iam-db-auth - Use IAM database authentication for the master user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines." + EngineLifecycleSupport: + $ref: "#/components/schemas/String" + description: "The lifecycle type for this DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support or to opt out. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled" required: - DBClusterIdentifier ModifyDBClusterEndpointOutputDisplay: @@ -19257,7 +19326,7 @@ components: description: "Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met: The automatic upgrade is enabled for the maintenance window. A newer minor version is available. RDS has enabled automatic patching for the engine version. If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version." LicenseModel: $ref: "#/components/schemas/String" - description: "The license model for the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" + description: "The license model for the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license" Iops: $ref: "#/components/schemas/IntegerOptional" description: "The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. If you choose to migrate your DB instance from using standard storage to Provisioned IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance. Constraints: For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter. You can use the current value for AllocatedStorage. Default: Uses existing setting" @@ -19356,7 +19425,7 @@ components: description: "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances." ReplicaMode: $ref: "#/components/schemas/ReplicaMode" - description: The open mode of a replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. + description: The open mode of a replica database. This parameter is only supported for Db2 DB instances and Oracle DB instances. Db2 Standby DB replicas are included in Db2 Advanced Edition (AE), Db2 Community Edition (CE), and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User Guide. To create standby DB replicas for RDS for Db2, set this parameter to mounted. Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually. AutomationMode: $ref: "#/components/schemas/AutomationMode" description: The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes. @@ -19399,6 +19468,9 @@ components: MasterUserAuthenticationType: $ref: "#/components/schemas/MasterUserAuthenticationType" description: "Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication. You can specify one of the following values: password - Use standard database authentication with a password. iam-db-auth - Use IAM database authentication for the master user. This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines." + EngineLifecycleSupport: + $ref: "#/components/schemas/String" + description: "The lifecycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support or to opt out. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled This setting doesn't apply to RDS Custom DB instances." required: - DBInstanceIdentifier DBParameterGroupNameMessageDisplay: @@ -20030,7 +20102,7 @@ components: $ref: "#/components/schemas/String" description: The name of the DB cluster to disassociate the IAM role from. RoleArn: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/IAMRoleArn" description: The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. FeatureName: $ref: "#/components/schemas/String" @@ -20249,10 +20321,13 @@ components: description: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" TagSpecifications: $ref: "#/components/schemas/TagSpecificationList" description: "Tags to assign to resources associated with the DB cluster. Valid Values: cluster-auto-backup - The DB cluster's automated backup." + AssociatedRoles: + $ref: "#/components/schemas/DBClusterAssociatedRoles" + description: A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from Amazon S3. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). required: - DBClusterIdentifier - Engine @@ -20380,7 +20455,7 @@ components: description: "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes." EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" TagSpecifications: $ref: "#/components/schemas/TagSpecificationList" description: "Tags to assign to resources associated with the DB cluster. Valid Values: cluster-auto-backup - The DB cluster's automated backup." @@ -20390,6 +20465,9 @@ components: EnableInternetAccessGateway: $ref: "#/components/schemas/BooleanOptional" description: "Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC. This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication. Valid for Cluster Type: Aurora PostgreSQL clusters" + AssociatedRoles: + $ref: "#/components/schemas/DBClusterAssociatedRoles" + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored from a snapshot. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" required: - DBClusterIdentifier - SnapshotIdentifier @@ -20512,7 +20590,7 @@ components: description: "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes." EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB cluster. By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" TagSpecifications: $ref: "#/components/schemas/TagSpecificationList" description: "Tags to assign to resources associated with the DB cluster. Valid Values: cluster-auto-backup - The DB cluster's automated backup." @@ -20522,6 +20600,9 @@ components: EnableInternetAccessGateway: $ref: "#/components/schemas/BooleanOptional" description: "Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC. This parameter must be used together with EnableVPCNetworking set to false. When both parameters are specified, IAM database authentication is required. You must also specify EnableIAMDatabaseAuthentication. Valid for Cluster Type: Aurora PostgreSQL clusters" + AssociatedRoles: + $ref: "#/components/schemas/DBClusterAssociatedRoles" + description: "A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster when it's restored to a point in time. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as s3Import, s3Export, or Lambda). Valid for Cluster Type: Aurora DB clusters only" required: - DBClusterIdentifier RestoreDBInstanceFromDBSnapshotOutputDisplay: @@ -20563,13 +20644,13 @@ components: description: Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. LicenseModel: $ref: "#/components/schemas/String" - description: "License model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." + description: "License model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." DBName: $ref: "#/components/schemas/String" description: The name of the database for the restored DB instance. This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances. Engine: $ref: "#/components/schemas/String" - description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" + description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web" Iops: $ref: "#/components/schemas/IntegerOptional" description: "Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000." @@ -20664,7 +20745,7 @@ components: description: The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" AdditionalStorageVolumes: $ref: "#/components/schemas/AdditionalStorageVolumesList" description: A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only. @@ -20844,7 +20925,7 @@ components: description: The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" AdditionalStorageVolumes: $ref: "#/components/schemas/AdditionalStorageVolumesList" description: A list of additional storage volumes to modify or delete for the DB instance. You can modify or delete up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only. @@ -20904,13 +20985,13 @@ components: description: Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. This setting doesn't apply to RDS Custom. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. LicenseModel: $ref: "#/components/schemas/String" - description: "The license model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." + description: "The license model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included | bring-your-own-media RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license Default: Same as the source." DBName: $ref: "#/components/schemas/String" description: "The database name for the restored DB instance. This parameter doesn't apply to the following DB instances: RDS Custom RDS for Db2 RDS for MariaDB RDS for MySQL" Engine: $ref: "#/components/schemas/String" - description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Valid Values: db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web Default: The same as source Constraints: Must be compatible with the engine of the source." + description: "The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web Default: The same as source Constraints: Must be compatible with the engine of the source." Iops: $ref: "#/components/schemas/IntegerOptional" description: "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. This setting doesn't apply to SQL Server. Constraints: Must be an integer greater than 1000." @@ -21011,7 +21092,7 @@ components: description: The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. EngineLifecycleSupport: $ref: "#/components/schemas/String" - description: "The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" + description: "The lifecycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the engine lifecycle support is managed by the DB cluster. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support" AdditionalStorageVolumes: $ref: "#/components/schemas/AdditionalStorageVolumesList" description: A list of additional storage volumes to restore to the DB instance. You can restore up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only. diff --git a/providers/src/aws/v00.00.00000/services/redshift.yaml b/providers/src/aws/v00.00.00000/services/redshift.yaml index 395a66be..896a41d4 100644 --- a/providers/src/aws/v00.00.00000/services/redshift.yaml +++ b/providers/src/aws/v00.00.00000/services/redshift.yaml @@ -698,7 +698,7 @@ paths: - name: NodeType in: query required: true - description: "The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" + description: "The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" schema: $ref: "#/components/schemas/String" - name: MasterUsername @@ -1588,6 +1588,66 @@ paths: text/xml: schema: $ref: "#/components/schemas/CreateIntegrationMessage" + /?Action=CreateQev2IdcApplication&Version=2012-12-01: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_CreateQev2IdcApplication + description: Creates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + parameters: + - name: IdcInstanceArn + in: query + required: true + description: The Amazon Resource Name (ARN) of the IAM Identity Center instance used to create the Amazon Redshift Query Editor (QEV2) managed application. + schema: + $ref: "#/components/schemas/String" + - name: Qev2IdcApplicationName + in: query + required: true + description: The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center. + schema: + $ref: "#/components/schemas/Qev2IdcApplicationName" + - name: IdcDisplayName + in: query + required: true + description: The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. + schema: + $ref: "#/components/schemas/IdcDisplayNameString" + - name: Tags + in: query + required: false + description: A list of tags to associate with the application. Tags are key-value pairs that you can use to organize and identify your resources. + schema: + $ref: "#/components/schemas/TagList" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateQev2IdcApplicationOutputDisplay" + post: + operationId: POST_CreateQev2IdcApplication + description: Creates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateQev2IdcApplicationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/CreateQev2IdcApplicationMessage" /?Action=CreateRedshiftIdcApplication&Version=2012-12-01: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -2596,6 +2656,40 @@ paths: text/xml: schema: $ref: "#/components/schemas/PartnerIntegrationInputMessage" + /?Action=DeleteQev2IdcApplication&Version=2012-12-01: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DeleteQev2IdcApplication + description: Deletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + parameters: + - name: Qev2IdcApplicationArn + in: query + required: true + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application to delete. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + post: + operationId: POST_DeleteQev2IdcApplication + description: Deletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + responses: + "200": + description: Success + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DeleteQev2IdcApplicationMessage" /?Action=DeleteRedshiftIdcApplication&Version=2012-12-01: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -4687,6 +4781,60 @@ paths: text/xml: schema: $ref: "#/components/schemas/DescribePartnersInputMessage" + /?Action=DescribeQev2IdcApplications&Version=2012-12-01: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_DescribeQev2IdcApplications + description: Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters. + parameters: + - name: Qev2IdcApplicationArn + in: query + required: false + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center. + schema: + $ref: "#/components/schemas/String" + - name: MaxRecords + in: query + required: false + description: The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. + schema: + $ref: "#/components/schemas/IntegerOptional" + - name: Marker + in: query + required: false + description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + schema: + $ref: "#/components/schemas/String" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeQev2IdcApplicationsOutputDisplay" + post: + operationId: POST_DescribeQev2IdcApplications + description: Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeQev2IdcApplicationsOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/DescribeQev2IdcApplicationsMessage" /?Action=DescribeRedshiftIdcApplications&Version=2012-12-01: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -5433,6 +5581,18 @@ paths: description: "The identifier of the cluster on which logging is to be stopped. Example: examplecluster" schema: $ref: "#/components/schemas/String" + - name: LogDestinationType + in: query + required: false + description: The log destination type. An enum with possible values of s3, cloudwatch, and s3table. When set to s3table, stops system table publishing. When omitted, the operation disables audit logging. + schema: + $ref: "#/components/schemas/LogDestinationType" + - name: LogExports + in: query + required: false + description: The collection of log types to stop exporting. When LogDestinationType is s3table, the values are the names of the system tables to stop publishing. Omitting this parameter or passing all stops publishing all system tables. + schema: + $ref: "#/components/schemas/LogTypeList" responses: "200": description: Success @@ -5592,15 +5752,27 @@ paths: - name: LogDestinationType in: query required: false - description: The log destination type. An enum with possible values of s3 and cloudwatch. + description: The log destination type. An enum with possible values of s3, cloudwatch, and s3table. schema: $ref: "#/components/schemas/LogDestinationType" - name: LogExports in: query required: false - description: The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog. + description: The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables. schema: $ref: "#/components/schemas/LogTypeList" + - name: S3TableKmsKeyId + in: query + required: false + description: The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when LogDestinationType is s3table. + schema: + $ref: "#/components/schemas/String" + - name: S3TableGranularity + in: query + required: false + description: The scope of system table publishing. Valid values are cluster and account. A value of cluster scopes publishing to the individual cluster. A value of account scopes publishing to the Amazon Web Services account. This parameter is valid only when LogDestinationType is s3table. + schema: + $ref: "#/components/schemas/String" responses: "200": description: Success @@ -6258,7 +6430,7 @@ paths: - name: NodeType in: query required: false - description: "The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" + description: "The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" schema: $ref: "#/components/schemas/String" - name: NumberOfNodes @@ -7134,6 +7306,54 @@ paths: text/xml: schema: $ref: "#/components/schemas/ModifyLakehouseConfigurationMessage" + /?Action=ModifyQev2IdcApplication&Version=2012-12-01: + parameters: + - $ref: "#/components/parameters/X-Amz-Content-Sha256" + - $ref: "#/components/parameters/X-Amz-Date" + - $ref: "#/components/parameters/X-Amz-Algorithm" + - $ref: "#/components/parameters/X-Amz-Credential" + - $ref: "#/components/parameters/X-Amz-Security-Token" + - $ref: "#/components/parameters/X-Amz-Signature" + - $ref: "#/components/parameters/X-Amz-SignedHeaders" + get: + operationId: GET_ModifyQev2IdcApplication + description: Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + parameters: + - name: Qev2IdcApplicationArn + in: query + required: true + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center. + schema: + $ref: "#/components/schemas/String" + - name: IdcDisplayName + in: query + required: false + description: The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. + schema: + $ref: "#/components/schemas/IdcDisplayNameString" + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyQev2IdcApplicationOutputDisplay" + post: + operationId: POST_ModifyQev2IdcApplication + description: Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + responses: + "200": + description: Success + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyQev2IdcApplicationOutputDisplay" + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: "#/components/schemas/ModifyQev2IdcApplicationMessage" /?Action=ModifyRedshiftIdcApplication&Version=2012-12-01: parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" @@ -7781,7 +8001,7 @@ paths: - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GET_ResizeCluster - description: "Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.xlarge rg.4xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster." + description: "Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.large rg.xlarge rg.4xlarge rg.12xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster." parameters: - name: ClusterIdentifier in: query @@ -7834,7 +8054,7 @@ paths: $ref: "#/components/schemas/ResizeClusterOutputDisplay" post: operationId: POST_ResizeCluster - description: "Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.xlarge rg.4xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster." + description: "Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.large rg.xlarge rg.4xlarge rg.12xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster." responses: "200": description: Success @@ -9443,6 +9663,9 @@ components: ExtraComputeForAutomaticOptimization: type: string description: "A boolean value that, if true, indicates that the cluster allocates additional compute resources to run automatic optimization operations. Default: false" + LoggingPublishStatus: + type: string + description: The status of system table publishing for the cluster. This field is present only when system table publishing is configured. CreateClusterOutputDisplay: type: object properties: @@ -9464,7 +9687,7 @@ components: description: "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node" NodeType: $ref: "#/components/schemas/String" - description: "The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" + description: "The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" MasterUsername: $ref: "#/components/schemas/String" description: "The user name associated with the admin user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. The first character must be a letter. Must not contain a colon (:) or a slash (/). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide." @@ -10093,21 +10316,76 @@ components: - SourceArn - TargetArn - IntegrationName - RedshiftIdcApplicationName: + Qev2IdcApplicationName: type: string minLength: 1 maxLength: 63 pattern: "[a-z][a-z0-9]*(-[a-z0-9]+)*" - IdentityNamespaceString: + IdcDisplayNameString: type: string minLength: 1 maxLength: 127 - pattern: ^[a-zA-Z0-9_+.#@$-]+$ - IdcDisplayNameString: + pattern: "[\\w+=,.@-]+" + Qev2IdcApplicationDisplay: + type: object + properties: + IdcInstanceArn: + type: string + description: The Amazon Resource Name (ARN) for the IAM Identity Center instance that the Amazon Redshift Query Editor (QEV2) application integrates with. + Qev2IdcApplicationName: + type: string + description: The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center. + Qev2IdcApplicationArn: + type: string + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center. + IdcManagedApplicationArn: + type: string + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center managed application. + IdcOnboardStatus: + type: string + description: The onboarding status for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. + IdcDisplayName: + type: string + description: The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. + Tags: + type: string + description: A list of tags associated with the application. Tags are key-value pairs that you can use to organize and identify your resources. + CreateQev2IdcApplicationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/Qev2IdcApplicationDisplay" + CreateQev2IdcApplicationMessage: + type: object + properties: + IdcInstanceArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) of the IAM Identity Center instance used to create the Amazon Redshift Query Editor (QEV2) managed application. + Qev2IdcApplicationName: + $ref: "#/components/schemas/Qev2IdcApplicationName" + description: The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center. + IdcDisplayName: + $ref: "#/components/schemas/IdcDisplayNameString" + description: The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. + Tags: + $ref: "#/components/schemas/TagList" + description: A list of tags to associate with the application. Tags are key-value pairs that you can use to organize and identify your resources. + required: + - IdcInstanceArn + - Qev2IdcApplicationName + - IdcDisplayName + RedshiftIdcApplicationName: + type: string + minLength: 1 + maxLength: 63 + pattern: "[a-z][a-z0-9]*(-[a-z0-9]+)*" + IdentityNamespaceString: type: string minLength: 1 maxLength: 127 - pattern: "[\\w+=,.@-]+" + pattern: ^[a-zA-Z0-9_+.#@$-]+$ AuthorizedTokenIssuerList: type: array items: @@ -10797,6 +11075,14 @@ components: type: array items: $ref: "#/components/schemas/PartnerIntegrationOutputMessageDisplay" + DeleteQev2IdcApplicationMessage: + type: object + properties: + Qev2IdcApplicationArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application to delete. + required: + - Qev2IdcApplicationArn DeleteRedshiftIdcApplicationMessage: type: object properties: @@ -11777,10 +12063,13 @@ components: description: The message indicating that logs failed to be delivered. LogDestinationType: type: string - description: The log destination type. An enum with possible values of s3 and cloudwatch. + description: The log destination type. An enum with possible values of s3, cloudwatch, and s3table. LogExports: type: string - description: The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog. + description: The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables being published. + S3Tables: + type: string + description: The status of system table publishing to S3 Tables. This field is populated only when system table publishing is active. DescribeLoggingStatusOutputDisplay: type: object properties: @@ -11974,6 +12263,25 @@ components: required: - AccountId - ClusterIdentifier + DescribeQev2IdcApplicationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/Qev2IdcApplicationDisplay" + DescribeQev2IdcApplicationsMessage: + type: object + properties: + Qev2IdcApplicationArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center. + MaxRecords: + $ref: "#/components/schemas/IntegerOptional" + description: The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. + Marker: + $ref: "#/components/schemas/String" + description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. DescribeRedshiftIdcApplicationsOutputDisplay: type: object properties: @@ -12451,6 +12759,16 @@ components: TagValues: $ref: "#/components/schemas/TagValueList" description: A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them. + LogDestinationType: + type: string + enum: + - s3 + - cloudwatch + - s3table + LogTypeList: + type: array + items: + $ref: "#/components/schemas/String" DisableLoggingOutputDisplay: type: object properties: @@ -12464,6 +12782,12 @@ components: ClusterIdentifier: $ref: "#/components/schemas/String" description: "The identifier of the cluster on which logging is to be stopped. Example: examplecluster" + LogDestinationType: + $ref: "#/components/schemas/LogDestinationType" + description: The log destination type. An enum with possible values of s3, cloudwatch, and s3table. When set to s3table, stops system table publishing. When omitted, the operation disables audit logging. + LogExports: + $ref: "#/components/schemas/LogTypeList" + description: The collection of log types to stop exporting. When LogDestinationType is s3table, the values are the names of the system tables to stop publishing. Omitting this parameter or passing all stops publishing all system tables. required: - ClusterIdentifier DisableSnapshotCopyOutputDisplay: @@ -12509,15 +12833,6 @@ components: type: string maxLength: 256 pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" - LogDestinationType: - type: string - enum: - - s3 - - cloudwatch - LogTypeList: - type: array - items: - $ref: "#/components/schemas/String" EnableLoggingOutputDisplay: type: object properties: @@ -12539,10 +12854,16 @@ components: description: "The prefix applied to the log file names. Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (\\), hyphen (-), at symbol (@)." LogDestinationType: $ref: "#/components/schemas/LogDestinationType" - description: The log destination type. An enum with possible values of s3 and cloudwatch. + description: The log destination type. An enum with possible values of s3, cloudwatch, and s3table. LogExports: $ref: "#/components/schemas/LogTypeList" - description: The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog. + description: The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables. + S3TableKmsKeyId: + $ref: "#/components/schemas/String" + description: The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when LogDestinationType is s3table. + S3TableGranularity: + $ref: "#/components/schemas/String" + description: The scope of system table publishing. Valid values are cluster and account. A value of cluster scopes publishing to the individual cluster. A value of account scopes publishing to the Amazon Web Services account. This parameter is valid only when LogDestinationType is s3table. required: - ClusterIdentifier EnableSnapshotCopyOutputDisplay: @@ -12927,7 +13248,7 @@ components: description: "The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request. Valid Values: multi-node | single-node" NodeType: $ref: "#/components/schemas/String" - description: "The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" + description: "The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge" NumberOfNodes: $ref: "#/components/schemas/IntegerOptional" description: "The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: Integer greater than 0." @@ -13375,6 +13696,24 @@ components: description: A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes. required: - ClusterIdentifier + ModifyQev2IdcApplicationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/Qev2IdcApplicationDisplay" + ModifyQev2IdcApplicationMessage: + type: object + properties: + Qev2IdcApplicationArn: + $ref: "#/components/schemas/String" + description: The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center. + IdcDisplayName: + $ref: "#/components/schemas/IdcDisplayNameString" + description: The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. + required: + - Qev2IdcApplicationArn ModifyRedshiftIdcApplicationOutputDisplay: type: object properties: @@ -15655,6 +15994,89 @@ components: - $ref: "#/components/x-stackQL-resources/integrations/methods/modify_integration" delete: - $ref: "#/components/x-stackQL-resources/integrations/methods/delete_integration" + qev2_idc_applications: + id: aws.redshift.qev2_idc_applications + name: qev2_idc_applications + title: qev2_idc_applications + methods: + create_qev2_idc_application: + operation: + $ref: "#/paths/~1?Action=CreateQev2IdcApplication&Version=2012-12-01/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/CreateQev2IdcApplicationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + delete_qev2_idc_application: + operation: + $ref: "#/paths/~1?Action=DeleteQev2IdcApplication&Version=2012-12-01/get" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + describe_qev2_idc_applications: + operation: + $ref: "#/paths/~1?Action=DescribeQev2IdcApplications&Version=2012-12-01/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DescribeQev2IdcApplicationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + modify_qev2_idc_application: + operation: + $ref: "#/paths/~1?Action=ModifyQev2IdcApplication&Version=2012-12-01/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ModifyQev2IdcApplicationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + config: + queryParamTranspose: + algorithm: AWSCanonical + requestTranslate: + algorithm: get_query_to_post_form_utf_8 + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/qev2_idc_applications/methods/describe_qev2_idc_applications" + insert: + - $ref: "#/components/x-stackQL-resources/qev2_idc_applications/methods/create_qev2_idc_application" + update: + - $ref: "#/components/x-stackQL-resources/qev2_idc_applications/methods/modify_qev2_idc_application" + delete: + - $ref: "#/components/x-stackQL-resources/qev2_idc_applications/methods/delete_qev2_idc_application" redshift_idc_applications: id: aws.redshift.redshift_idc_applications name: redshift_idc_applications diff --git a/providers/src/aws/v00.00.00000/services/redshift_data.yaml b/providers/src/aws/v00.00.00000/services/redshift_data.yaml index fc2e43d9..47fb3dde 100644 --- a/providers/src/aws/v00.00.00000/services/redshift_data.yaml +++ b/providers/src/aws/v00.00.00000/services/redshift_data.yaml @@ -41,7 +41,7 @@ paths: properties: Sqls: $ref: "#/components/schemas/SqlList" - description: One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back. + description: One or more SQL statements to run. The SQL statements run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. By default, the SQL statements are run as a single transaction. If any SQL statement fails, all work is rolled back. To change this behavior, see the ExecutionMode parameter. ClusterIdentifier: $ref: "#/components/schemas/ClusterIdentifierString" description: The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. @@ -62,7 +62,7 @@ paths: description: The name of the SQL statements. You can name the SQL statements when you create them to identify the query. Parameters: $ref: "#/components/schemas/SqlParametersList" - description: The parameters for the SQL statements. The parameters are shared across all SQL statements in the batch. + description: The parameters for the SQL statements. The parameters are available to all SQL statements in the batch. Each statement can reference any subset of the provided parameters. Each provided parameter must be referenced by at least one SQL statement in the batch. WorkgroupName: $ref: "#/components/schemas/WorkgroupNameString" description: The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials. @@ -78,6 +78,12 @@ paths: SessionId: $ref: "#/components/schemas/UUID" description: The session identifier of the query. + ExecutionMode: + $ref: "#/components/schemas/ExecutionMode" + description: Determines how the SQL statements in the batch are run. If set to TRANSACTION (the default), all SQL statements are run as a single transaction and they are committed or rolled back together. If set to AUTO_COMMIT, each SQL statement is committed individually, and a failure of one statement does not affect the others. + WaitTimeSeconds: + $ref: "#/components/schemas/WaitTimeSeconds" + description: The number of seconds to wait for all SQL statements in the batch to complete execution before returning the response. If the SQL statements do not complete within the specified time, the response returns the current status. The maximum value is 30 seconds. required: - Sqls responses: @@ -144,6 +150,9 @@ paths: Id: $ref: "#/components/schemas/UUID" description: The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements. + WaitTimeSeconds: + $ref: "#/components/schemas/WaitTimeSeconds" + description: The number of seconds to wait for the SQL statement to complete execution before returning the description. The maximum value is 30 seconds. responses: "200": description: Success @@ -272,6 +281,9 @@ paths: SessionId: $ref: "#/components/schemas/UUID" description: The session identifier of the query. + WaitTimeSeconds: + $ref: "#/components/schemas/WaitTimeSeconds" + description: The number of seconds to wait for the SQL statement to complete execution before returning the response. If the SQL statement does not complete within the specified time, the response returns the current status. The maximum value is 30 seconds. required: - Sql responses: @@ -308,6 +320,9 @@ paths: NextToken: $ref: "#/components/schemas/String" description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. + WaitTimeSeconds: + $ref: "#/components/schemas/WaitTimeSeconds" + description: The number of seconds to wait for the SQL statement to complete execution before returning the result. The maximum value is 30 seconds. required: - Id responses: @@ -344,6 +359,9 @@ paths: NextToken: $ref: "#/components/schemas/String" description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. + WaitTimeSeconds: + $ref: "#/components/schemas/WaitTimeSeconds" + description: The number of seconds to wait for the SQL statement to complete execution before returning the result. The maximum value is 30 seconds. required: - Id responses: @@ -461,6 +479,58 @@ paths: application/json: schema: $ref: "#/components/schemas/ListSchemasOutputDisplay" + /ListSessions: + post: + operationId: ListSessions + description: Lists the sessions that the caller created in the last 24 hours. By default, only sessions with a status of AVAILABLE or BUSY are returned. You can filter the results by session status, compute target (cluster or serverless workgroup), or database. To retrieve the metadata for a single session, provide the SessionId parameter. Use NextToken to page through the session list. Returns only the sessions that the caller created. When identity-enhanced role sessions are used, you must provide either the ClusterIdentifier or WorkgroupName parameter to ensure that the AWS IAM Identity Center user can only access the Amazon Redshift IAM Identity Center applications they are assigned. For more information, see Trusted identity propagation overview. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - RedshiftData.ListSessions + default: RedshiftData.ListSessions + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + NextToken: + $ref: "#/components/schemas/String" + description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. + MaxResults: + $ref: "#/components/schemas/ListStatementsLimit" + description: The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results. + SessionId: + $ref: "#/components/schemas/UUID" + description: The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database. + Status: + $ref: "#/components/schemas/SessionStatusString" + description: "The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. Status values are defined as follows: AVAILABLE – The session is open and ready to run a SQL statement. BUSY – The session is currently running a SQL statement. CLOSED – The session is closed and can no longer run SQL statements." + RoleLevel: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true. + ClusterIdentifier: + $ref: "#/components/schemas/ClusterIdentifierString" + description: The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified. + WorkgroupName: + $ref: "#/components/schemas/WorkgroupNameString" + description: The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified. + Database: + $ref: "#/components/schemas/String" + description: The name of the database. Only sessions connected to this database are returned. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSessionsResponse" /ListStatements: post: operationId: ListStatements @@ -666,7 +736,7 @@ components: type: string minLength: 3 maxLength: 128 - pattern: .*((^[a-z0-9-]{3,63}$)|^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov|(-iso[a-z]?))?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})) + pattern: ([a-z0-9-]{3,63}|arn:(aws(-[a-z]+)*):redshift-serverless:([a-z]{2}(-gov|(-iso[a-z]?))?|eusc-[a-z]+)-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) ClientToken: type: string minLength: 1 @@ -683,6 +753,15 @@ components: UUID: type: string pattern: "[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d{0,2})?" + ExecutionMode: + type: string + enum: + - TRANSACTION + - AUTO_COMMIT + WaitTimeSeconds: + type: integer + minimum: 1 + maximum: 30 BatchExecuteStatementOutput: type: object properties: @@ -713,6 +792,15 @@ components: SessionId: $ref: "#/components/schemas/UUID" description: The session identifier of the query. + Status: + $ref: "#/components/schemas/StatementStatusString" + description: "The status of the SQL statement. Status values are defined as follows: ABORTED - The query run was stopped by the user. FAILED - The query run failed. FINISHED - The query has finished running. PICKED - The query has been chosen to be run. STARTED - The query run has started. SUBMITTED - The query was submitted, but not yet processed." + RedshiftPid: + $ref: "#/components/schemas/BoxedLong" + description: The process identifier from Amazon Redshift. + HasResultSet: + $ref: "#/components/schemas/BoxedBoolean" + description: A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set. Timestamp: type: string format: date-time @@ -720,6 +808,20 @@ components: type: array items: $ref: "#/components/schemas/String" + StatementStatusString: + type: string + enum: + - SUBMITTED + - PICKED + - STARTED + - FINISHED + - ABORTED + - FAILED + BoxedLong: + type: integer + format: int64 + BoxedBoolean: + type: boolean CancelStatementResponse: type: object properties: @@ -792,6 +894,9 @@ components: SessionId: $ref: "#/components/schemas/String" description: The session identifier of the query. + ExecutionMode: + $ref: "#/components/schemas/ExecutionMode" + description: The execution mode of the batch request. TRANSACTION indicates all SQL statements are run as a single transaction. AUTO_COMMIT indicates each SQL statement is committed individually. required: - Id Long: @@ -850,15 +955,6 @@ components: description: A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. required: - Id - StatementStatusString: - type: string - enum: - - SUBMITTED - - PICKED - - STARTED - - FINISHED - - ABORTED - - FAILED PageSize: type: integer minimum: 0 @@ -956,6 +1052,15 @@ components: SessionId: $ref: "#/components/schemas/UUID" description: The session identifier of the query. + Status: + $ref: "#/components/schemas/StatementStatusString" + description: "The status of the SQL statement. Status values are defined as follows: ABORTED - The query run was stopped by the user. FAILED - The query run failed. FINISHED - The query has finished running. PICKED - The query has been chosen to be run. STARTED - The query run has started. SUBMITTED - The query was submitted, but not yet processed." + RedshiftPid: + $ref: "#/components/schemas/BoxedLong" + description: The process identifier from Amazon Redshift. + HasResultSet: + $ref: "#/components/schemas/BoxedBoolean" + description: A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. GetStatementResultRowDisplay: type: object properties: @@ -1034,6 +1139,68 @@ components: type: integer minimum: 0 maximum: 100 + SessionStatusString: + type: string + enum: + - AVAILABLE + - BUSY + - CLOSED + ListSessionsResponse: + type: object + properties: + Sessions: + $ref: "#/components/schemas/SessionList" + description: The sessions that match the request. + NextToken: + $ref: "#/components/schemas/String" + description: A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. + required: + - Sessions + SessionList: + type: array + items: + $ref: "#/components/schemas/SessionData" + SessionData: + description: Contains the metadata for a session returned by ListSessions, including its status, compute target, database connection, and lifecycle timestamps. + type: object + properties: + SessionId: + $ref: "#/components/schemas/UUID" + description: The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. + Status: + $ref: "#/components/schemas/SessionStatusString" + description: "The status of the session. Status values are defined as follows: AVAILABLE – The session is open and ready to run a SQL statement. BUSY – The session is currently running a SQL statement. CLOSED – The session is closed and can no longer run SQL statements." + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time (UTC) when the session was created. + UpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed. + Database: + $ref: "#/components/schemas/String" + description: The name of the database that the session is connected to. + DbUser: + $ref: "#/components/schemas/String" + description: The database user name. + ClusterIdentifier: + $ref: "#/components/schemas/String" + description: The cluster identifier. This element is not returned when connecting to a serverless workgroup. + WorkgroupName: + $ref: "#/components/schemas/WorkgroupNameString" + description: The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster. + SessionAliveSeconds: + $ref: "#/components/schemas/SessionAliveSeconds" + description: The number of seconds that the session is kept alive after a query finishes. + SessionTtl: + $ref: "#/components/schemas/Timestamp" + description: The date and time (UTC) when the session is set to expire and be closed. + CurrentStatementId: + $ref: "#/components/schemas/UUID" + description: The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY. + required: + - SessionId + - Status + - CreatedAt ListStatementsResponse: type: object properties: @@ -1367,3 +1534,35 @@ components: insert: [] update: [] delete: [] + sessions: + id: aws.redshift_data.sessions + name: sessions + title: sessions + methods: + list_sessions: + operation: + $ref: "#/paths/~1ListSessions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Sessions + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/sessions/methods/list_sessions" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/redshift_serverless.yaml b/providers/src/aws/v00.00.00000/services/redshift_serverless.yaml index 712a0068..6bcfc6d6 100644 --- a/providers/src/aws/v00.00.00000/services/redshift_serverless.yaml +++ b/providers/src/aws/v00.00.00000/services/redshift_serverless.yaml @@ -1976,6 +1976,9 @@ paths: schema: type: object properties: + maintainIntegration: + $ref: "#/components/schemas/Boolean" + description: "If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace. Default: true" namespaceName: $ref: "#/components/schemas/NamespaceName" description: The name of the namespace to restore data into. @@ -2020,6 +2023,9 @@ paths: adminPasswordSecretKmsKeyId: $ref: "#/components/schemas/KmsKeyId" description: The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. + maintainIntegration: + $ref: "#/components/schemas/Boolean" + description: "If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace. Default: true" manageAdminPassword: $ref: "#/components/schemas/Boolean" description: If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken. @@ -2380,7 +2386,7 @@ paths: /UpdateNamespace: post: operationId: UpdateNamespace - description: Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request. + description: Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request. Similarly, an S3 Tables log-publishing update (a request where logDestinationType is s3table) cannot be combined with any other namespace configuration change and must be submitted as its own request. parameters: - name: X-Amz-Target in: header @@ -2403,7 +2409,7 @@ paths: description: The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true. adminUserPassword: $ref: "#/components/schemas/DbPassword" - description: The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername. You can't use adminUserPassword if manageAdminPassword is true. + description: The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername. You can't use adminUserPassword if manageAdminPassword is true. If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for the namespace. adminUsername: $ref: "#/components/schemas/DbUser" description: The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword. @@ -2416,6 +2422,9 @@ paths: kmsKeyId: $ref: "#/components/schemas/String" description: The ID of the Amazon Web Services Key Management Service key used to encrypt your data. + logDestinationType: + $ref: "#/components/schemas/LogDestinationType" + description: The destination for the log data. Valid values are s3table and cloudwatch. Set this to s3table to manage Amazon S3 Tables system-table publishing for the namespace. logExports: $ref: "#/components/schemas/LogExportList" description: The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog. @@ -2425,6 +2434,18 @@ paths: namespaceName: $ref: "#/components/schemas/NamespaceName" description: The name of the namespace to update. You can't update the name of a namespace once it is created. + s3TableAction: + $ref: "#/components/schemas/S3TableAction" + description: Whether to enable or disable Amazon S3 Tables publishing. Valid values are Enable and Disable, matched case-insensitively. When omitted, defaults to Enable. Valid only when logDestinationType is s3table. + s3TableGranularity: + $ref: "#/components/schemas/S3TableGranularity" + description: The scope of the Amazon S3 Tables destination. Valid values are namespace and account, matched case-insensitively. namespace scopes the published tables to this namespace; account scopes them to the Amazon Web Services account. Required when enabling. Omitting this parameter or passing a blank value fails with ValidationException. Valid only when logDestinationType is s3table. + s3TableKmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys). Valid only when logDestinationType is s3table. + s3TableNames: + $ref: "#/components/schemas/S3TableNameList" + description: The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with sys_ or the keyword all. Omitting this parameter, passing an empty list, or including all each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names. Valid only when logDestinationType is s3table. required: - namespaceName responses: @@ -3061,9 +3082,49 @@ components: namespaceName: $ref: "#/components/schemas/NamespaceName" description: The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + s3TablePublishStatus: + $ref: "#/components/schemas/S3TablePublishStatus" + description: The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace. status: $ref: "#/components/schemas/NamespaceStatus" description: The status of the namespace. + S3TablePublishStatus: + description: Describes the state of Amazon S3 Tables system-table log publishing for a namespace. + type: object + properties: + enabledAll: + $ref: "#/components/schemas/Boolean" + description: true when the namespace is enrolled in every current and future system table rather than an explicit list of tables. + lastIngestionTimes: + type: object + properties: {} + description: A map of system table name to the time that table last received data, as an ISO-8601 timestamp. A table that has not yet been ingested is absent from the map. Use it to judge data freshness. + s3TableGranularity: + $ref: "#/components/schemas/S3TableGranularity" + description: The scope currently in effect. Values are namespace or account. + s3TableNamespace: + $ref: "#/components/schemas/String" + description: The identifier of the namespace in the S3 table bucket that holds the published tables. + s3Tables: + $ref: "#/components/schemas/S3TableNameList" + description: The system tables currently being published. + S3TableGranularity: + description: Granularity for S3 Table scoping in serverless. + type: string + enum: + - namespace + - account + S3TableNameList: + description: List of system table names (or "all") to publish to S3 Tables. Sized to hold the full SYS_* universe (28+ today, grows as new views are onboarded) plus headroom. + type: array + items: + $ref: "#/components/schemas/S3TableName" + S3TableName: + description: A system-table view name to publish to S3 Tables (e.g. "sys_query_history"), or the keyword "all" to publish every current and future system table. + type: string + minLength: 1 + maxLength: 128 + pattern: ^(all|sys_[a-z0-9_]+)$ NamespaceStatus: type: string enum: @@ -3349,7 +3410,7 @@ components: properties: parameterKey: $ref: "#/components/schemas/ParameterKey" - description: The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. + description: The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. parameterValue: $ref: "#/components/schemas/ParameterValue" description: The value of the parameter to set. @@ -4223,6 +4284,18 @@ components: namespaceName: $ref: "#/components/schemas/NamespaceName" description: The name of the namespace. + LogDestinationType: + description: Destination type for log publishing. + type: string + enum: + - s3table + - cloudwatch + S3TableAction: + description: Action to perform for S3 Table log publishing. + type: string + enum: + - Enable + - Disable UpdateNamespaceResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/resiliencehubv2.yaml b/providers/src/aws/v00.00.00000/services/resiliencehubv2.yaml new file mode 100644 index 00000000..1b8c18c7 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/resiliencehubv2.yaml @@ -0,0 +1,6654 @@ +openapi: 3.0.0 +info: + version: "2026-02-17" + title: AWS Resilience Hub V2 + description: AWS Resilience Hub V2 + x-serviceName: resiliencehub + x-serviceAlias: resiliencehubv2 + x-protocol: rest-json + x-apiVersion: "2026-02-17" + x-endpointPrefix: resiliencehub +servers: + - url: https://resiliencehub.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for resiliencehubv2 +paths: + /v2/create-assertion: + post: + operationId: CreateAssertion + description: Creates a resilience assertion for a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + text: + $ref: "#/components/schemas/AssertionText" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - serviceArn + - text + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAssertionResponse" + /v2/create-input-source: + post: + operationId: CreateInputSource + description: Creates an input source for a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + resourceConfiguration: + $ref: "#/components/schemas/ResourceConfiguration" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - serviceArn + - resourceConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateInputSourceResponse" + /v2/create-policy: + post: + operationId: CreatePolicy + description: Creates a resilience policy that defines availability and disaster recovery requirements. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/LongDescription" + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + multiAz: + $ref: "#/components/schemas/MultiAzTargets" + multiRegion: + $ref: "#/components/schemas/MultiRegionTargets" + dataRecovery: + $ref: "#/components/schemas/DataRecoveryTargets" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreatePolicyResponse" + /v2/create-report: + post: + operationId: CreateReport + description: On-demand report creation. Idempotent — duplicate requests with same clientToken return existing result. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + reportType: + $ref: "#/components/schemas/ReportType" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - serviceArn + - reportType + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateReportResponse" + /v2/create-service: + post: + operationId: CreateService + description: Creates a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/LongDescription" + associatedSystems: + $ref: "#/components/schemas/AssociatedSystemList" + policyArn: + $ref: "#/components/schemas/Arn" + regions: + $ref: "#/components/schemas/RegionList" + permissionModel: + $ref: "#/components/schemas/PermissionModel" + dependencyDiscovery: + $ref: "#/components/schemas/DependencyDiscoveryInput" + reportConfiguration: + $ref: "#/components/schemas/ServiceReportConfiguration" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - name + - regions + - permissionModel + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateServiceResponse" + /v2/create-service-function: + post: + operationId: CreateServiceFunction + description: Creates a service function within a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/EntityLabel" + serviceArn: + $ref: "#/components/schemas/Arn" + description: + $ref: "#/components/schemas/EntityDescription" + criticality: + $ref: "#/components/schemas/ServiceFunctionCriticality" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - name + - serviceArn + - criticality + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateServiceFunctionResponse" + /v2/create-service-function-resources: + post: + operationId: CreateServiceFunctionResources + description: Associates resources with a service function. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + resources: + $ref: "#/components/schemas/ResourceList" + required: + - serviceArn + - serviceFunctionId + - resources + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateServiceFunctionResourcesResponse" + /v2/create-system: + post: + operationId: CreateSystem + description: Creates a system that represents a logical grouping of services. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/EntityDescription" + sharingEnabled: + $ref: "#/components/schemas/Boolean" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateSystemResponse" + /v2/create-test: + post: + operationId: CreateTest + description: Creates a test for a service by configuring a test template. Each service has one test per template. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + loggingConfiguration: + $ref: "#/components/schemas/LoggingConfiguration" + stopConditions: + $ref: "#/components/schemas/StopConditionList" + roleName: + $ref: "#/components/schemas/EntityName" + parameters: + $ref: "#/components/schemas/TestParameters" + required: + - serviceArn + - testTemplateArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTestResponse" + /v2/create-user-journey: + post: + operationId: CreateUserJourney + description: Creates a user journey within a system. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + name: + $ref: "#/components/schemas/EntityLabel" + description: + $ref: "#/components/schemas/EntityDescription" + policyArn: + $ref: "#/components/schemas/Arn" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - systemArn + - name + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateUserJourneyResponse" + /v2/delete-assertion: + post: + operationId: DeleteAssertion + description: Deletes a resilience assertion from a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + assertionId: + $ref: "#/components/schemas/Uuid" + required: + - serviceArn + - assertionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssertionResponse" + /v2/delete-input-source: + post: + operationId: DeleteInputSource + description: Deletes an input source. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + inputSourceId: + $ref: "#/components/schemas/InputSourceId" + required: + - serviceArn + - inputSourceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteInputSourceResponse" + /v2/delete-policy: + post: + operationId: DeletePolicy + description: Deletes a resilience policy. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + required: + - policyArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeletePolicyResponse" + /v2/delete-service: + post: + operationId: DeleteService + description: Deletes a service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + required: + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteServiceResponse" + /v2/delete-function: + post: + operationId: DeleteServiceFunction + description: Deletes a service function. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + required: + - serviceArn + - serviceFunctionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteServiceFunctionResponse" + /v2/delete-service-function-resources: + post: + operationId: DeleteServiceFunctionResources + description: Removes resources from a service function. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + resources: + $ref: "#/components/schemas/ResourceList" + required: + - serviceArn + - serviceFunctionId + - resources + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteServiceFunctionResourcesResponse" + /v2/delete-system: + post: + operationId: DeleteSystem + description: Deletes a system. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + required: + - systemArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSystemResponse" + /v2/delete-test: + post: + operationId: DeleteTest + description: Deletes a test. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + serviceArn: + $ref: "#/components/schemas/Arn" + required: + - testId + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteTestResponse" + /v2/delete-test-sources: + post: + operationId: DeleteTestSources + description: Removes monitoring sources from a test. The operation is transactional and idempotent — removing a source that is not attached is a no-op. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + serviceArn: + $ref: "#/components/schemas/Arn" + testSources: + $ref: "#/components/schemas/TestSourceInputList" + required: + - testId + - serviceArn + - testSources + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteTestSourcesResponse" + /v2/delete-user-journey: + post: + operationId: DeleteUserJourney + description: Deletes a user journey. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + userJourneyId: + $ref: "#/components/schemas/UserJourneyId" + required: + - systemArn + - userJourneyId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteUserJourneyResponse" + /v2/get-failure-mode-finding: + get: + operationId: GetFailureModeFinding + description: Retrieves a finding by findingId. + parameters: + - name: findingId + in: query + required: true + schema: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the finding to retrieve. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetFailureModeFindingResponse" + /v2/get-policy: + get: + operationId: GetPolicy + description: Retrieves a resilience policy by ARN. + parameters: + - name: policyArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetPolicyResponse" + /v2/get-service: + get: + operationId: GetService + description: Retrieves a service by ARN. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetServiceResponse" + /v2/get-system: + get: + operationId: GetSystem + description: Retrieves a system by ARN. + parameters: + - name: systemArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSystemResponse" + /v2/get-test: + get: + operationId: GetTest + description: Retrieves a test by ID. + parameters: + - name: testId + in: query + required: true + schema: + $ref: "#/components/schemas/TestId" + description: The identifier of the test to retrieve. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test belongs to. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetTestResponse" + /v2/get-test-run: + get: + operationId: GetTestRun + description: Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started. + parameters: + - name: testRunId + in: query + required: true + schema: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the test run to retrieve. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetTestRunResponse" + /v2/get-test-template: + get: + operationId: GetTestTemplate + description: Retrieves a resilience test template by ARN, including the parameters it accepts and the fault actions it runs. + parameters: + - name: testTemplateArn + in: query + required: true + schema: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetTestTemplateResponse" + /v2/get-user-journey: + get: + operationId: GetUserJourney + description: Retrieves a user journey. + parameters: + - name: systemArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: userJourneyId + in: query + required: true + schema: + $ref: "#/components/schemas/UserJourneyId" + description: The identifier of the user journey to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetUserJourneyResponse" + /v2/import-app: + post: + operationId: ImportApp + description: Imports a V1 app into the V2 resource model, creating a service with the same name. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + v1AppArn: + $ref: "#/components/schemas/Arn" + policyArn: + $ref: "#/components/schemas/Arn" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + skipManuallyAddedResources: + $ref: "#/components/schemas/Boolean" + associatedSystems: + $ref: "#/components/schemas/AssociatedSystemList" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - v1AppArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ImportAppResponse" + /v2/import-policy: + post: + operationId: ImportPolicy + description: Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + v1PolicyArn: + $ref: "#/components/schemas/Arn" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + multiAzDisasterRecoveryApproach: + $ref: "#/components/schemas/MultiAzDisasterRecoveryApproach" + multiRegionDisasterRecoveryApproach: + $ref: "#/components/schemas/MultiRegionDisasterRecoveryApproach" + tags: + $ref: "#/components/schemas/TagMap" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - v1PolicyArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ImportPolicyResponse" + /v2/list-assertions: + get: + operationId: ListAssertions + description: Lists resilience assertions for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: source + in: query + required: false + schema: + $ref: "#/components/schemas/AssertionSource" + description: Filter assertions by source type. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAssertionsResponse" + /v2/list-dependencies: + get: + operationId: ListDependencies + description: Lists dependencies discovered for services. + parameters: + - name: serviceArn + in: query + required: false + schema: + $ref: "#/components/schemas/Arn" + - name: queryRangeStartTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The start time for the dependency query range. + - name: queryRangeEndTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The end time for the dependency query range. + - name: queryRangeGranularity + in: query + required: false + schema: + $ref: "#/components/schemas/QueryGranularity" + description: The granularity for the dependency query range. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDependenciesResponse" + /v2/list-failure-mode-assessments: + get: + operationId: ListFailureModeAssessments + description: Lists failure mode assessments. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: assessmentStatuses + in: query + required: false + schema: + $ref: "#/components/schemas/AssessmentStatusList" + description: Specifies the assessment statuses to include in the results. + - name: startedAfter + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Specifies that only assessments that started at or after this timestamp appear in the results. + - name: endedBefore + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Specifies that only assessments that ended at or before this timestamp appear in the results. + - name: sortBy + in: query + required: false + schema: + $ref: "#/components/schemas/AssessmentSortField" + description: The field to use for sorting failure mode assessments. + - name: sortOrder + in: query + required: false + schema: + $ref: "#/components/schemas/SortOrder" + description: The sort order for results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListFailureModeAssessmentsResponse" + /v2/list-failure-mode-findings: + get: + operationId: ListFailureModeFindings + description: List findings. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: severity + in: query + required: false + schema: + $ref: "#/components/schemas/FindingSeverity" + description: Filter findings by severity. + - name: failureCategory + in: query + required: false + schema: + $ref: "#/components/schemas/FailureCategory" + description: Filter findings by failure category. + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/FindingStatus" + description: Filter findings by status. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListFailureModeFindingsResponse" + /v2/list-input-sources: + get: + operationId: ListInputSources + description: Lists input sources for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: type + in: query + required: false + schema: + $ref: "#/components/schemas/InputSourceType" + description: Filter input sources by type. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListInputSourcesResponse" + /v2/list-policies: + get: + operationId: ListPolicies + description: Lists resilience policies. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListPoliciesResponse" + /v2/list-reports: + get: + operationId: ListReports + description: List reports for a service, or all reports owned by the account if serviceArn is not provided. + parameters: + - name: serviceArn + in: query + required: false + schema: + $ref: "#/components/schemas/Arn" + description: Optional. If not provided, lists all reports owned by the account. + - name: reportType + in: query + required: false + schema: + $ref: "#/components/schemas/ReportType" + description: Filter reports by type. + - name: testRunId + in: query + required: false + schema: + $ref: "#/components/schemas/TestRunId" + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListReportsResponse" + /v2/test-runs/{test_run_id}/resolved-target-resources: + get: + operationId: ListResolvedTestRunTargetResources + description: Lists the AWS resources that AWS Fault Injection Service (AWS FIS) resolved as targets for a test run. + parameters: + - name: test_run_id + in: path + required: true + schema: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the test run to list resolved target resources for. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListResolvedTestRunTargetResourcesResponse" + /v2/list-resources: + get: + operationId: ListResources + description: List resources. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: serviceFunctionId + in: query + required: false + schema: + $ref: "#/components/schemas/EntityId" + description: Filter resources by service function identifier. + - name: awsRegion + in: query + required: false + schema: + $ref: "#/components/schemas/AwsRegion" + description: Filter resources by AWS Region. + - name: resourceTypes + in: query + required: false + schema: + $ref: "#/components/schemas/ResourceTypeFilterList" + description: The CloudFormation resource types to include in the response. + - name: billable + in: query + required: false + schema: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to filter non-billable resources. When true (the default), the operation returns only billable resources. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListResourcesResponse" + /v2/list-service-events: + get: + operationId: ListServiceEvents + description: Lists events for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: eventTypes + in: query + required: false + schema: + $ref: "#/components/schemas/ServiceEventTypeList" + description: Filter events by type. + - name: startTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The start time for filtering events. + - name: endTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The end time for filtering events. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListServiceEventsResponse" + /v2/list-functions: + get: + operationId: ListServiceFunctions + description: Lists service functions for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListServiceFunctionsResponse" + /v2/list-service-topology-edges: + get: + operationId: ListServiceTopologyEdges + description: Lists topology edges for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListServiceTopologyEdgesResponse" + /v2/list-services: + get: + operationId: ListServices + description: Lists services. + parameters: + - name: systemArn + in: query + required: false + schema: + $ref: "#/components/schemas/Arn" + - name: userJourneyId + in: query + required: false + schema: + $ref: "#/components/schemas/UserJourneyId" + description: Filter services by user journey identifier. + - name: ouId + in: query + required: false + schema: + $ref: "#/components/schemas/OuId" + description: Filter services by organizational unit (OU) identifier. + - name: accountId + in: query + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: Filter services by AWS account ID. + - name: assessmentStatus + in: query + required: false + schema: + $ref: "#/components/schemas/AssessmentStatus" + description: Filter services by assessment status. + - name: policyArn + in: query + required: false + schema: + $ref: "#/components/schemas/Arn" + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListServicesResponse" + /v2/list-system-events: + get: + operationId: ListSystemEvents + description: Lists events for a system. + parameters: + - name: systemArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: eventTypes + in: query + required: false + schema: + $ref: "#/components/schemas/SystemEventTypeList" + description: Filter events by type. + - name: startTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The start time for filtering events. + - name: endTime + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: The end time for filtering events. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSystemEventsResponse" + /v2/list-systems: + get: + operationId: ListSystems + description: Lists systems. + parameters: + - name: ouId + in: query + required: false + schema: + $ref: "#/components/schemas/OuId" + description: Filter systems by organizational unit (OU) identifier. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSystemsResponse" + /v2/tags/{resource_arn}: + get: + operationId: ListTagsForResource + description: Lists the tags for a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceResponse" + post: + operationId: TagResource + description: Adds tags to a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tags: + $ref: "#/components/schemas/TagMap" + required: + - tags + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceResponse" + delete: + operationId: UntagResource + description: Removes tags from a resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeyList" + description: The tag keys to remove from the resource. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceResponse" + /v2/test-runs/{test_run_id}/events: + get: + operationId: ListTestRunEvents + description: Lists the events in a test run's timeline. + parameters: + - name: test_run_id + in: path + required: true + schema: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the test run to list events for. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + - name: startedAt + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Return events at or after this timestamp. + - name: endedAt + in: query + required: false + schema: + $ref: "#/components/schemas/Timestamp" + description: Return events at or before this timestamp. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestRunEventsResponse" + /v2/test-runs/{test_run_id}/sources: + get: + operationId: ListTestRunSources + description: Lists the monitoring source snapshots captured for a test run, optionally filtered by type. + parameters: + - name: test_run_id + in: path + required: true + schema: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the test run to list sources for. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + - name: type + in: query + required: false + schema: + $ref: "#/components/schemas/TestRunSourceType" + description: Filter sources by type. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestRunSourcesResponse" + /v2/list-test-runs: + get: + operationId: ListTestRuns + description: Lists the runs of a test, or all test runs for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service to list test runs for. + - name: testId + in: query + required: false + schema: + $ref: "#/components/schemas/TestId" + description: Filter test runs by test identifier. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestRunsResponse" + /v2/tests/{test_id}/sources: + get: + operationId: ListTestSources + description: Lists the monitoring sources attached to a test, optionally filtered by type. + parameters: + - name: test_id + in: path + required: true + schema: + $ref: "#/components/schemas/TestId" + description: The identifier of the test to list sources for. + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test belongs to. + - name: type + in: query + required: false + schema: + $ref: "#/components/schemas/TestSourceType" + description: Filter sources by type. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestSourcesResponse" + /v2/list-test-templates: + get: + operationId: ListTestTemplates + description: Lists the available resilience test templates. A test template is a pre-configured, AWS recommended test that defines which resilience capability to validate. + parameters: [] + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestTemplatesResponse" + /v2/list-tests: + get: + operationId: ListTests + description: Lists the tests configured for a service. + parameters: + - name: serviceArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the service to list tests for. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTestsResponse" + /v2/list-user-journeys: + get: + operationId: ListUserJourneys + description: Lists user journeys for a system. + parameters: + - name: systemArn + in: query + required: true + schema: + $ref: "#/components/schemas/Arn" + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListUserJourneysResponse" + /v2/put-test-sources: + post: + operationId: PutTestSources + description: Adds or updates the monitoring sources on a test. The operation is transactional — either every source is written or the call fails and nothing is written. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + serviceArn: + $ref: "#/components/schemas/Arn" + testSources: + $ref: "#/components/schemas/TestSourceInputList" + required: + - testId + - serviceArn + - testSources + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutTestSourcesResponse" + /v2/start-failure-mode-assessment: + post: + operationId: StartFailureModeAssessment + description: Starts a failure mode assessment. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartFailureModeAssessmentResponse" + /v2/start-test-run: + post: + operationId: StartTestRun + description: Starts a run of a test. Each run scopes to the current resources in the service and produces a pass or fail outcome. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + serviceArn: + $ref: "#/components/schemas/Arn" + required: + - testId + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartTestRunResponse" + /v2/stop-test-run: + post: + operationId: StopTestRun + description: Stops an in-progress test run. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testRunId: + $ref: "#/components/schemas/TestRunId" + serviceArn: + $ref: "#/components/schemas/Arn" + required: + - testRunId + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StopTestRunResponse" + /v2/update-assertion: + post: + operationId: UpdateAssertion + description: Updates a resilience assertion. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + assertionId: + $ref: "#/components/schemas/Uuid" + text: + $ref: "#/components/schemas/AssertionText" + required: + - serviceArn + - assertionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAssertionResponse" + /v2/update-dependency: + post: + operationId: UpdateDependency + description: Updates a dependency classification. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + dependencyId: + $ref: "#/components/schemas/Uuid" + criticality: + $ref: "#/components/schemas/DependencyCriticality" + comment: + $ref: "#/components/schemas/String" + required: + - serviceArn + - dependencyId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDependencyResponse" + /v2/update-failure-mode-finding: + post: + operationId: UpdateFailureModeFinding + description: Updates an existing finding. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + findingId: + $ref: "#/components/schemas/Uuid" + status: + $ref: "#/components/schemas/FindingStatus" + serviceArn: + $ref: "#/components/schemas/Arn" + comment: + $ref: "#/components/schemas/UpdateFailureModeFindingRequestCommentString" + required: + - findingId + - status + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateFailureModeFindingResponse" + /v2/update-policy: + post: + operationId: UpdatePolicy + description: Updates an existing resilience policy. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + description: + $ref: "#/components/schemas/LongDescription" + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + multiAz: + $ref: "#/components/schemas/MultiAzTargets" + multiRegion: + $ref: "#/components/schemas/MultiRegionTargets" + dataRecovery: + $ref: "#/components/schemas/DataRecoveryTargets" + required: + - policyArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdatePolicyResponse" + /v2/update-service: + post: + operationId: UpdateService + description: Updates an existing service. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + description: + $ref: "#/components/schemas/LongDescription" + associatedSystems: + $ref: "#/components/schemas/AssociatedSystemList" + policyArn: + $ref: "#/components/schemas/Arn" + regions: + $ref: "#/components/schemas/RegionList" + permissionModel: + $ref: "#/components/schemas/PermissionModel" + dependencyDiscovery: + $ref: "#/components/schemas/DependencyDiscoveryInput" + reportConfiguration: + $ref: "#/components/schemas/ServiceReportConfiguration" + required: + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateServiceResponse" + /v2/update-function: + post: + operationId: UpdateServiceFunction + description: Updates a service function. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + name: + $ref: "#/components/schemas/EntityLabel" + description: + $ref: "#/components/schemas/EntityDescription" + criticality: + $ref: "#/components/schemas/ServiceFunctionCriticality" + required: + - serviceArn + - serviceFunctionId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateServiceFunctionResponse" + /v2/update-system: + post: + operationId: UpdateSystem + description: Updates an existing system. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + description: + $ref: "#/components/schemas/EntityDescription" + sharingEnabled: + $ref: "#/components/schemas/Boolean" + required: + - systemArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSystemResponse" + /v2/update-test: + post: + operationId: UpdateTest + description: Updates the configuration of an existing test. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + serviceArn: + $ref: "#/components/schemas/Arn" + loggingConfiguration: + $ref: "#/components/schemas/LoggingConfiguration" + stopConditions: + $ref: "#/components/schemas/StopConditionList" + roleName: + $ref: "#/components/schemas/EntityName" + parameters: + $ref: "#/components/schemas/TestParameters" + required: + - testId + - serviceArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTestResponse" + /v2/update-user-journey: + post: + operationId: UpdateUserJourney + description: Updates an existing user journey. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + userJourneyId: + $ref: "#/components/schemas/UserJourneyId" + name: + $ref: "#/components/schemas/EntityLabel" + description: + $ref: "#/components/schemas/EntityDescription" + policyArn: + $ref: "#/components/schemas/Arn" + required: + - systemArn + - userJourneyId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateUserJourneyResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + Arn: + description: ARN identifier. + type: string + minLength: 31 + pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023} + AssertionText: + type: string + minLength: 1 + maxLength: 1000 + ClientToken: + description: Idempotency token. + type: string + minLength: 1 + maxLength: 63 + pattern: "[A-Za-z0-9_.-]{0,63}" + CreateAssertionResponse: + type: object + properties: + assertion: + $ref: "#/components/schemas/Assertion" + description: The created assertion. + required: + - assertion + Assertion: + description: Represents a resilience assertion for a service. + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + assertionId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the assertion. + text: + $ref: "#/components/schemas/AssertionText" + description: The text content of the assertion. + source: + $ref: "#/components/schemas/AssertionSource" + description: The source of the assertion, indicating whether it was AI-generated or created by a user. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the assertion was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the assertion was last updated. + required: + - serviceArn + - assertionId + - text + - source + Uuid: + type: string + minLength: 36 + maxLength: 36 + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}" + AssertionSource: + type: string + enum: + - AI_GENERATED + - USER + Timestamp: + type: string + format: date-time + ResourceConfiguration: + description: Resource configuration for an input source. Provide exactly one field. + type: object + properties: + resourceTags: + $ref: "#/components/schemas/ResourceTagList" + description: The resource tags for tag-based resource discovery. + cfnStackArn: + $ref: "#/components/schemas/Arn" + tfStateFileUrl: + $ref: "#/components/schemas/S3Url" + eks: + $ref: "#/components/schemas/EksSource" + description: The Amazon EKS configuration for resource discovery. + designFileS3Url: + $ref: "#/components/schemas/S3Url" + ResourceTagList: + type: array + items: + $ref: "#/components/schemas/ResourceTag" + ResourceTag: + description: A tag key-value pair used for resource discovery. + type: object + properties: + key: + $ref: "#/components/schemas/TagKey" + values: + $ref: "#/components/schemas/ResourceTagValuesList" + description: The list of tag values. + required: + - key + - values + TagKey: + description: Tag key. + type: string + minLength: 1 + maxLength: 128 + pattern: "[^\\x00-\\x1f\\x22]+" + ResourceTagValuesList: + type: array + items: + $ref: "#/components/schemas/TagValue" + TagValue: + description: Tag value. + type: string + minLength: 0 + maxLength: 256 + pattern: "[^\\x00-\\x1f\\x22]*" + S3Url: + description: S3 URL — virtual hosted-style or s3:// URI. + type: string + minLength: 1 + maxLength: 2000 + pattern: ((https://([^/]+)\.s3[^/]*\.[^/]+)|(s3://([^/]+)))/\S{1,2000} + EksSource: + description: Defines an Amazon EKS cluster and its namespaces as an input source for resource discovery. + type: object + properties: + clusterArn: + $ref: "#/components/schemas/Arn" + namespaces: + $ref: "#/components/schemas/EksSourceNamespacesList" + description: The list of Kubernetes namespaces within the EKS cluster. + required: + - clusterArn + - namespaces + EksSourceNamespacesList: + type: array + items: + $ref: "#/components/schemas/EksNamespace" + EksNamespace: + description: Kubernetes namespace name (RFC 1123 Label). + type: string + minLength: 1 + maxLength: 63 + pattern: "[a-z0-9]([-a-z0-9]*[a-z0-9])?" + CreateInputSourceResponse: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + inputSourceId: + $ref: "#/components/schemas/InputSourceId" + description: The unique identifier assigned to the created input source. + required: + - serviceArn + - inputSourceId + InputSourceId: + type: string + minLength: 1 + maxLength: 255 + pattern: \S{1,255} + EntityName: + description: Resource name (used in ARN — no spaces allowed). + type: string + minLength: 2 + maxLength: 60 + pattern: "[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}" + LongDescription: + description: Resource description for services and policies. + type: string + minLength: 0 + maxLength: 615 + AvailabilitySlo: + description: Defines the availability service level objective (SLO) for a resilience policy. + type: object + properties: + target: + $ref: "#/components/schemas/AvailabilitySloTargetDouble" + description: The target availability percentage, expressed as a value between 0 and 100. + AvailabilitySloTargetDouble: + type: number + format: double + minimum: 0 + maximum: 100 + MultiAzTargets: + description: Defines the multi-AZ disaster recovery targets for a resilience policy. + type: object + properties: + rtoInMinutes: + $ref: "#/components/schemas/MultiAzTargetsRtoInMinutesInteger" + description: The recovery time objective (RTO) target for multi-AZ, in minutes. + rpoInMinutes: + $ref: "#/components/schemas/MultiAzTargetsRpoInMinutesInteger" + description: The recovery point objective (RPO) target for multi-AZ, in minutes. + disasterRecoveryApproach: + $ref: "#/components/schemas/MultiAzDisasterRecoveryApproach" + description: The disaster recovery approach for multi-AZ. + MultiAzTargetsRtoInMinutesInteger: + type: integer + minimum: 0 + MultiAzTargetsRpoInMinutesInteger: + type: integer + minimum: 0 + MultiAzDisasterRecoveryApproach: + type: string + enum: + - ACTIVE_ACTIVE + - HOT_STANDBY + - WARM_STANDBY + - PILOT_LIGHT + - BACKUP_AND_RESTORE + MultiRegionTargets: + description: Defines the multi-Region disaster recovery targets for a resilience policy. + type: object + properties: + rtoInMinutes: + $ref: "#/components/schemas/MultiRegionTargetsRtoInMinutesInteger" + description: The recovery time objective (RTO) target for multi-Region, in minutes. + rpoInMinutes: + $ref: "#/components/schemas/MultiRegionTargetsRpoInMinutesInteger" + description: The recovery point objective (RPO) target for multi-Region, in minutes. + disasterRecoveryApproach: + $ref: "#/components/schemas/MultiRegionDisasterRecoveryApproach" + description: The disaster recovery approach for multi-Region. + MultiRegionTargetsRtoInMinutesInteger: + type: integer + minimum: 0 + MultiRegionTargetsRpoInMinutesInteger: + type: integer + minimum: 0 + MultiRegionDisasterRecoveryApproach: + type: string + enum: + - ACTIVE_ACTIVE + - HOT_STANDBY + - WARM_STANDBY + - PILOT_LIGHT + - BACKUP_AND_RESTORE + DataRecoveryTargets: + description: Defines data recovery targets for a resilience policy. + type: object + properties: + timeBetweenBackupsInMinutes: + $ref: "#/components/schemas/DataRecoveryTargetsTimeBetweenBackupsInMinutesInteger" + description: The target time between backups, in minutes. + DataRecoveryTargetsTimeBetweenBackupsInMinutesInteger: + type: integer + minimum: 0 + KmsKeyId: + description: KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN. + type: string + minLength: 1 + maxLength: 2048 + TagMap: + description: Resource tags. + type: object + properties: {} + CreatePolicyResponse: + type: object + properties: + policy: + $ref: "#/components/schemas/Policy" + description: The created resilience policy. + required: + - policy + Policy: + description: Represents a resilience policy that defines availability and disaster recovery requirements. + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/LongDescription" + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + description: The availability SLO defined in the policy. + multiAz: + $ref: "#/components/schemas/MultiAzTargets" + description: The multi-AZ disaster recovery targets defined in the policy. + multiRegion: + $ref: "#/components/schemas/MultiRegionTargets" + description: The multi-Region disaster recovery targets defined in the policy. + dataRecovery: + $ref: "#/components/schemas/DataRecoveryTargets" + description: The data recovery targets defined in the policy. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + type: object + properties: {} + associatedServiceCount: + $ref: "#/components/schemas/Integer" + description: The number of services associated with this policy. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the policy was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the policy was last updated. + required: + - policyArn + - name + Integer: + type: integer + ReportType: + type: string + enum: + - FAILURE_MODE + - TESTING + CreateReportResponse: + type: object + properties: + reportGenerationResult: + $ref: "#/components/schemas/ReportGenerationResult" + description: The result of the report generation request. + required: + - reportGenerationResult + ReportGenerationResult: + description: Result of a report generation attempt. + type: object + properties: + reportType: + $ref: "#/components/schemas/ReportType" + description: The type of the generated report. + status: + $ref: "#/components/schemas/ReportGenerationStatus" + description: The status of the report generation. + serviceArn: + $ref: "#/components/schemas/Arn" + description: The service this report was generated for. + assessmentId: + $ref: "#/components/schemas/Uuid" + description: Present for FAILURE_MODE reports. + testRunId: + $ref: "#/components/schemas/TestRunId" + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the report was created. + reportOutput: + $ref: "#/components/schemas/ReportOutput" + description: Present when status is SUCCEEDED or FAILED. + required: + - reportType + - status + ReportGenerationStatus: + description: Status of report generation. + type: string + enum: + - PENDING + - SUCCEEDED + - FAILED + TestRunId: + description: The unique identifier of a test run. + type: string + ServiceOwnedArn: + description: An ARN owned by the service. Accepts either a standard 12-digit account ID or the literal "aws" for AWS-managed resources, such as AWS-managed test templates. + type: string + minLength: 31 + pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):([0-9]{12}|aws):[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023} + ReportOutput: + description: Union of possible report outputs. + type: object + properties: + s3ReportOutput: + $ref: "#/components/schemas/S3ReportOutput" + description: The S3 location where the report was written. + failedReportOutput: + $ref: "#/components/schemas/FailedReportOutput" + description: Details when report generation failed. + S3ReportOutput: + description: S3 location where report was written. + type: object + properties: + s3ObjectKey: + $ref: "#/components/schemas/String" + description: The S3 object key for the generated report. + required: + - s3ObjectKey + String: + type: string + FailedReportOutput: + description: Details when report generation failed. + type: object + properties: + errorCode: + $ref: "#/components/schemas/ReportGenerationErrorCode" + description: The error code describing why the report generation failed. + errorMessage: + $ref: "#/components/schemas/String" + description: The error message describing why the report generation failed. + required: + - errorCode + ReportGenerationErrorCode: + description: Error codes for failed report generation. + type: string + enum: + - INSUFFICIENT_PERMISSIONS + - CONFIGURATION_ERROR + - INTERNAL_ERROR + AssociatedSystemList: + type: array + items: + $ref: "#/components/schemas/AssociatedSystem" + AssociatedSystem: + description: Represents a system associated with a service. + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + systemName: + $ref: "#/components/schemas/EntityName" + userJourneyIds: + $ref: "#/components/schemas/UserJourneyIdList" + description: The list of user journey identifiers that associate this system with the service. + required: + - systemArn + UserJourneyIdList: + type: array + items: + $ref: "#/components/schemas/UserJourneyId" + UserJourneyId: + type: string + minLength: 1 + maxLength: 255 + pattern: \S{1,255} + RegionList: + type: array + items: + $ref: "#/components/schemas/AwsRegion" + AwsRegion: + type: string + minLength: 6 + pattern: "[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]" + PermissionModel: + description: Defines the permission model for a service. + type: object + properties: + invokerRoleName: + $ref: "#/components/schemas/IamRoleName" + crossAccountRoles: + $ref: "#/components/schemas/CrossAccountRoleList" + description: The list of cross-account IAM role ARNs. + required: + - invokerRoleName + IamRoleName: + description: IAM role name (supports up to 64 characters per IAM limits). + type: string + minLength: 1 + maxLength: 576 + pattern: ([A-Za-z0-9_+=,.@\-]+/)*[A-Za-z0-9_+=,.@\-]+ + CrossAccountRoleList: + type: array + items: + $ref: "#/components/schemas/CrossAccountRole" + CrossAccountRole: + description: Specifies a cross-account IAM role ARN and optional external ID. + type: object + properties: + crossAccountRoleArn: + $ref: "#/components/schemas/IamRoleArn" + externalId: + $ref: "#/components/schemas/CrossAccountRoleExternalIdString" + description: The external ID used for assuming the cross-account role. + required: + - crossAccountRoleArn + IamRoleArn: + description: ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile. + type: string + minLength: 32 + pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role/(([^/][!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64} + CrossAccountRoleExternalIdString: + type: string + minLength: 2 + maxLength: 1224 + DependencyDiscoveryInput: + description: Caller-settable values for dependency discovery. INITIALIZING is system-managed. + type: string + enum: + - ENABLED + - DISABLED + ServiceReportConfiguration: + description: Configuration for automatic report generation on a Service. + type: object + properties: + reportOutputs: + $ref: "#/components/schemas/ReportOutputConfigurationList" + description: Output destinations for generated reports. + required: + - reportOutputs + ReportOutputConfigurationList: + description: List of report output configurations. + type: array + items: + $ref: "#/components/schemas/ReportOutputConfiguration" + ReportOutputConfiguration: + description: Configuration for a report output destination. + type: object + properties: + s3: + $ref: "#/components/schemas/S3ReportOutputConfiguration" + S3ReportOutputConfiguration: + description: S3 configuration for report output. + type: object + properties: + bucketPath: + $ref: "#/components/schemas/S3BucketPath" + description: S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/). + bucketOwner: + $ref: "#/components/schemas/AwsAccountId" + description: Account ID of the bucket owner for cross-account access verification. + required: + - bucketPath + - bucketOwner + S3BucketPath: + description: S3 bucket path (with or without s3:// prefix). + type: string + minLength: 3 + maxLength: 512 + pattern: (s3://)?[a-z0-9][a-z0-9.-]{1,61}[a-z0-9](/.*)? + AwsAccountId: + type: string + minLength: 12 + maxLength: 12 + pattern: \d{12} + CreateServiceResponse: + type: object + properties: + service: + $ref: "#/components/schemas/Service" + description: The created service. + required: + - service + Service: + description: Represents a service in Resilience Hub. A service is the primary unit of resilience assessment. + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/LongDescription" + associatedSystems: + $ref: "#/components/schemas/AssociatedSystemList" + description: The systems associated with the service. + policyArn: + $ref: "#/components/schemas/Arn" + regions: + $ref: "#/components/schemas/RegionList" + description: The Regions where the service operates. + permissionModel: + $ref: "#/components/schemas/PermissionModel" + description: The permission model for the service. + dependencyDiscovery: + $ref: "#/components/schemas/DependencyDiscoveryConfig" + description: The dependency discovery configuration for the service. + effectivePolicyValues: + $ref: "#/components/schemas/EffectivePolicyValues" + description: The effective policy values for the service. + achievability: + $ref: "#/components/schemas/Achievability" + description: The achievability status of the service's resilience targets. + reportConfiguration: + $ref: "#/components/schemas/ServiceReportConfiguration" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + type: object + properties: {} + estimatedAssessmentCost: + $ref: "#/components/schemas/AssessmentCost" + description: The estimated cost of running an assessment on the service. + resourceDiscovery: + $ref: "#/components/schemas/ResourceDiscoveryStatus" + description: The resource discovery status for the service. + assessmentStatus: + $ref: "#/components/schemas/AssessmentStatus" + description: The current assessment status of the service. + rerunAssessment: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the assessment should be rerun. + openFindingsCount: + $ref: "#/components/schemas/Integer" + description: The number of open findings for the service. + resolvedFindingsCount: + $ref: "#/components/schemas/Integer" + description: The number of resolved findings for the service. + organizationId: + $ref: "#/components/schemas/OrganizationId" + description: The AWS Organizations identifier for the service. + ouId: + $ref: "#/components/schemas/OuId" + description: The organizational unit (OU) identifier for the service. + accountId: + $ref: "#/components/schemas/AccountId" + description: The AWS account ID that owns the service. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service was last updated. + required: + - serviceArn + - name + DependencyDiscoveryConfig: + description: Configuration for dependency discovery on a service. + type: object + properties: + status: + $ref: "#/components/schemas/DependencyDiscoveryStatus" + description: The current status of dependency discovery. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when dependency discovery was last updated. + eligibleResourceCount: + $ref: "#/components/schemas/DependencyDiscoveryConfigEligibleResourceCountInteger" + description: The count of resources eligible for dependency attribution. + message: + $ref: "#/components/schemas/DependencyDiscoveryConfigMessageString" + description: A status message for dependency discovery, displayed during the initialization state. + required: + - status + DependencyDiscoveryStatus: + type: string + enum: + - ENABLED + - INITIALIZING + - DISABLED + DependencyDiscoveryConfigEligibleResourceCountInteger: + type: integer + minimum: 0 + DependencyDiscoveryConfigMessageString: + type: string + minLength: 0 + maxLength: 1024 + EffectivePolicyValues: + description: Contains the effective resilience policy values for a service. + type: object + properties: + availabilitySlo: + $ref: "#/components/schemas/SloSource" + description: The effective availability SLO value for the service. + multiAzRto: + $ref: "#/components/schemas/TargetSource" + description: The effective multi-AZ RTO value for the service, in minutes. + multiAzRpo: + $ref: "#/components/schemas/TargetSource" + description: The effective multi-AZ RPO value for the service, in minutes. + multiAzDrApproach: + $ref: "#/components/schemas/DisasterRecoverySource" + description: The effective multi-AZ disaster recovery approach for the service. + multiRegionRto: + $ref: "#/components/schemas/TargetSource" + description: The effective multi-Region RTO value for the service, in minutes. + multiRegionRpo: + $ref: "#/components/schemas/TargetSource" + description: The effective multi-Region RPO value for the service, in minutes. + multiRegionDrApproach: + $ref: "#/components/schemas/DisasterRecoverySource" + description: The effective multi-Region disaster recovery approach for the service. + dataRecoveryTimeBetweenBackups: + $ref: "#/components/schemas/TargetSource" + description: The effective data recovery time between backups value for the service. + SloSource: + description: Contains the effective availability SLO value and its source. + type: object + properties: + value: + $ref: "#/components/schemas/Double" + description: The availability SLO percentage value. + policyName: + $ref: "#/components/schemas/EntityName" + source: + $ref: "#/components/schemas/PolicyValueSource" + description: Indicates whether the value comes from the service's own account or a cross-account policy. + Double: + type: number + format: double + PolicyValueSource: + type: string + enum: + - SELF + - CROSS_ACCOUNT + TargetSource: + description: Contains an effective RTO or RPO value and its source. + type: object + properties: + value: + $ref: "#/components/schemas/Integer" + description: The RTO or RPO value in minutes. + policyName: + $ref: "#/components/schemas/EntityName" + source: + $ref: "#/components/schemas/PolicyValueSource" + description: Indicates whether the value comes from the service's own account or a cross-account policy. + DisasterRecoverySource: + description: Contains the effective disaster recovery approach value for a service. + type: object + properties: + value: + $ref: "#/components/schemas/String" + description: The disaster recovery approach value. + policyName: + $ref: "#/components/schemas/EntityName" + source: + $ref: "#/components/schemas/PolicyValueSource" + description: Indicates whether the value comes from the service's own account or a cross-account policy. + Achievability: + description: Describes the achievability status of a service's resilience targets based on the most recent assessment. + type: object + properties: + availabilitySlo: + $ref: "#/components/schemas/AchievabilityStatus" + description: The achievability status of the availability SLO target for the service. + multiAzRtoRpo: + $ref: "#/components/schemas/AchievabilityStatus" + description: The achievability status of the multi-AZ RTO and RPO targets for the service. + multiRegionRtoRpo: + $ref: "#/components/schemas/AchievabilityStatus" + description: The achievability status of the multi-Region RTO and RPO targets for the service. + dataRecoveryTimeBetweenBackups: + $ref: "#/components/schemas/AchievabilityStatus" + description: The achievability status of the data recovery time between backups for the service. + AchievabilityStatus: + type: string + enum: + - ACHIEVABLE + - NOT_ACHIEVABLE + AssessmentCost: + description: Represents the cost of running a failure mode assessment. + type: object + properties: + amount: + $ref: "#/components/schemas/Double" + description: The cost amount for the assessment. + currency: + $ref: "#/components/schemas/CostCurrency" + description: The currency of the assessment cost. + CostCurrency: + type: string + enum: + - USD + ResourceDiscoveryStatus: + description: Contains the status of resource discovery for a service. + type: object + properties: + status: + $ref: "#/components/schemas/ResourceDiscoveryRunStatus" + description: The current status of resource discovery. + lastRunAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the last resource discovery run. + errorCode: + $ref: "#/components/schemas/ResourceDiscoveryErrorCode" + description: The error code if resource discovery failed. + errorMessage: + $ref: "#/components/schemas/String" + description: A message describing the error if resource discovery failed. + ResourceDiscoveryRunStatus: + type: string + enum: + - RUNNING + - SUCCEEDED + - FAILED + - COMPLETED_WITH_FAILURES + - NOT_STARTED + ResourceDiscoveryErrorCode: + type: string + enum: + - INVALID_PERMISSIONS + - STACK_NOT_FOUND + - CLUSTER_NOT_FOUND + - STATE_FILE_NOT_FOUND + - ACCESS_DENIED + - UNSUPPORTED_CLUSTER + - INTERNAL_ERROR + AssessmentStatus: + type: string + enum: + - NOT_STARTED + - PENDING + - IN_PROGRESS + - FAILED + - SUCCESS + Boolean: + type: boolean + OrganizationId: + type: string + minLength: 12 + maxLength: 34 + pattern: o-[a-z0-9]{10,32} + OuId: + type: string + minLength: 16 + maxLength: 68 + pattern: ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} + AccountId: + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]{12}" + EntityLabel: + description: Entity label (not part of ARN — spaces allowed). + type: string + minLength: 2 + maxLength: 60 + pattern: "[A-Za-z0-9][A-Za-z0-9 _\\-]{1,59}" + EntityDescription: + description: Resource description. + type: string + minLength: 0 + maxLength: 500 + ServiceFunctionCriticality: + type: string + enum: + - PRIMARY + - SUPPLEMENTAL + CreateServiceFunctionResponse: + type: object + properties: + serviceFunction: + $ref: "#/components/schemas/ServiceFunction" + description: The created service function. + required: + - serviceFunction + ServiceFunction: + description: Represents a logical component of a service. + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + description: The unique identifier of the service function. + name: + $ref: "#/components/schemas/EntityLabel" + description: + $ref: "#/components/schemas/EntityDescription" + criticality: + $ref: "#/components/schemas/ServiceFunctionCriticality" + description: The criticality level of the service function. + resourceCount: + $ref: "#/components/schemas/Integer" + description: The number of resources associated with the service function. + source: + $ref: "#/components/schemas/ServiceFunctionSource" + description: The source of the service function. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service function was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service function was last updated. + required: + - serviceArn + - serviceFunctionId + - name + - criticality + EntityId: + type: string + minLength: 1 + maxLength: 255 + pattern: \S{1,255} + ServiceFunctionSource: + type: string + enum: + - AI_GENERATED + - USER + ResourceList: + type: array + items: + $ref: "#/components/schemas/String" + CreateServiceFunctionResourcesResponse: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + description: The identifier of the service function. + resources: + $ref: "#/components/schemas/ResourceList" + description: The list of resources that were associated. + CreateSystemResponse: + type: object + properties: + system: + $ref: "#/components/schemas/System" + description: The created system. + required: + - system + System: + description: Represents a system in Resilience Hub. A system is a logical grouping of services. + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + systemId: + $ref: "#/components/schemas/SystemId" + name: + $ref: "#/components/schemas/EntityName" + description: + $ref: "#/components/schemas/EntityDescription" + sharingEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether cross-account sharing is enabled. + tags: + type: object + properties: {} + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + organizationId: + $ref: "#/components/schemas/OrganizationId" + description: The AWS Organizations identifier for the system. + ouId: + $ref: "#/components/schemas/OuId" + description: The organizational unit (OU) identifier for the system. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the system was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the system was last updated. + required: + - systemArn + - systemId + - name + SystemId: + description: System ID for cross-account use without exposing account structure. + type: string + minLength: 1 + maxLength: 255 + pattern: \S{1,255} + LoggingConfiguration: + description: Configuration for test execution logging destinations. + type: object + properties: + s3BucketName: + $ref: "#/components/schemas/String" + description: The name of the S3 bucket for log delivery. + cloudWatchLogGroupArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the CloudWatch Logs log group for log delivery. + logSchemaVersion: + $ref: "#/components/schemas/String" + description: The version of the log schema. + StopConditionList: + type: array + items: + $ref: "#/components/schemas/StopCondition" + StopCondition: + description: A CloudWatch alarm that automatically stops a test run if it breaches its threshold. + type: object + properties: + source: + $ref: "#/components/schemas/StopConditionSource" + description: The source of the stop condition. + value: + $ref: "#/components/schemas/String" + description: The value of the stop condition, such as the ARN of the CloudWatch alarm. + required: + - source + - value + StopConditionSource: + description: The source of a test stop condition, matching AWS Fault Injection Service (AWS FIS) stop condition sources. + type: string + enum: + - aws:cloudwatch:alarm + - none + TestParameters: + type: object + properties: {} + CreateTestResponse: + type: object + properties: + test: + $ref: "#/components/schemas/Test" + description: The created test. + required: + - test + Test: + description: Represents a test created for a service by configuring a test template. + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + description: The unique identifier of the test. + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template the test was created from. + serviceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test belongs to. + name: + $ref: "#/components/schemas/String" + description: The name of the test. + actions: + $ref: "#/components/schemas/TestActionList" + description: The fault actions the test runs. + loggingConfiguration: + $ref: "#/components/schemas/LoggingConfiguration" + description: The logging configuration for the test. + stopConditions: + $ref: "#/components/schemas/StopConditionList" + description: The stop conditions for the test. + roleName: + $ref: "#/components/schemas/EntityName" + description: The name of the IAM execution role used to run the test. + parameters: + type: object + properties: {} + description: The parameter values configured for the test. + totalTestRuns: + $ref: "#/components/schemas/Integer" + description: The total number of runs of the test. + successfulTestRuns: + $ref: "#/components/schemas/Integer" + description: The number of successful runs of the test. + creationTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test was created. + required: + - testId + - testTemplateArn + - serviceArn + - name + - totalTestRuns + - successfulTestRuns + - creationTime + TestId: + description: The unique identifier of a test. + type: string + TestActionList: + type: array + items: + $ref: "#/components/schemas/TestAction" + TestAction: + description: Represents a fault action that a test runs, along with the resource type it targets. + type: object + properties: + actionId: + $ref: "#/components/schemas/String" + description: The identifier of the fault action. + description: + $ref: "#/components/schemas/String" + description: A description of the fault action. + resourceType: + $ref: "#/components/schemas/String" + description: The resource type that the action targets. + required: + - actionId + - resourceType + CreateUserJourneyResponse: + type: object + properties: + userJourney: + $ref: "#/components/schemas/UserJourney" + description: The created user journey. + required: + - userJourney + UserJourney: + description: Represents a user journey that defines a critical path through a system. + type: object + properties: + userJourneyId: + $ref: "#/components/schemas/UserJourneyId" + description: The unique identifier of the user journey. + name: + $ref: "#/components/schemas/EntityLabel" + description: + $ref: "#/components/schemas/EntityDescription" + policyArn: + $ref: "#/components/schemas/Arn" + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the user journey was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the user journey was last updated. + required: + - userJourneyId + - name + DeleteAssertionResponse: + type: object + properties: + assertionId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the deleted assertion. + DeleteInputSourceResponse: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + inputSourceId: + $ref: "#/components/schemas/InputSourceId" + description: The identifier of the deleted input source. + required: + - serviceArn + - inputSourceId + DeletePolicyResponse: + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + required: + - policyArn + DeleteServiceResponse: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + required: + - serviceArn + DeleteServiceFunctionResponse: + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + description: The identifier of the deleted service function. + DeleteServiceFunctionResourcesResponse: + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + description: The identifier of the service function. + resources: + $ref: "#/components/schemas/ResourceList" + description: The list of resources that were removed. + DeleteSystemResponse: + type: object + properties: + systemArn: + $ref: "#/components/schemas/Arn" + required: + - systemArn + DeleteTestResponse: + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + description: The identifier of the deleted test. + required: + - testId + TestSourceInputList: + type: array + items: + $ref: "#/components/schemas/TestSourceInput" + TestSourceInput: + description: Identifies a monitoring source to add to or remove from a test. Exactly one member is set. + type: object + properties: + successCriteriaAlarm: + $ref: "#/components/schemas/SuccessCriteriaAlarmInput" + description: A success criteria alarm that determines whether the test passes or fails. + observabilityAlarm: + $ref: "#/components/schemas/ObservabilityAlarmInput" + description: An observability alarm included for visibility only. + SuccessCriteriaAlarmInput: + description: Identifies a success criteria alarm by its ARN. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + required: + - alarmArn + CloudWatchAlarmArn: + description: The ARN of a CloudWatch alarm. + type: string + minLength: 31 + maxLength: 1024 + pattern: arn:aws[a-zA-Z-]*:cloudwatch:[a-z]{2}(-[a-z]+)+-\d{1}:\d{12}:alarm:.+ + ObservabilityAlarmInput: + description: Identifies an observability alarm by its ARN. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + required: + - alarmArn + DeleteTestSourcesResponse: + type: object + DeleteUserJourneyResponse: + type: object + properties: + userJourneyId: + $ref: "#/components/schemas/UserJourneyId" + description: The identifier of the deleted user journey. + required: + - userJourneyId + GetFailureModeFindingResponse: + type: object + properties: + finding: + $ref: "#/components/schemas/Finding" + description: The requested finding. + Finding: + description: Represents a resilience finding from a failure mode assessment. + type: object + properties: + findingId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the finding. + name: + $ref: "#/components/schemas/String" + description: The name of the finding. + description: + $ref: "#/components/schemas/EntityDescription" + failureCategory: + $ref: "#/components/schemas/FailureCategory" + description: The failure category of the finding. + status: + $ref: "#/components/schemas/FindingStatus" + description: The current status of the finding. + reasoning: + $ref: "#/components/schemas/String" + description: The reasoning behind the finding. + comment: + $ref: "#/components/schemas/FindingCommentString" + description: A user-provided comment about the finding. + severity: + $ref: "#/components/schemas/FindingSeverity" + description: The severity of the finding. + serviceFunctions: + $ref: "#/components/schemas/FunctionsList" + description: The service functions associated with the finding. + policyComponent: + $ref: "#/components/schemas/PolicyComponent" + description: The policy component associated with the finding. + infrastructureAndCodeRecommendations: + $ref: "#/components/schemas/InfrastructureAndCodeRecommendationsList" + description: Infrastructure and code recommendations to address the finding. + observabilityRecommendations: + $ref: "#/components/schemas/ObservabilityRecommendationsList" + description: Observability recommendations to address the finding. + testingRecommendations: + $ref: "#/components/schemas/TestingRecommendationsList" + description: Testing recommendations to address the finding. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the finding was last updated. + FailureCategory: + type: string + enum: + - SHARED_FATE + - EXCESSIVE_LOAD + - EXCESSIVE_LATENCY + - MISCONFIGURATION_AND_BUGS + - SINGLE_POINT_OF_FAILURE + FindingStatus: + type: string + enum: + - OPEN + - RESOLVED + - IRRELEVANT + FindingCommentString: + type: string + minLength: 0 + maxLength: 2048 + FindingSeverity: + type: string + enum: + - LOW + - MEDIUM + - HIGH + FunctionsList: + type: array + items: + $ref: "#/components/schemas/EntityId" + PolicyComponent: + type: string + enum: + - AVAILABILITY_SLO + - MULTI_AZ_DISASTER_RECOVERY + - MULTI_REGION_DISASTER_RECOVERY + - DATA_RECOVERY + InfrastructureAndCodeRecommendationsList: + type: array + items: + $ref: "#/components/schemas/InfrastructureAndCodeRecommendation" + InfrastructureAndCodeRecommendation: + description: An infrastructure and code recommendation to address a finding. + type: object + properties: + suggestedChanges: + $ref: "#/components/schemas/SuggestedChangesList" + description: The list of suggested changes. + SuggestedChangesList: + type: array + items: + $ref: "#/components/schemas/EntityDescription" + ObservabilityRecommendationsList: + type: array + items: + $ref: "#/components/schemas/ObservabilityRecommendation" + ObservabilityRecommendation: + description: An observability recommendation to address a finding. + type: object + properties: + suggestedChanges: + $ref: "#/components/schemas/SuggestedChangesList" + description: The list of suggested observability changes. + TestingRecommendationsList: + type: array + items: + $ref: "#/components/schemas/TestingRecommendation" + TestingRecommendation: + description: A testing recommendation to address a finding. + type: object + properties: + suggestedChanges: + $ref: "#/components/schemas/SuggestedChangesList" + description: The list of suggested testing changes. + GetPolicyResponse: + type: object + properties: + policy: + $ref: "#/components/schemas/Policy" + description: The requested resilience policy. + required: + - policy + GetServiceResponse: + type: object + properties: + service: + $ref: "#/components/schemas/Service" + description: The requested service. + required: + - service + GetSystemResponse: + type: object + properties: + system: + $ref: "#/components/schemas/System" + description: The requested system. + required: + - system + GetTestResponse: + type: object + properties: + test: + $ref: "#/components/schemas/Test" + description: The requested test. + required: + - test + GetTestRunResponse: + type: object + properties: + testRun: + $ref: "#/components/schemas/TestRun" + description: The requested test run. + required: + - testRun + TestRun: + description: Represents a single run of a test. Configuration is snapshotted from the test and service at the time the run is started. + type: object + properties: + testRunId: + $ref: "#/components/schemas/TestRunId" + description: The unique identifier of the test run. + testId: + $ref: "#/components/schemas/TestId" + description: The identifier of the test that was run. + status: + $ref: "#/components/schemas/TestRunStatus" + description: The current status of the test run. + serviceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test run started. + endedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test run ended. + experiments: + $ref: "#/components/schemas/ExperimentDetailsList" + description: The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run. + eventCount: + $ref: "#/components/schemas/Integer" + description: The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details. + parameters: + type: object + properties: {} + description: The parameter values used for the test run. + errorMessage: + $ref: "#/components/schemas/String" + description: A human-readable reason for test run failure. Only present when the status is FAILED or ERROR. + stopConditions: + $ref: "#/components/schemas/StopConditionList" + description: The stop conditions snapshotted from the test when the run was started. + loggingConfiguration: + $ref: "#/components/schemas/LoggingConfiguration" + description: The logging configuration snapshotted from the test when the run was started. + roleName: + $ref: "#/components/schemas/EntityName" + description: The IAM execution role name snapshotted from the test when the run was started. + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template snapshotted from the test when the run was started. + reportConfiguration: + $ref: "#/components/schemas/TestRunReportConfiguration" + description: The report configuration snapshotted from the service when the run was started. + policy: + $ref: "#/components/schemas/TestRunPolicySnapshot" + description: The resilience policy snapshotted from the service when the run was started. + reportOutput: + $ref: "#/components/schemas/ReportGenerationResult" + description: The report generation result for the test run. Present after report generation completes or fails. + regionSwitchPlanArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the ARC Region switch plan associated with the test run. + regionSwitchExecutionId: + $ref: "#/components/schemas/RegionSwitchExecutionId" + description: The identifier of the ARC Region switch execution detected during the test run. + permissionModel: + $ref: "#/components/schemas/PermissionModel" + description: The permission model snapshotted from the service when the run was started. + regions: + $ref: "#/components/schemas/RegionList" + description: The Regions snapshotted from the service when the run was started. + accountTargeting: + $ref: "#/components/schemas/AccountTargeting" + description: Indicates whether this test run targets a single account or multiple accounts. + required: + - testRunId + - testId + - status + - startedAt + - testTemplateArn + TestRunStatus: + description: The status of a test run through its lifecycle. + type: string + enum: + - INITIALIZING + - RUNNING + - STOPPING + - PASSED + - FAILED + - STOPPED + - ERROR + ExperimentDetailsList: + type: array + items: + $ref: "#/components/schemas/ExperimentDetails" + ExperimentDetails: + description: Details about an AWS Fault Injection Service (AWS FIS) experiment run as part of a test run. + type: object + properties: + experimentArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the AWS FIS experiment. + details: + $ref: "#/components/schemas/String" + description: Additional details about the experiment. + required: + - experimentArn + TestRunReportConfiguration: + description: A snapshot of the report configuration captured onto a test run from the service when the run was started. + type: object + properties: + reportOutput: + $ref: "#/components/schemas/ReportOutputConfigurationList" + description: The output destinations for generated reports. + required: + - reportOutput + TestRunPolicySnapshot: + description: A snapshot of the resilience policy captured onto a test run from the service when the run was started. + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the policy. + name: + $ref: "#/components/schemas/EntityName" + description: The name of the policy. + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + description: The availability SLO targets. + multiAz: + $ref: "#/components/schemas/MultiAzTargets" + description: The multi-AZ resilience targets. + multiRegion: + $ref: "#/components/schemas/MultiRegionTargets" + description: The multi-Region resilience targets. + dataRecovery: + $ref: "#/components/schemas/DataRecoveryTargets" + description: The data recovery targets. + RegionSwitchExecutionId: + description: The identifier of an ARC Region switch plan execution detected during a test run. + type: string + minLength: 1 + maxLength: 64 + pattern: "[a-z]{2}(-[a-z]+)+-[0-9]+/[0-9a-fA-F]{16}" + AccountTargeting: + description: Whether a test run targets resources in a single AWS account or across multiple accounts. + type: string + enum: + - SINGLE_ACCOUNT + - MULTI_ACCOUNT + GetTestTemplateResponse: + type: object + properties: + testTemplate: + $ref: "#/components/schemas/TestTemplate" + description: The requested test template. + required: + - testTemplate + TestTemplate: + description: A pre-configured, AWS recommended test that defines which resilience capability to validate, the fault actions it runs, and the parameters it accepts. + type: object + properties: + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template. + name: + $ref: "#/components/schemas/String" + description: The name of the test template. + description: + $ref: "#/components/schemas/String" + description: A description of the test template. + parameters: + $ref: "#/components/schemas/TestTemplateParameterList" + description: The parameters the test template accepts. + actions: + $ref: "#/components/schemas/TestActionList" + description: The fault actions the test template runs. + required: + - testTemplateArn + - name + TestTemplateParameterList: + type: array + items: + $ref: "#/components/schemas/TestTemplateParameter" + TestTemplateParameter: + description: Describes a parameter accepted by a test template. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the parameter. + description: + $ref: "#/components/schemas/String" + description: A description of the parameter. + type_: + $ref: "#/components/schemas/ParameterType" + description: The data type of the parameter. + required_: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the parameter is required. + defaultValue: + $ref: "#/components/schemas/String" + description: The default value of the parameter. + maxValues: + $ref: "#/components/schemas/Integer" + description: The maximum number of values the parameter accepts. + required: + - name + - type_ + - required_ + ParameterType: + description: The data type of a test template parameter. + type: string + enum: + - STRING + - STRING_LIST + - INTEGER + GetUserJourneyResponse: + type: object + properties: + userJourney: + $ref: "#/components/schemas/UserJourney" + description: The requested user journey. + required: + - userJourney + ImportAppResponse: + type: object + properties: + service: + $ref: "#/components/schemas/Service" + description: The imported service. + required: + - service + ImportPolicyResponse: + type: object + properties: + policy: + $ref: "#/components/schemas/Policy" + description: The imported policy. + required: + - policy + MaxResults: + description: Pagination page size. + type: integer + minimum: 1 + maximum: 100 + NextToken: + description: Pagination token. + type: string + minLength: 1 + maxLength: 2000 + pattern: \S{1,2000} + ListAssertionsResponse: + type: object + properties: + assertions: + $ref: "#/components/schemas/AssertionList" + description: The list of assertions. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - assertions + AssertionList: + type: array + items: + $ref: "#/components/schemas/Assertion" + QueryGranularity: + type: string + enum: + - HOURLY + - DAILY + ListDependenciesResponse: + type: object + properties: + dependencySummaries: + $ref: "#/components/schemas/DependencySummaryList" + description: The list of dependency summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - dependencySummaries + DependencySummaryList: + type: array + items: + $ref: "#/components/schemas/DependencySummary" + DependencySummary: + description: Contains summary information about a discovered dependency. + type: object + properties: + dependencyId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the dependency. + serviceArn: + $ref: "#/components/schemas/Arn" + dependencyName: + $ref: "#/components/schemas/String" + description: The name of the dependency. + dnsName: + $ref: "#/components/schemas/String" + description: The DNS name associated with the dependency. + location: + $ref: "#/components/schemas/String" + description: The location of the dependency. + lastDetectedTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dependency was last detected. + sourceRegions: + $ref: "#/components/schemas/RegionList" + description: The source Regions from which the dependency was detected. + provider: + $ref: "#/components/schemas/String" + description: The provider of the dependency. + queryRange: + $ref: "#/components/schemas/QueryRange" + description: The query range data for the dependency. + criticality: + $ref: "#/components/schemas/DependencyCriticality" + description: The criticality level of the dependency. + comment: + $ref: "#/components/schemas/String" + description: A user-provided comment about the dependency. + required: + - dependencyId + - serviceArn + - dependencyName + - dnsName + - location + - lastDetectedTime + - sourceRegions + - queryRange + - criticality + QueryRange: + description: Defines a time range for dependency query data. + type: object + properties: + startTime: + $ref: "#/components/schemas/Timestamp" + description: The start time of the query range. + endTime: + $ref: "#/components/schemas/Timestamp" + description: The end time of the query range. + granularity: + $ref: "#/components/schemas/QueryGranularity" + description: The granularity of the query range data points. + dataPoints: + $ref: "#/components/schemas/QueryDataPointList" + description: The data points within the query range. + required: + - startTime + - endTime + - granularity + - dataPoints + QueryDataPointList: + type: array + items: + $ref: "#/components/schemas/QueryDataPoint" + QueryDataPoint: + description: A data point in a dependency query range. + type: object + properties: + timestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the data point. + queryCount: + $ref: "#/components/schemas/Long" + description: The number of queries at this data point. + required: + - timestamp + - queryCount + Long: + type: integer + format: int64 + DependencyCriticality: + type: string + enum: + - HARD + - SOFT + - UNKNOWN + AssessmentStatusList: + type: array + items: + $ref: "#/components/schemas/AssessmentStatus" + AssessmentSortField: + description: The field by which to sort failure mode assessment results. + type: string + enum: + - STARTED_AT + SortOrder: + description: The order in which to sort results. + type: string + enum: + - ASC + - DESC + ListFailureModeAssessmentsResponse: + type: object + properties: + assessmentSummaries: + $ref: "#/components/schemas/AssessmentSummaryList" + description: The list of assessment summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - assessmentSummaries + AssessmentSummaryList: + type: array + items: + $ref: "#/components/schemas/AssessmentSummary" + AssessmentSummary: + description: Contains summary information about a failure mode assessment. + type: object + properties: + assessmentId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the assessment. + serviceArn: + $ref: "#/components/schemas/Arn" + assessmentStatus: + $ref: "#/components/schemas/AssessmentStatus" + description: The current status of the assessment. + assessmentStep: + $ref: "#/components/schemas/AssessmentStep" + description: The current step of the assessment process. + totalFindings: + $ref: "#/components/schemas/Integer" + description: The total number of findings generated by the assessment. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the assessment started. + endedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the assessment ended. + errorMessage: + $ref: "#/components/schemas/String" + description: A message describing the error if the assessment failed. + errorCode: + $ref: "#/components/schemas/AssessmentErrorCode" + description: The error code if the assessment failed. + assessmentCost: + $ref: "#/components/schemas/AssessmentCost" + description: The cost of the assessment. + billableAssessmentUnitCount: + $ref: "#/components/schemas/Integer" + description: The number of billable assessment units consumed by the assessment. + achievability: + $ref: "#/components/schemas/Achievability" + description: The achievability results from the assessment. + required: + - assessmentId + - serviceArn + AssessmentStep: + type: string + enum: + - TOPOLOGY_GENERATION + - INPUT_VALIDATION + - DESIGN_ANALYSIS + - TOPOLOGY_ENHANCEMENT + - SERVICE_FUNCTION_GENERATION + - POLICY_VALIDATION + - RESILIENCE_ASSESSMENT + - FAILURE_MODE_FINDINGS_CONSOLIDATION + - FAILURE_MODE_FINDINGS_ENRICHMENT + AssessmentErrorCode: + type: string + enum: + - INVALID_PERMISSIONS + - CMK_ACCESS_DENIED + - AGENT_ERROR + - INTERNAL_ERROR + - DESIGN_FILE_ACCESS_DENIED + ListFailureModeFindingsResponse: + type: object + properties: + findingsSummary: + $ref: "#/components/schemas/FindingsList" + description: The list of finding summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - findingsSummary + FindingsList: + type: array + items: + $ref: "#/components/schemas/FindingSummary" + FindingSummary: + description: Contains summary information about a finding. + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + findingId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the finding. + name: + $ref: "#/components/schemas/String" + description: The name of the finding. + description: + $ref: "#/components/schemas/EntityDescription" + failureCategory: + $ref: "#/components/schemas/FailureCategory" + description: The failure category of the finding. + severity: + $ref: "#/components/schemas/FindingSeverity" + description: The severity of the finding. + status: + $ref: "#/components/schemas/FindingStatus" + description: The current status of the finding. + policyComponent: + $ref: "#/components/schemas/PolicyComponent" + description: The policy component associated with the finding. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the finding was last updated. + InputSourceType: + type: string + enum: + - CFN_STACK + - TAGS + - EKS + - TERRAFORM + - DESIGN_FILE + - MONITORING + ListInputSourcesResponse: + type: object + properties: + inputSourceSummaries: + $ref: "#/components/schemas/InputSourceSummaryList" + description: The list of input source summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - inputSourceSummaries + InputSourceSummaryList: + type: array + items: + $ref: "#/components/schemas/InputSourceSummary" + InputSourceSummary: + description: Contains summary information about an input source for a service. + type: object + properties: + inputSourceId: + $ref: "#/components/schemas/InputSourceId" + description: The unique identifier of the input source. + type_: + $ref: "#/components/schemas/InputSourceType" + description: The type of the input source. + resourceTags: + $ref: "#/components/schemas/ResourceTagList" + description: The resource tags used for discovery, if this input source uses tags. + cfnStackArn: + $ref: "#/components/schemas/Arn" + tfStateFileUrl: + $ref: "#/components/schemas/S3Url" + eks: + $ref: "#/components/schemas/EksSource" + description: The Amazon EKS configuration, if this input source uses EKS. + designFileS3Url: + $ref: "#/components/schemas/S3Url" + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the input source was created. + required: + - inputSourceId + ListPoliciesResponse: + type: object + properties: + policySummaries: + $ref: "#/components/schemas/PolicySummaryList" + description: The list of policy summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - policySummaries + PolicySummaryList: + type: array + items: + $ref: "#/components/schemas/PolicySummary" + PolicySummary: + description: Contains summary information about a resilience policy. + type: object + properties: + policyArn: + $ref: "#/components/schemas/Arn" + name: + $ref: "#/components/schemas/EntityName" + availabilitySlo: + $ref: "#/components/schemas/AvailabilitySlo" + description: The availability SLO defined in the policy. + multiAz: + $ref: "#/components/schemas/MultiAzTargets" + description: The multi-AZ disaster recovery targets defined in the policy. + multiRegion: + $ref: "#/components/schemas/MultiRegionTargets" + description: The multi-Region disaster recovery targets defined in the policy. + dataRecovery: + $ref: "#/components/schemas/DataRecoveryTargets" + description: The data recovery targets defined in the policy. + associatedServiceCount: + $ref: "#/components/schemas/Integer" + description: The number of services associated with this policy. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the policy was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the policy was last updated. + required: + - policyArn + - name + ListReportsResponse: + type: object + properties: + reportGenerationResults: + $ref: "#/components/schemas/ReportGenerationResultList" + description: The list of report generation results. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - reportGenerationResults + ReportGenerationResultList: + type: array + items: + $ref: "#/components/schemas/ReportGenerationResult" + ListResolvedTestRunTargetResourcesResponse: + type: object + properties: + resolvedTargetResources: + $ref: "#/components/schemas/ResolvedTargetResourceList" + description: The list of resolved target resources. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - resolvedTargetResources + ResolvedTargetResourceList: + type: array + items: + $ref: "#/components/schemas/ResolvedTargetResource" + ResolvedTargetResource: + description: A single AWS resource that AWS Fault Injection Service (AWS FIS) resolved as a target during a test run. + type: object + properties: + resourceType: + $ref: "#/components/schemas/ResolvedTargetResourceResourceTypeString" + description: The AWS FIS resource type the target belongs to, such as aws:ec2:instance, aws:ecs:task, or aws:eks:pod. + targetName: + $ref: "#/components/schemas/ResolvedTargetResourceTargetNameString" + description: The name of the target in the AWS FIS experiment template. + targetInformation: + type: object + properties: {} + description: The raw target information map as returned by AWS FIS. + required: + - resourceType + - targetName + - targetInformation + ResolvedTargetResourceResourceTypeString: + type: string + minLength: 1 + maxLength: 256 + ResolvedTargetResourceTargetNameString: + type: string + minLength: 1 + maxLength: 256 + ResourceTypeFilterList: + type: array + items: + $ref: "#/components/schemas/ResourceTypeFilter" + ResourceTypeFilter: + type: string + minLength: 1 + maxLength: 256 + ListResourcesResponse: + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/EntityId" + description: The service function identifier for the returned resources. + serviceResources: + $ref: "#/components/schemas/ServiceResourceList" + description: The list of service resources. + nextToken: + $ref: "#/components/schemas/NextToken" + ServiceResourceList: + type: array + items: + $ref: "#/components/schemas/ServiceResource" + ServiceResource: + description: Represents a resource associated with a service. + type: object + properties: + resourceIdentifier: + $ref: "#/components/schemas/String" + description: The identifier of the resource. + inputSource: + $ref: "#/components/schemas/InputSource" + description: The input source that discovered the resource. + resource: + $ref: "#/components/schemas/Resource" + description: The resource details. + required: + - resourceIdentifier + - resource + InputSource: + description: Identifies an input source by its identifier and type. + type: object + properties: + identifier: + $ref: "#/components/schemas/String" + description: The identifier of the input source. + type_: + $ref: "#/components/schemas/InputSourceType" + description: The type of the input source. + required: + - identifier + - type_ + Resource: + description: Represents an AWS resource discovered by Resilience Hub. + type: object + properties: + identifier: + $ref: "#/components/schemas/String" + description: The identifier of the resource. + awsRegion: + $ref: "#/components/schemas/AwsRegion" + description: The AWS Region where the resource is located. + awsAccountId: + $ref: "#/components/schemas/AwsAccountId" + description: The AWS account ID that owns the resource. + resourceType: + $ref: "#/components/schemas/String" + description: The type of the resource. + required: + - identifier + ServiceEventTypeList: + type: array + items: + $ref: "#/components/schemas/ServiceEventType" + ServiceEventType: + type: string + enum: + - SERVICE_CREATED + - SERVICE_DELETED + - SERVICE_SYSTEM_ASSOCIATED + - SERVICE_SYSTEM_DISASSOCIATED + - SERVICE_RESOURCES_ASSOCIATED + - SERVICE_RESOURCES_DISASSOCIATED + - SERVICE_WORKFLOW_UPDATED + - SERVICE_INPUT_SOURCES_UPDATED + - SERVICE_POLICY_ASSOCIATED + - SERVICE_POLICY_DISASSOCIATED + - SERVICE_FUNCTION_CREATED + - SERVICE_FUNCTION_UPDATED + - SERVICE_FUNCTION_DELETED + - SERVICE_FUNCTION_RESOURCES_ADDED + - SERVICE_FUNCTION_RESOURCES_REMOVED + - SERVICE_ACHIEVABILITY_UPDATED + - ASSERTION_CREATED + - ASSERTION_UPDATED + - ASSERTION_DELETED + ListServiceEventsResponse: + type: object + properties: + events: + $ref: "#/components/schemas/ServiceEventList" + description: The list of service events. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - events + ServiceEventList: + type: array + items: + $ref: "#/components/schemas/ServiceEvent" + ServiceEvent: + description: Represents an event in the service event log. + type: object + properties: + eventId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the event. + timestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the event. + eventType: + $ref: "#/components/schemas/ServiceEventType" + description: The type of the event. + serviceArn: + $ref: "#/components/schemas/Arn" + actor: + $ref: "#/components/schemas/EventActor" + description: The actor that triggered the event. + eventDetails: + $ref: "#/components/schemas/ServiceEventDetails" + description: The details of the event. + required: + - eventId + - timestamp + - eventType + - serviceArn + - actor + - eventDetails + EventActor: + description: Identifies the actor that triggered an event. + type: object + properties: + type_: + $ref: "#/components/schemas/ActorType" + description: The type of actor, either USER or SYSTEM. + principalId: + $ref: "#/components/schemas/String" + description: The principal ID of the actor. + accountId: + $ref: "#/components/schemas/String" + description: The AWS account ID of the actor. + userName: + $ref: "#/components/schemas/String" + description: The user name of the actor. + required: + - type_ + - principalId + ActorType: + type: string + enum: + - USER + - SYSTEM + ServiceEventDetails: + description: Contains the details of a service event. + type: object + properties: + title_: + $ref: "#/components/schemas/String" + description: The title of the event. + description: + $ref: "#/components/schemas/String" + description: The description of the event. + eventMetadata: + $ref: "#/components/schemas/ServiceEventMetadata" + required: + - title_ + - description + ServiceEventMetadata: + description: Type-specific metadata for each service event type. + type: object + properties: + serviceCreated: + $ref: "#/components/schemas/ServiceCreatedMetadata" + description: Metadata for a service created event. + serviceDeleted: + $ref: "#/components/schemas/ServiceDeletedMetadata" + description: Metadata for a service deleted event. + serviceSystemAssociated: + $ref: "#/components/schemas/ServiceSystemAssociatedMetadata" + description: Metadata for a service system associated event. + serviceSystemDisassociated: + $ref: "#/components/schemas/ServiceSystemDisassociatedMetadata" + description: Metadata for a service system disassociated event. + serviceResourcesAssociated: + $ref: "#/components/schemas/ServiceResourcesAssociatedMetadata" + description: Metadata for a service resources associated event. + serviceResourcesDisassociated: + $ref: "#/components/schemas/ServiceResourcesDisassociatedMetadata" + description: Metadata for a service resources disassociated event. + serviceWorkflowUpdated: + $ref: "#/components/schemas/ServiceWorkflowUpdatedMetadata" + description: Metadata for a service workflow updated event. + serviceInputSourcesUpdated: + $ref: "#/components/schemas/ServiceInputSourcesUpdatedMetadata" + description: Metadata for a service input sources updated event. + servicePolicyAssociated: + $ref: "#/components/schemas/ServicePolicyAssociatedMetadata" + description: Metadata for a service policy associated event. + servicePolicyDisassociated: + $ref: "#/components/schemas/ServicePolicyDisassociatedMetadata" + description: Metadata for a service policy disassociated event. + serviceFunctionCreated: + $ref: "#/components/schemas/ServiceFunctionCreatedMetadata" + description: Metadata for a service function created event. + serviceFunctionUpdated: + $ref: "#/components/schemas/ServiceFunctionUpdatedMetadata" + description: Metadata for a service function updated event. + serviceFunctionDeleted: + $ref: "#/components/schemas/ServiceFunctionDeletedMetadata" + description: Metadata for a service function deleted event. + serviceFunctionResourcesAdded: + $ref: "#/components/schemas/ServiceFunctionResourcesAddedMetadata" + description: Metadata for a service function resources added event. + serviceFunctionResourcesRemoved: + $ref: "#/components/schemas/ServiceFunctionResourcesRemovedMetadata" + description: Metadata for a service function resources removed event. + serviceAchievabilityUpdated: + $ref: "#/components/schemas/ServiceAchievabilityUpdatedMetadata" + description: Metadata for a service achievability updated event. + assertionCreated: + $ref: "#/components/schemas/AssertionCreatedMetadata" + description: Metadata for an assertion created event. + assertionUpdated: + $ref: "#/components/schemas/AssertionUpdatedMetadata" + description: Metadata for an assertion updated event. + assertionDeleted: + $ref: "#/components/schemas/AssertionDeletedMetadata" + description: Metadata for an assertion deleted event. + ServiceCreatedMetadata: + description: Metadata for a service created event. + type: object + ServiceDeletedMetadata: + description: Metadata for a service deleted event. + type: object + ServiceSystemAssociatedMetadata: + description: Metadata for a service system associated event. + type: object + properties: + systemName: + $ref: "#/components/schemas/String" + description: The name of the associated system. + systemArn: + $ref: "#/components/schemas/Arn" + ServiceSystemDisassociatedMetadata: + description: Metadata for a service system disassociated event. + type: object + properties: + systemId: + $ref: "#/components/schemas/String" + description: The identifier of the disassociated system. + systemName: + $ref: "#/components/schemas/String" + description: The name of the disassociated system. + systemArn: + $ref: "#/components/schemas/Arn" + ServiceResourcesAssociatedMetadata: + description: Metadata for a service resources associated event. + type: object + properties: + resourceCount: + $ref: "#/components/schemas/Integer" + description: The number of resources associated. + resourceTypes: + $ref: "#/components/schemas/ResourceTypeList" + description: The types of resources associated. + ResourceTypeList: + type: array + items: + $ref: "#/components/schemas/String" + ServiceResourcesDisassociatedMetadata: + description: Metadata for a service resources disassociated event. + type: object + properties: + resourceCount: + $ref: "#/components/schemas/Integer" + description: The number of resources disassociated. + resourceTypes: + $ref: "#/components/schemas/ResourceTypeList" + description: The types of resources disassociated. + ServiceWorkflowUpdatedMetadata: + description: Metadata for a service workflow updated event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the service function. + ServiceInputSourcesUpdatedMetadata: + description: Metadata for a service input sources updated event. + type: object + ServicePolicyAssociatedMetadata: + description: Metadata for a service policy associated event. + type: object + properties: + policyName: + $ref: "#/components/schemas/String" + description: The name of the associated policy. + policyArn: + $ref: "#/components/schemas/Arn" + ServicePolicyDisassociatedMetadata: + description: Metadata for a service policy disassociated event. + type: object + properties: + policyName: + $ref: "#/components/schemas/String" + description: The name of the disassociated policy. + policyArn: + $ref: "#/components/schemas/Arn" + ServiceFunctionCreatedMetadata: + description: Metadata for a service function created event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the created service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the created service function. + ServiceFunctionUpdatedMetadata: + description: Metadata for a service function updated event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the service function. + resourcesAdded: + $ref: "#/components/schemas/ArnList" + description: The list of resource ARNs that were added. + resourcesRemoved: + $ref: "#/components/schemas/ArnList" + description: The list of resource ARNs that were removed. + ArnList: + type: array + items: + $ref: "#/components/schemas/Arn" + ServiceFunctionDeletedMetadata: + description: Metadata for a service function deleted event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the deleted service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the deleted service function. + ServiceFunctionResourcesAddedMetadata: + description: Metadata for a service function resources added event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the service function. + resourcesAdded: + $ref: "#/components/schemas/ArnList" + description: The list of resource ARNs that were added. + ServiceFunctionResourcesRemovedMetadata: + description: Metadata for a service function resources removed event. + type: object + properties: + serviceFunctionId: + $ref: "#/components/schemas/String" + description: The identifier of the service function. + serviceFunctionName: + $ref: "#/components/schemas/String" + description: The name of the service function. + resourcesRemoved: + $ref: "#/components/schemas/ArnList" + description: The list of resource ARNs that were removed. + ServiceAchievabilityUpdatedMetadata: + description: Metadata for a service achievability updated event. + type: object + properties: + assessmentId: + $ref: "#/components/schemas/String" + description: The assessment identifier that triggered the update. + availabilitySlo: + $ref: "#/components/schemas/String" + description: The updated achievability status of the availability SLO. + multiAzRtoRpo: + $ref: "#/components/schemas/String" + description: The updated achievability status of the multi-AZ RTO and RPO targets. + multiRegionRtoRpo: + $ref: "#/components/schemas/String" + description: The updated achievability status of the multi-Region RTO and RPO targets. + AssertionCreatedMetadata: + description: Metadata for an assertion created event. + type: object + properties: + assertionId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created assertion. + assertionName: + $ref: "#/components/schemas/String" + description: The name of the created assertion. + AssertionUpdatedMetadata: + description: Metadata for an assertion updated event. + type: object + properties: + assertionId: + $ref: "#/components/schemas/String" + description: The unique identifier of the updated assertion. + assertionName: + $ref: "#/components/schemas/String" + description: The name of the updated assertion. + AssertionDeletedMetadata: + description: Metadata for an assertion deleted event. + type: object + properties: + assertionId: + $ref: "#/components/schemas/String" + description: The unique identifier of the deleted assertion. + assertionName: + $ref: "#/components/schemas/String" + description: The name of the deleted assertion. + ListServiceFunctionsResponse: + type: object + properties: + serviceFunctions: + $ref: "#/components/schemas/ServiceFunctionList" + description: The list of service functions. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - serviceFunctions + ServiceFunctionList: + type: array + items: + $ref: "#/components/schemas/ServiceFunction" + ListServiceTopologyEdgesResponse: + type: object + properties: + serviceTopologyEdgeSummaries: + $ref: "#/components/schemas/ServiceTopologyEdgeSummaryList" + description: The list of service topology edge summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + ServiceTopologyEdgeSummaryList: + type: array + items: + $ref: "#/components/schemas/ServiceTopologyEdgeSummary" + ServiceTopologyEdgeSummary: + description: Contains summary information about a service topology edge. + type: object + properties: + sourceResourceIdentifier: + $ref: "#/components/schemas/String" + description: The identifier of the source resource. + destinationResourceIdentifier: + $ref: "#/components/schemas/String" + description: The identifier of the destination resource. + sourceRegion: + $ref: "#/components/schemas/AwsRegion" + description: The AWS Region of the source resource. + destinationRegion: + $ref: "#/components/schemas/AwsRegion" + description: The AWS Region of the destination resource. + sourceAccount: + $ref: "#/components/schemas/AwsAccountId" + description: The AWS account ID of the source resource. + destinationAccount: + $ref: "#/components/schemas/AwsAccountId" + description: The AWS account ID of the destination resource. + properties_: + $ref: "#/components/schemas/EdgePropertyList" + description: The properties of the topology edge. + required: + - sourceResourceIdentifier + - destinationResourceIdentifier + EdgePropertyList: + type: array + items: + $ref: "#/components/schemas/EdgePropertySummary" + EdgePropertySummary: + description: Contains property information for a service topology edge. + type: object + properties: + topologyType: + $ref: "#/components/schemas/TopologyType" + description: The topology type of the edge. + label: + $ref: "#/components/schemas/String" + description: Human-readable relationship description. Only present for LLM-inferred edges. + TopologyType: + type: string + enum: + - CONTAINMENT + - DATA_FLOW + - OBSERVABILITY + - PERMISSIONS + ListServicesResponse: + type: object + properties: + serviceSummaries: + $ref: "#/components/schemas/ServiceSummaryList" + description: The list of service summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - serviceSummaries + ServiceSummaryList: + type: array + items: + $ref: "#/components/schemas/ServiceSummary" + ServiceSummary: + description: Contains summary information about a service. + type: object + properties: + serviceArn: + $ref: "#/components/schemas/Arn" + name: + $ref: "#/components/schemas/EntityName" + associatedSystems: + $ref: "#/components/schemas/AssociatedSystemList" + description: The systems associated with the service. + regions: + $ref: "#/components/schemas/RegionList" + description: The Regions where the service operates. + policyArn: + $ref: "#/components/schemas/Arn" + assessmentStatus: + $ref: "#/components/schemas/AssessmentStatus" + description: The current assessment status of the service. + openFindingsCount: + $ref: "#/components/schemas/Integer" + description: The number of open findings. + resolvedFindingsCount: + $ref: "#/components/schemas/Integer" + description: The number of resolved findings. + dependencyDiscovery: + $ref: "#/components/schemas/DependencyDiscoveryConfig" + description: The dependency discovery configuration. + achievability: + $ref: "#/components/schemas/Achievability" + description: The achievability status of the service's resilience targets. + organizationId: + $ref: "#/components/schemas/OrganizationId" + description: Displayed only if caller has access. + ouId: + $ref: "#/components/schemas/OuId" + description: Displayed only if caller has access. + accountId: + $ref: "#/components/schemas/AccountId" + description: Displayed only if caller has access. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the service was last updated. + required: + - serviceArn + - name + SystemEventTypeList: + type: array + items: + $ref: "#/components/schemas/SystemEventType" + SystemEventType: + type: string + enum: + - SYSTEM_CREATED + - SYSTEM_DELETED + - SYSTEM_USER_JOURNEY_CREATED + - SYSTEM_USER_JOURNEY_UPDATED + - SYSTEM_USER_JOURNEY_DELETED + - SYSTEM_SERVICE_ASSOCIATED + - SYSTEM_SERVICE_DISASSOCIATED + - SYSTEM_POLICY_ASSOCIATED + - SYSTEM_POLICY_DISASSOCIATED + ListSystemEventsResponse: + type: object + properties: + events: + $ref: "#/components/schemas/SystemEventList" + description: The list of system events. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - events + SystemEventList: + type: array + items: + $ref: "#/components/schemas/SystemEvent" + SystemEvent: + description: Represents an event in the system event log. + type: object + properties: + eventId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the event. + timestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the event. + eventType: + $ref: "#/components/schemas/SystemEventType" + description: The type of the event. + systemArn: + $ref: "#/components/schemas/Arn" + actor: + $ref: "#/components/schemas/EventActor" + description: The actor that triggered the event. + eventDetails: + $ref: "#/components/schemas/SystemEventDetails" + description: The details of the event. + required: + - eventId + - timestamp + - eventType + - systemArn + - actor + - eventDetails + SystemEventDetails: + description: Contains the details of a system event. + type: object + properties: + title_: + $ref: "#/components/schemas/String" + description: The title of the event. + description: + $ref: "#/components/schemas/String" + description: The description of the event. + eventMetadata: + $ref: "#/components/schemas/SystemEventMetadata" + required: + - title_ + - description + SystemEventMetadata: + description: Type-specific metadata for each system event type. + type: object + properties: + systemCreated: + $ref: "#/components/schemas/SystemCreatedMetadata" + description: Metadata for a system created event. + systemDeleted: + $ref: "#/components/schemas/SystemDeletedMetadata" + description: Metadata for a system deleted event. + systemUserJourneyCreated: + $ref: "#/components/schemas/SystemUserJourneyCreatedMetadata" + description: Metadata for a system user journey created event. + systemUserJourneyUpdated: + $ref: "#/components/schemas/SystemUserJourneyUpdatedMetadata" + description: Metadata for a system user journey updated event. + systemUserJourneyDeleted: + $ref: "#/components/schemas/SystemUserJourneyDeletedMetadata" + description: Metadata for a system user journey deleted event. + systemServiceAssociated: + $ref: "#/components/schemas/SystemServiceAssociatedMetadata" + description: Metadata for a system service associated event. + systemServiceDisassociated: + $ref: "#/components/schemas/SystemServiceDisassociatedMetadata" + description: Metadata for a system service disassociated event. + systemPolicyAssociated: + $ref: "#/components/schemas/SystemPolicyAssociatedMetadata" + description: Metadata for a system policy associated event. + systemPolicyDisassociated: + $ref: "#/components/schemas/SystemPolicyDisassociatedMetadata" + description: Metadata for a system policy disassociated event. + SystemCreatedMetadata: + description: Metadata for a system created event. + type: object + SystemDeletedMetadata: + description: Metadata for a system deleted event. + type: object + SystemUserJourneyCreatedMetadata: + description: Metadata for a system user journey created event. + type: object + properties: + userJourneyName: + $ref: "#/components/schemas/String" + description: The name of the created user journey. + associatedServices: + $ref: "#/components/schemas/ServiceReferenceList" + description: The services associated with the created user journey. + ServiceReferenceList: + type: array + items: + $ref: "#/components/schemas/ServiceReference" + ServiceReference: + description: A reference to a service by ID and name. + type: object + properties: + serviceId: + $ref: "#/components/schemas/String" + description: The identifier of the referenced service. + serviceName: + $ref: "#/components/schemas/String" + description: The name of the referenced service. + SystemUserJourneyUpdatedMetadata: + description: Metadata for a system user journey updated event. + type: object + properties: + userJourneyName: + $ref: "#/components/schemas/String" + description: The name of the updated user journey. + changes: + $ref: "#/components/schemas/UserJourneyChanges" + description: The changes made to the user journey. + UserJourneyChanges: + description: Describes changes made to a user journey. + type: object + properties: + journeyDescription: + $ref: "#/components/schemas/StringChange" + description: Changes to the user journey description. + associatedServices: + $ref: "#/components/schemas/ServiceReferenceChanges" + description: Changes to the services associated with the user journey. + StringChange: + description: Describes a change from one string value to another. + type: object + properties: + oldValue: + $ref: "#/components/schemas/String" + description: The old value. + newValue: + $ref: "#/components/schemas/String" + description: The new value. + ServiceReferenceChanges: + description: Describes changes to service references. + type: object + properties: + added: + $ref: "#/components/schemas/ServiceReferenceList" + description: The list of service references that were added. + removed: + $ref: "#/components/schemas/ServiceReferenceList" + description: The list of service references that were removed. + SystemUserJourneyDeletedMetadata: + description: Metadata for a system user journey deleted event. + type: object + properties: + userJourneyName: + $ref: "#/components/schemas/String" + description: The name of the deleted user journey. + associatedServicesAtDeletion: + $ref: "#/components/schemas/ServiceReferenceList" + description: The services that were associated at the time of deletion. + SystemServiceAssociatedMetadata: + description: Metadata for a system service associated event. + type: object + properties: + serviceName: + $ref: "#/components/schemas/String" + description: The name of the associated service. + serviceArn: + $ref: "#/components/schemas/Arn" + userJourneys: + $ref: "#/components/schemas/UserJourneyNameList" + description: The user journeys linking the service to the system. + UserJourneyNameList: + type: array + items: + $ref: "#/components/schemas/String" + SystemServiceDisassociatedMetadata: + description: Metadata for a system service disassociated event. + type: object + properties: + serviceName: + $ref: "#/components/schemas/String" + description: The name of the disassociated service. + serviceArn: + $ref: "#/components/schemas/Arn" + userJourneysAffected: + $ref: "#/components/schemas/UserJourneyNameList" + description: The user journeys affected by the disassociation. + comment: + $ref: "#/components/schemas/String" + description: A comment about the disassociation. + SystemPolicyAssociatedMetadata: + description: Metadata for a system policy associated event. + type: object + properties: + policyName: + $ref: "#/components/schemas/String" + description: The name of the associated policy. + policyArn: + $ref: "#/components/schemas/Arn" + SystemPolicyDisassociatedMetadata: + description: Metadata for a system policy disassociated event. + type: object + properties: + policyName: + $ref: "#/components/schemas/String" + description: The name of the disassociated policy. + policyArn: + $ref: "#/components/schemas/Arn" + ListSystemsResponse: + type: object + properties: + systemSummaries: + $ref: "#/components/schemas/SystemSummaryList" + description: The list of system summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - systemSummaries + SystemSummaryList: + type: array + items: + $ref: "#/components/schemas/SystemSummary" + SystemSummary: + description: Contains summary information about a system. + type: object + properties: + systemId: + $ref: "#/components/schemas/SystemId" + name: + $ref: "#/components/schemas/EntityName" + systemArn: + $ref: "#/components/schemas/Arn" + userJourneysCount: + $ref: "#/components/schemas/Integer" + description: The number of user journeys in the system. + servicesCount: + $ref: "#/components/schemas/Integer" + description: The number of services in the system. + organizationId: + $ref: "#/components/schemas/OrganizationId" + description: Displayed only if caller has access. + ouId: + $ref: "#/components/schemas/OuId" + description: Displayed only if caller has access. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the system was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the system was last updated. + required: + - systemId + - name + ListTagsForResourceResponse: + type: object + properties: + tags: + type: object + properties: {} + ListTestRunEventsResponse: + type: object + properties: + events: + $ref: "#/components/schemas/TestRunEventList" + description: The list of test run events. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - events + TestRunEventList: + type: array + items: + $ref: "#/components/schemas/TestRunEvent" + TestRunEvent: + description: A single event in a test run's timeline. + type: object + properties: + eventId: + $ref: "#/components/schemas/TestRunEventEventIdString" + description: The unique identifier of the event. + eventType: + $ref: "#/components/schemas/TestRunEventEventTypeString" + description: The type of the event, such as action_started, action_completed, or rto_recovery_detected. + message: + $ref: "#/components/schemas/TestRunEventMessageString" + description: A human-readable description of what happened. + timestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the event occurred. + attributes: + type: object + properties: {} + description: Machine-parseable key-value attributes for the event. + required: + - eventId + - eventType + - message + - timestamp + TestRunEventEventIdString: + type: string + minLength: 1 + maxLength: 64 + TestRunEventEventTypeString: + type: string + minLength: 1 + maxLength: 256 + TestRunEventMessageString: + type: string + minLength: 1 + maxLength: 2048 + TestRunSourceType: + description: The type of a test run monitoring-source snapshot. + type: string + enum: + - SUCCESS_CRITERIA + - OBSERVABILITY + ListTestRunSourcesResponse: + type: object + properties: + testRunSources: + $ref: "#/components/schemas/TestRunSourceSummaryList" + description: The list of monitoring source snapshots. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - testRunSources + TestRunSourceSummaryList: + type: array + items: + $ref: "#/components/schemas/TestRunSourceSummary" + TestRunSourceSummary: + description: A monitoring-source snapshot captured for a test run. Exactly one member is set. + type: object + properties: + successCriteriaAlarm: + $ref: "#/components/schemas/TestRunSuccessCriteriaAlarmSummary" + description: A success criteria alarm snapshot captured for the test run. + observabilityAlarm: + $ref: "#/components/schemas/TestRunObservabilityAlarmSummary" + description: An observability alarm snapshot captured for the test run. + TestRunSuccessCriteriaAlarmSummary: + description: Summary information about a success criteria alarm snapshot captured for a test run. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + alarmName: + $ref: "#/components/schemas/String" + description: The name of the CloudWatch alarm. + region: + $ref: "#/components/schemas/String" + description: The Region of the CloudWatch alarm. + accountId: + $ref: "#/components/schemas/String" + description: The account ID that owns the CloudWatch alarm. + outcome: + $ref: "#/components/schemas/TestSourceOutcome" + description: The evaluation outcome of the source. Absent while the source has not yet been evaluated; set to the terminal outcome afterwards. + outcomeReason: + $ref: "#/components/schemas/String" + description: A human-readable reason for the outcome. + required: + - alarmArn + - alarmName + - region + - accountId + TestSourceOutcome: + description: The evaluation outcome of a test run success criteria source. + type: string + enum: + - PASSED + - FAILED + - ERROR + TestRunObservabilityAlarmSummary: + description: Summary information about an observability alarm snapshot captured for a test run. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + alarmName: + $ref: "#/components/schemas/String" + description: The name of the CloudWatch alarm. + region: + $ref: "#/components/schemas/String" + description: The Region of the CloudWatch alarm. + accountId: + $ref: "#/components/schemas/String" + description: The account ID that owns the CloudWatch alarm. + required: + - alarmArn + - alarmName + - region + - accountId + ListTestRunsResponse: + type: object + properties: + testRuns: + $ref: "#/components/schemas/TestRunSummaryList" + description: The list of test run summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - testRuns + TestRunSummaryList: + type: array + items: + $ref: "#/components/schemas/TestRunSummary" + TestRunSummary: + description: Contains summary information about a test run. + type: object + properties: + testRunId: + $ref: "#/components/schemas/TestRunId" + description: The unique identifier of the test run. + status: + $ref: "#/components/schemas/TestRunStatus" + description: The current status of the test run. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test run started. + endedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test run ended. + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template the test run was based on. + serviceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test run belongs to. + errorMessage: + $ref: "#/components/schemas/String" + description: A human-readable reason for test run failure. Only present when the status is FAILED or ERROR. + accountTargeting: + $ref: "#/components/schemas/AccountTargeting" + description: Indicates whether this test run targets a single account or multiple accounts. + required: + - testRunId + - status + - startedAt + - testTemplateArn + TestSourceType: + description: The purpose of a test monitoring source. + type: string + enum: + - SUCCESS_CRITERIA + - OBSERVABILITY + ListTestSourcesResponse: + type: object + properties: + testSources: + $ref: "#/components/schemas/TestSourceSummaryList" + description: The list of configured monitoring sources. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - testSources + TestSourceSummaryList: + type: array + items: + $ref: "#/components/schemas/TestSourceSummary" + TestSourceSummary: + description: A configured monitoring source returned by ListTestSources. Exactly one member is set. + type: object + properties: + successCriteriaAlarm: + $ref: "#/components/schemas/SuccessCriteriaAlarmSummary" + description: A configured success criteria alarm. + observabilityAlarm: + $ref: "#/components/schemas/ObservabilityAlarmSummary" + description: A configured observability alarm. + SuccessCriteriaAlarmSummary: + description: Summary information about a configured success criteria alarm. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + alarmName: + $ref: "#/components/schemas/String" + description: The name of the CloudWatch alarm. + region: + $ref: "#/components/schemas/String" + description: The Region of the CloudWatch alarm. + accountId: + $ref: "#/components/schemas/String" + description: The account ID that owns the CloudWatch alarm. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the source was configured. + required: + - alarmArn + - alarmName + - region + - accountId + ObservabilityAlarmSummary: + description: Summary information about a configured observability alarm. + type: object + properties: + alarmArn: + $ref: "#/components/schemas/CloudWatchAlarmArn" + description: The ARN of the CloudWatch alarm. + alarmName: + $ref: "#/components/schemas/String" + description: The name of the CloudWatch alarm. + region: + $ref: "#/components/schemas/String" + description: The Region of the CloudWatch alarm. + accountId: + $ref: "#/components/schemas/String" + description: The account ID that owns the CloudWatch alarm. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the source was configured. + required: + - alarmArn + - alarmName + - region + - accountId + ListTestTemplatesResponse: + type: object + properties: + testTemplates: + $ref: "#/components/schemas/TestTemplateSummaryList" + description: The list of test template summaries. + required: + - testTemplates + TestTemplateSummaryList: + type: array + items: + $ref: "#/components/schemas/TestTemplateSummary" + TestTemplateSummary: + description: Contains summary information about a test template. + type: object + properties: + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template. + name: + $ref: "#/components/schemas/String" + description: The name of the test template. + description: + $ref: "#/components/schemas/String" + description: A description of the test template. + required: + - testTemplateArn + - name + - description + ListTestsResponse: + type: object + properties: + tests: + $ref: "#/components/schemas/TestSummaryList" + description: The list of test summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - tests + TestSummaryList: + type: array + items: + $ref: "#/components/schemas/TestSummary" + TestSummary: + description: Contains summary information about a test. + type: object + properties: + testId: + $ref: "#/components/schemas/TestId" + description: The unique identifier of the test. + testTemplateArn: + $ref: "#/components/schemas/ServiceOwnedArn" + description: The ARN of the test template the test was created from. + serviceArn: + $ref: "#/components/schemas/Arn" + description: The ARN of the service the test belongs to. + totalTestRuns: + $ref: "#/components/schemas/Integer" + description: The total number of runs of the test. + successfulTestRuns: + $ref: "#/components/schemas/Integer" + description: The number of successful runs of the test. + creationTime: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the test was created. + required: + - testId + - testTemplateArn + - serviceArn + - totalTestRuns + - successfulTestRuns + - creationTime + ListUserJourneysResponse: + type: object + properties: + userJourneySummaries: + $ref: "#/components/schemas/UserJourneySummaryList" + description: The list of user journey summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - userJourneySummaries + UserJourneySummaryList: + type: array + items: + $ref: "#/components/schemas/UserJourneySummary" + UserJourneySummary: + description: Contains summary information about a user journey. + type: object + properties: + userJourneyId: + $ref: "#/components/schemas/UserJourneyId" + description: The unique identifier of the user journey. + name: + $ref: "#/components/schemas/EntityLabel" + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the user journey was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the user journey was last updated. + required: + - userJourneyId + - name + PutTestSourcesResponse: + type: object + StartFailureModeAssessmentResponse: + type: object + properties: + assessmentId: + $ref: "#/components/schemas/Uuid" + description: The unique identifier of the started assessment. + serviceArn: + $ref: "#/components/schemas/Arn" + assessmentStatus: + $ref: "#/components/schemas/AssessmentStatus" + description: The status of the started assessment. + startedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the assessment started. + StartTestRunResponse: + type: object + properties: + testRunId: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the started test run. + status: + $ref: "#/components/schemas/TestRunStatus" + description: The status of the started test run. + experimentArns: + $ref: "#/components/schemas/ExperimentArnList" + description: The ARNs of the AWS Fault Injection Service (AWS FIS) experiments started for the run. + required: + - testRunId + - status + - experimentArns + ExperimentArnList: + type: array + items: + $ref: "#/components/schemas/Arn" + StopTestRunResponse: + type: object + properties: + testRunId: + $ref: "#/components/schemas/TestRunId" + description: The identifier of the stopped test run. + status: + $ref: "#/components/schemas/TestRunStatus" + description: The status of the test run. + required: + - testRunId + - status + TagResourceResponse: + type: object + TagKeyList: + type: array + items: + $ref: "#/components/schemas/TagKey" + UntagResourceResponse: + type: object + UpdateAssertionResponse: + type: object + properties: + assertion: + $ref: "#/components/schemas/Assertion" + description: The updated assertion. + required: + - assertion + UpdateDependencyResponse: + type: object + properties: + dependencyId: + $ref: "#/components/schemas/Uuid" + description: The identifier of the updated dependency. + dependencyName: + $ref: "#/components/schemas/String" + description: The name of the updated dependency. + location: + $ref: "#/components/schemas/String" + description: The location of the dependency. + criticality: + $ref: "#/components/schemas/DependencyCriticality" + description: The criticality level of the dependency. + comment: + $ref: "#/components/schemas/String" + description: The comment about the dependency. + provider: + $ref: "#/components/schemas/String" + description: The provider of the dependency. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the dependency was updated. + required: + - dependencyId + - dependencyName + - location + - criticality + - updatedAt + UpdateFailureModeFindingRequestCommentString: + type: string + minLength: 0 + maxLength: 2048 + UpdateFailureModeFindingResponse: + type: object + properties: + finding: + $ref: "#/components/schemas/Finding" + description: The updated finding. + UpdatePolicyResponse: + type: object + properties: + policy: + $ref: "#/components/schemas/Policy" + description: The updated policy. + required: + - policy + UpdateServiceResponse: + type: object + properties: + service: + $ref: "#/components/schemas/Service" + description: The updated service. + required: + - service + UpdateServiceFunctionResponse: + type: object + properties: + serviceFunction: + $ref: "#/components/schemas/ServiceFunction" + description: The updated service function. + required: + - serviceFunction + UpdateSystemResponse: + type: object + properties: + system: + $ref: "#/components/schemas/System" + description: The updated system. + required: + - system + UpdateTestResponse: + type: object + properties: + test: + $ref: "#/components/schemas/Test" + description: The updated test. + required: + - test + UpdateUserJourneyResponse: + type: object + properties: + userJourney: + $ref: "#/components/schemas/UserJourney" + description: The updated user journey. + required: + - userJourney + x-stackQL-resources: + assertions: + id: aws.resiliencehubv2.assertions + name: assertions + title: assertions + methods: + create_assertion: + operation: + $ref: "#/paths/~1v2~1create-assertion/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_assertion: + operation: + $ref: "#/paths/~1v2~1delete-assertion/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_assertions: + operation: + $ref: "#/paths/~1v2~1list-assertions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.assertions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_assertion: + operation: + $ref: "#/paths/~1v2~1update-assertion/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/assertions/methods/list_assertions" + insert: + - $ref: "#/components/x-stackQL-resources/assertions/methods/create_assertion" + update: + - $ref: "#/components/x-stackQL-resources/assertions/methods/update_assertion" + delete: + - $ref: "#/components/x-stackQL-resources/assertions/methods/delete_assertion" + input_sources: + id: aws.resiliencehubv2.input_sources + name: input_sources + title: input_sources + methods: + create_input_source: + operation: + $ref: "#/paths/~1v2~1create-input-source/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_input_source: + operation: + $ref: "#/paths/~1v2~1delete-input-source/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_input_sources: + operation: + $ref: "#/paths/~1v2~1list-input-sources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.inputSourceSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/input_sources/methods/list_input_sources" + insert: + - $ref: "#/components/x-stackQL-resources/input_sources/methods/create_input_source" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/input_sources/methods/delete_input_source" + policies: + id: aws.resiliencehubv2.policies + name: policies + title: policies + methods: + create_policy: + operation: + $ref: "#/paths/~1v2~1create-policy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_policy: + operation: + $ref: "#/paths/~1v2~1delete-policy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_policy: + operation: + $ref: "#/paths/~1v2~1get-policy/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.policy + request: + nativeCasing: pascal + list_policies: + operation: + $ref: "#/paths/~1v2~1list-policies/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.policySummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_policy: + operation: + $ref: "#/paths/~1v2~1update-policy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/policies/methods/get_policy" + - $ref: "#/components/x-stackQL-resources/policies/methods/list_policies" + insert: + - $ref: "#/components/x-stackQL-resources/policies/methods/create_policy" + update: + - $ref: "#/components/x-stackQL-resources/policies/methods/update_policy" + delete: + - $ref: "#/components/x-stackQL-resources/policies/methods/delete_policy" + reports: + id: aws.resiliencehubv2.reports + name: reports + title: reports + methods: + create_report: + operation: + $ref: "#/paths/~1v2~1create-report/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_reports: + operation: + $ref: "#/paths/~1v2~1list-reports/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.reportGenerationResults + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/reports/methods/list_reports" + insert: + - $ref: "#/components/x-stackQL-resources/reports/methods/create_report" + update: [] + delete: [] + services: + id: aws.resiliencehubv2.services + name: services + title: services + methods: + create_service: + operation: + $ref: "#/paths/~1v2~1create-service/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_service: + operation: + $ref: "#/paths/~1v2~1delete-service/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_service: + operation: + $ref: "#/paths/~1v2~1get-service/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.service + request: + nativeCasing: pascal + list_services: + operation: + $ref: "#/paths/~1v2~1list-services/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.serviceSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + start_failure_mode_assessment: + operation: + $ref: "#/paths/~1v2~1start-failure-mode-assessment/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_service: + operation: + $ref: "#/paths/~1v2~1update-service/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/services/methods/get_service" + - $ref: "#/components/x-stackQL-resources/services/methods/list_services" + insert: + - $ref: "#/components/x-stackQL-resources/services/methods/create_service" + update: + - $ref: "#/components/x-stackQL-resources/services/methods/update_service" + delete: + - $ref: "#/components/x-stackQL-resources/services/methods/delete_service" + service_functions: + id: aws.resiliencehubv2.service_functions + name: service_functions + title: service_functions + methods: + create_service_function: + operation: + $ref: "#/paths/~1v2~1create-service-function/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_service_function: + operation: + $ref: "#/paths/~1v2~1delete-function/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_service_functions: + operation: + $ref: "#/paths/~1v2~1list-functions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.serviceFunctions + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_service_function: + operation: + $ref: "#/paths/~1v2~1update-function/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/service_functions/methods/list_service_functions" + insert: + - $ref: "#/components/x-stackQL-resources/service_functions/methods/create_service_function" + update: + - $ref: "#/components/x-stackQL-resources/service_functions/methods/update_service_function" + delete: + - $ref: "#/components/x-stackQL-resources/service_functions/methods/delete_service_function" + resources: + id: aws.resiliencehubv2.resources + name: resources + title: resources + methods: + create_service_function_resources: + operation: + $ref: "#/paths/~1v2~1create-service-function-resources/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_service_function_resources: + operation: + $ref: "#/paths/~1v2~1delete-service-function-resources/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_resources: + operation: + $ref: "#/paths/~1v2~1list-resources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.serviceResources + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/resources/methods/list_resources" + insert: + - $ref: "#/components/x-stackQL-resources/resources/methods/create_service_function_resources" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/resources/methods/delete_service_function_resources" + systems: + id: aws.resiliencehubv2.systems + name: systems + title: systems + methods: + create_system: + operation: + $ref: "#/paths/~1v2~1create-system/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_system: + operation: + $ref: "#/paths/~1v2~1delete-system/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_system: + operation: + $ref: "#/paths/~1v2~1get-system/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.system + request: + nativeCasing: pascal + list_systems: + operation: + $ref: "#/paths/~1v2~1list-systems/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.systemSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_system: + operation: + $ref: "#/paths/~1v2~1update-system/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/systems/methods/get_system" + - $ref: "#/components/x-stackQL-resources/systems/methods/list_systems" + insert: + - $ref: "#/components/x-stackQL-resources/systems/methods/create_system" + update: + - $ref: "#/components/x-stackQL-resources/systems/methods/update_system" + delete: + - $ref: "#/components/x-stackQL-resources/systems/methods/delete_system" + tests: + id: aws.resiliencehubv2.tests + name: tests + title: tests + methods: + create_test: + operation: + $ref: "#/paths/~1v2~1create-test/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_test: + operation: + $ref: "#/paths/~1v2~1delete-test/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_test: + operation: + $ref: "#/paths/~1v2~1get-test/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.test + request: + nativeCasing: pascal + list_tests: + operation: + $ref: "#/paths/~1v2~1list-tests/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.tests + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + start_test_run: + operation: + $ref: "#/paths/~1v2~1start-test-run/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + stop_test_run: + operation: + $ref: "#/paths/~1v2~1stop-test-run/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_test: + operation: + $ref: "#/paths/~1v2~1update-test/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tests/methods/get_test" + - $ref: "#/components/x-stackQL-resources/tests/methods/list_tests" + insert: + - $ref: "#/components/x-stackQL-resources/tests/methods/create_test" + update: + - $ref: "#/components/x-stackQL-resources/tests/methods/update_test" + delete: + - $ref: "#/components/x-stackQL-resources/tests/methods/delete_test" + user_journeys: + id: aws.resiliencehubv2.user_journeys + name: user_journeys + title: user_journeys + methods: + create_user_journey: + operation: + $ref: "#/paths/~1v2~1create-user-journey/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_user_journey: + operation: + $ref: "#/paths/~1v2~1delete-user-journey/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_user_journey: + operation: + $ref: "#/paths/~1v2~1get-user-journey/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.userJourney + request: + nativeCasing: pascal + list_user_journeys: + operation: + $ref: "#/paths/~1v2~1list-user-journeys/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.userJourneySummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_user_journey: + operation: + $ref: "#/paths/~1v2~1update-user-journey/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/user_journeys/methods/get_user_journey" + - $ref: "#/components/x-stackQL-resources/user_journeys/methods/list_user_journeys" + insert: + - $ref: "#/components/x-stackQL-resources/user_journeys/methods/create_user_journey" + update: + - $ref: "#/components/x-stackQL-resources/user_journeys/methods/update_user_journey" + delete: + - $ref: "#/components/x-stackQL-resources/user_journeys/methods/delete_user_journey" + test_sources: + id: aws.resiliencehubv2.test_sources + name: test_sources + title: test_sources + methods: + delete_test_sources: + operation: + $ref: "#/paths/~1v2~1delete-test-sources/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_test_sources: + operation: + $ref: "#/paths/~1v2~1tests~1{test_id}~1sources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.testSources + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + put_test_sources: + operation: + $ref: "#/paths/~1v2~1put-test-sources/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/test_sources/methods/list_test_sources" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/test_sources/methods/put_test_sources" + delete: + - $ref: "#/components/x-stackQL-resources/test_sources/methods/delete_test_sources" + failure_mode_findings: + id: aws.resiliencehubv2.failure_mode_findings + name: failure_mode_findings + title: failure_mode_findings + methods: + get_failure_mode_finding: + operation: + $ref: "#/paths/~1v2~1get-failure-mode-finding/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.finding + request: + nativeCasing: pascal + list_failure_mode_findings: + operation: + $ref: "#/paths/~1v2~1list-failure-mode-findings/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.findingsSummary + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_failure_mode_finding: + operation: + $ref: "#/paths/~1v2~1update-failure-mode-finding/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/failure_mode_findings/methods/get_failure_mode_finding" + - $ref: "#/components/x-stackQL-resources/failure_mode_findings/methods/list_failure_mode_findings" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/failure_mode_findings/methods/update_failure_mode_finding" + delete: [] + test_runs: + id: aws.resiliencehubv2.test_runs + name: test_runs + title: test_runs + methods: + get_test_run: + operation: + $ref: "#/paths/~1v2~1get-test-run/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.testRun + request: + nativeCasing: pascal + list_test_runs: + operation: + $ref: "#/paths/~1v2~1list-test-runs/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.testRuns + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/test_runs/methods/get_test_run" + - $ref: "#/components/x-stackQL-resources/test_runs/methods/list_test_runs" + insert: [] + update: [] + delete: [] + test_templates: + id: aws.resiliencehubv2.test_templates + name: test_templates + title: test_templates + methods: + get_test_template: + operation: + $ref: "#/paths/~1v2~1get-test-template/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.testTemplate + request: + nativeCasing: pascal + list_test_templates: + operation: + $ref: "#/paths/~1v2~1list-test-templates/get" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/test_templates/methods/get_test_template" + - $ref: "#/components/x-stackQL-resources/test_templates/methods/list_test_templates" + insert: [] + update: [] + delete: [] + dependencies: + id: aws.resiliencehubv2.dependencies + name: dependencies + title: dependencies + methods: + list_dependencies: + operation: + $ref: "#/paths/~1v2~1list-dependencies/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.dependencySummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_dependency: + operation: + $ref: "#/paths/~1v2~1update-dependency/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dependencies/methods/list_dependencies" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/dependencies/methods/update_dependency" + delete: [] + failure_mode_assessments: + id: aws.resiliencehubv2.failure_mode_assessments + name: failure_mode_assessments + title: failure_mode_assessments + methods: + list_failure_mode_assessments: + operation: + $ref: "#/paths/~1v2~1list-failure-mode-assessments/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.assessmentSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/failure_mode_assessments/methods/list_failure_mode_assessments" + insert: [] + update: [] + delete: [] + resolved_test_run_target_resources: + id: aws.resiliencehubv2.resolved_test_run_target_resources + name: resolved_test_run_target_resources + title: resolved_test_run_target_resources + methods: + list_resolved_test_run_target_resources: + operation: + $ref: "#/paths/~1v2~1test-runs~1{test_run_id}~1resolved-target-resources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.resolvedTargetResources + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/resolved_test_run_target_resources/methods/list_resolved_test_run_target_resources" + insert: [] + update: [] + delete: [] + service_events: + id: aws.resiliencehubv2.service_events + name: service_events + title: service_events + methods: + list_service_events: + operation: + $ref: "#/paths/~1v2~1list-service-events/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.events + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/service_events/methods/list_service_events" + insert: [] + update: [] + delete: [] + service_topology_edges: + id: aws.resiliencehubv2.service_topology_edges + name: service_topology_edges + title: service_topology_edges + methods: + list_service_topology_edges: + operation: + $ref: "#/paths/~1v2~1list-service-topology-edges/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.serviceTopologyEdgeSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/service_topology_edges/methods/list_service_topology_edges" + insert: [] + update: [] + delete: [] + system_events: + id: aws.resiliencehubv2.system_events + name: system_events + title: system_events + methods: + list_system_events: + operation: + $ref: "#/paths/~1v2~1list-system-events/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.events + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/system_events/methods/list_system_events" + insert: [] + update: [] + delete: [] + tags: + id: aws.resiliencehubv2.tags + name: tags + title: tags + methods: + list_tags_for_resource: + operation: + $ref: "#/paths/~1v2~1tags~1{resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~1v2~1tags~1{resource_arn}/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1v2~1tags~1{resource_arn}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + delete: [] + test_run_events: + id: aws.resiliencehubv2.test_run_events + name: test_run_events + title: test_run_events + methods: + list_test_run_events: + operation: + $ref: "#/paths/~1v2~1test-runs~1{test_run_id}~1events/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.events + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/test_run_events/methods/list_test_run_events" + insert: [] + update: [] + delete: [] + test_run_sources: + id: aws.resiliencehubv2.test_run_sources + name: test_run_sources + title: test_run_sources + methods: + list_test_run_sources: + operation: + $ref: "#/paths/~1v2~1test-runs~1{test_run_id}~1sources/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.testRunSources + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/test_run_sources/methods/list_test_run_sources" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/resource_explorer_2.yaml b/providers/src/aws/v00.00.00000/services/resource_explorer_2.yaml index 54ad9628..c16172da 100644 --- a/providers/src/aws/v00.00.00000/services/resource_explorer_2.yaml +++ b/providers/src/aws/v00.00.00000/services/resource_explorer_2.yaml @@ -1236,11 +1236,33 @@ components: ScopeType: $ref: "#/components/schemas/String" description: The scope type of the service view, which determines what resources are included. + ServiceLinkedRecorder: + $ref: "#/components/schemas/ServiceLinkedRecorderInfo" + description: Information about the service-linked recorder associated with this service view. When a service view is paired with a service-linked recorder, Resource Explorer uses the recorder's resource type list to filter search results and streaming data. required: - ServiceViewArn ServiceViewName: type: string pattern: "[a-zA-Z0-9\\-]{1,64}" + ServiceLinkedRecorderInfo: + description: Contains information about the service-linked recorder paired with a service view. + type: object + properties: + ServicePrincipal: + $ref: "#/components/schemas/String" + description: The service principal of the Amazon Web Services service that owns the service-linked recorder, such as observabilityadmin.amazonaws.com. + RecorderName: + $ref: "#/components/schemas/String" + description: The name of the service-linked recorder, such as AWSConfigurationRecorderForObservabilityAdmin. + RecorderType: + $ref: "#/components/schemas/RecorderType" + description: The type of the recorder. Valid values are AWS and THIRD_PARTY. + RecorderType: + description: The type of a service-linked recorder. AWS – Managed by an Amazon Web Services service. THIRD_PARTY – Managed by a third-party service. + type: string + enum: + - AWS + - THIRD_PARTY GetViewInputViewArnString: type: string minLength: 1 @@ -1400,6 +1422,9 @@ components: Service: $ref: "#/components/schemas/String" description: The Amazon Web Services service that owns the resource and is responsible for creating and updating it. + CfnResourceType: + $ref: "#/components/schemas/String" + description: The CloudFormation resource type identifier for the resource, such as AWS::EC2::Instance or AWS::S3::Bucket. LastReportedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource. @@ -1533,6 +1558,13 @@ components: ResourceType: $ref: "#/components/schemas/String" description: The unique identifier of the resource type. + CFNResourceTypes: + $ref: "#/components/schemas/CFNResourceTypeList" + description: The CloudFormation resource type identifiers for this resource type, such as AWS::EC2::Instance. + CFNResourceTypeList: + type: array + items: + $ref: "#/components/schemas/String" ListTagsForResourceOutput: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/resourcegroupstaggingapi.yaml b/providers/src/aws/v00.00.00000/services/resourcegroupstaggingapi.yaml index 845c2f15..c0b384d7 100644 --- a/providers/src/aws/v00.00.00000/services/resourcegroupstaggingapi.yaml +++ b/providers/src/aws/v00.00.00000/services/resourcegroupstaggingapi.yaml @@ -611,6 +611,9 @@ components: KeysWithNoncompliantValues: $ref: "#/components/schemas/TagKeyList" description: These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values. + MissingTagKeys: + $ref: "#/components/schemas/TagKeyList" + description: These tag keys are defined as required in the report_required_tag_for block of the effective tag policy, but are missing from the resource. ComplianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Whether a resource is compliant with the effective tag policy. diff --git a/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml b/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml index a98045da..6931e3cd 100644 --- a/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml +++ b/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml @@ -955,7 +955,7 @@ components: SourceDataX509CertificateDataString: type: string minLength: 1 - maxLength: 16000 + maxLength: 204800 NotificationSettings: type: array items: diff --git a/providers/src/aws/v00.00.00000/services/route53globalresolver.yaml b/providers/src/aws/v00.00.00000/services/route53globalresolver.yaml index b533ce01..fcca805e 100644 --- a/providers/src/aws/v00.00.00000/services/route53globalresolver.yaml +++ b/providers/src/aws/v00.00.00000/services/route53globalresolver.yaml @@ -1134,10 +1134,10 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateFirewallDomainsOutput" - /hosted-zone-associations/resource-arn/{resource_arn}: + /hosted-zone-associations: get: operationId: ListHostedZoneAssociations - description: Lists all hosted zone associations for a Route 53 Global Resolver resource with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands. + description: Lists hosted zone associations with pagination support. Specify a DNS view through the resourceArn parameter to list the hosted zone associations for that DNS view, or omit it to list all hosted zone associations in your Amazon Web Services account. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands. parameters: - name: max_results in: query @@ -1151,12 +1151,12 @@ paths: schema: $ref: "#/components/schemas/String" description: A pagination token used for large sets of results that can't be returned in a single response. - - name: resource_arn - in: path - required: true + - name: resourceArn + in: query + required: false schema: $ref: "#/components/schemas/ResourceArn" - description: Amazon Resource Name (ARN) of the DNS view. + description: The Amazon Resource Name (ARN) of the DNS view to list hosted zone associations for. This parameter is optional; if you omit it, all hosted zone associations in your Amazon Web Services account are returned. responses: "200": description: Success @@ -1194,6 +1194,30 @@ paths: application/json: schema: $ref: "#/components/schemas/ListManagedFirewallDomainListsOutput" + /shared-dns-views: + get: + operationId: ListSharedDNSViews + description: Lists the DNS views that have been shared with your Amazon Web Services account through Amazon Web Services Resource Access Manager (Amazon Web Services RAM), with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands. + parameters: + - name: max_results + in: query + required: false + schema: + $ref: "#/components/schemas/Integer" + description: The maximum number of results to retrieve in a single call. + - name: next_token + in: query + required: false + schema: + $ref: "#/components/schemas/String" + description: A pagination token used for large sets of results that can't be returned in a single response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSharedDNSViewsOutput" /get-all-tags: post: operationId: ListTagsForResource @@ -3422,6 +3446,82 @@ components: - id - name - managedListType + ListSharedDNSViewsOutput: + type: object + properties: + nextToken: + $ref: "#/components/schemas/String" + description: A pagination token used for large sets of results that can't be returned in a single response. Provide this token in the next call to get the results not returned in this call. + dnsViews: + $ref: "#/components/schemas/SharedDNSViews" + description: An array of information about the DNS views shared with your Amazon Web Services account, including the Amazon Web Services account that owns each DNS view. + required: + - dnsViews + SharedDNSViews: + type: array + items: + $ref: "#/components/schemas/SharedDNSViewSummary" + SharedDNSViewSummary: + description: Summary information about a DNS view that has been shared with your Amazon Web Services account through Amazon Web Services RAM. + type: object + properties: + id: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the DNS view. + arn: + $ref: "#/components/schemas/ResourceArn" + description: The Amazon Resource Name (ARN) of the DNS view. + clientToken: + $ref: "#/components/schemas/ClientToken" + description: The unique string that identifies the request and ensures idempotency. + dnssecValidation: + $ref: "#/components/schemas/DnsSecValidationType" + description: Whether DNSSEC validation is enabled for the DNS view. + ednsClientSubnet: + $ref: "#/components/schemas/EdnsClientSubnetType" + description: Whether EDNS Client Subnet injection is enabled for the DNS view. + firewallRulesFailOpen: + $ref: "#/components/schemas/FirewallRulesFailOpenType" + description: Whether firewall rules fail open when they cannot be evaluated. + name: + $ref: "#/components/schemas/ResourceName" + description: The name of the DNS view. + description: + $ref: "#/components/schemas/ResourceDescription" + description: A description of the DNS view. + globalResolverId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the global resolver that the DNS view is associated with. + createdAt: + $ref: "#/components/schemas/ISO8601TimeString" + description: The date and time when the DNS view was created. + updatedAt: + $ref: "#/components/schemas/ISO8601TimeString" + description: The date and time when the DNS view was last updated. + status: + $ref: "#/components/schemas/ProfileResourceStatus" + description: The current status of the DNS view. + ownerAccountId: + $ref: "#/components/schemas/AccountId" + description: The ID of the Amazon Web Services account that owns the DNS view and shared it with your Amazon Web Services account. + required: + - id + - arn + - clientToken + - dnssecValidation + - ednsClientSubnet + - firewallRulesFailOpen + - name + - globalResolverId + - createdAt + - updatedAt + - status + - ownerAccountId + AccountId: + type: string + minLength: 12 + maxLength: 32 + pattern: "[0-9]+" ListTagsForResourceResponse: type: object properties: @@ -4172,7 +4272,7 @@ components: algorithm: naive list_hosted_zone_associations: operation: - $ref: "#/paths/~1hosted-zone-associations~1resource-arn~1{resource_arn}/get" + $ref: "#/paths/~1hosted-zone-associations/get" response: openAPIDocKey: "200" mediaType: application/json @@ -4287,6 +4387,34 @@ components: update: - $ref: "#/components/x-stackQL-resources/firewall_domains/methods/update_firewall_domains" delete: [] + shared_dns_views: + id: aws.route53globalresolver.shared_dns_views + name: shared_dns_views + title: shared_dns_views + methods: + list_shared_dns_views: + operation: + $ref: "#/paths/~1shared-dns-views/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.dnsViews + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: next_token + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/shared_dns_views/methods/list_shared_dns_views" + insert: [] + update: [] + delete: [] tags: id: aws.route53globalresolver.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/route53resolver.yaml b/providers/src/aws/v00.00.00000/services/route53resolver.yaml index f0a376b9..26f9db46 100644 --- a/providers/src/aws/v00.00.00000/services/route53resolver.yaml +++ b/providers/src/aws/v00.00.00000/services/route53resolver.yaml @@ -21,7 +21,7 @@ paths: /AssociateFirewallRuleGroup: post: operationId: AssociateFirewallRuleGroup - description: Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. + description: Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. If the rule group contains any rule configured with the PartnerThreatProtection rule type, the calling account must hold an active AWS Marketplace subscription to the named partner. If the subscription is missing, the association request is rejected. parameters: - name: X-Amz-Target in: header @@ -186,6 +186,105 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateResolverRuleResponse" + /BatchCreateFirewallRule: + post: + operationId: BatchCreateFirewallRule + description: Creates multiple DNS Firewall rules in the specified rule group. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Route53Resolver.BatchCreateFirewallRule + default: Route53Resolver.BatchCreateFirewallRule + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CreateFirewallRuleEntries: + $ref: "#/components/schemas/CreateFirewallRuleEntries" + description: The list of firewall rules to create. + required: + - CreateFirewallRuleEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchCreateFirewallRuleResponse" + /BatchDeleteFirewallRule: + post: + operationId: BatchDeleteFirewallRule + description: Deletes multiple DNS Firewall rules from the specified rule group. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Route53Resolver.BatchDeleteFirewallRule + default: Route53Resolver.BatchDeleteFirewallRule + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + DeleteFirewallRuleEntries: + $ref: "#/components/schemas/DeleteFirewallRuleEntries" + description: The list of firewall rules to delete. + required: + - DeleteFirewallRuleEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteFirewallRuleResponse" + /BatchUpdateFirewallRule: + post: + operationId: BatchUpdateFirewallRule + description: Updates multiple DNS Firewall rules in the specified rule group. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Route53Resolver.BatchUpdateFirewallRule + default: Route53Resolver.BatchUpdateFirewallRule + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + UpdateFirewallRuleEntries: + $ref: "#/components/schemas/UpdateFirewallRuleEntries" + description: The list of firewall rules to update. + required: + - UpdateFirewallRuleEntries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchUpdateFirewallRuleResponse" /CreateFirewallDomainList: post: operationId: CreateFirewallDomainList @@ -228,7 +327,7 @@ paths: /CreateFirewallRule: post: operationId: CreateFirewallRule - description: Creates a single DNS Firewall rule in the specified rule group, using the specified domain list. + description: "Creates a single DNS Firewall rule in the specified rule group. The rule can use any one of the following match sources, and the chosen source must be supplied through the matching request field — they are mutually exclusive: FirewallDomainListId — match a customer-managed or AWS-managed domain list. DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). FirewallRuleType — match one of the rule-type variants returned by ListFirewallRuleTypes: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, or PartnerThreatProtection. The PartnerThreatProtection variant requires an active AWS Marketplace subscription to the named partner product. For rules that require asynchronous provisioning (today, the PartnerThreatProtection rule type), the rule's Status begins at CREATING and transitions to COMPLETE once the rule is provisioned and the marketplace entitlement is verified. If provisioning fails, Status becomes CREATION_FAILED and StatusMessage contains a human-readable reason; the rule is then immutable and must be removed with DeleteFirewallRule." parameters: - name: X-Amz-Target in: header @@ -281,13 +380,16 @@ paths: description: "How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list." Qtype: $ref: "#/components/schemas/Qtype" - description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types." + description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types." DnsThreatProtection: $ref: "#/components/schemas/DnsThreatProtection" - description: Use to create a DNS Firewall Advanced rule. + description: "The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." ConfidenceThreshold: $ref: "#/components/schemas/ConfidenceThreshold" description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + FirewallRuleType: + $ref: "#/components/schemas/FirewallRuleType" + description: "The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of: FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account. To enumerate the values supported in your account, call ListFirewallRuleTypes." required: - CreatorRequestId - FirewallRuleGroupId @@ -595,7 +697,7 @@ paths: /DeleteFirewallRule: post: operationId: DeleteFirewallRule - description: Deletes the specified firewall rule. + description: Deletes the specified firewall rule. Identify the rule using either FirewallDomainListId (for domain-list and DNS Firewall Advanced rules) or FirewallThreatProtectionId (for partner-managed and DNS Firewall Advanced rules) — together with FirewallRuleGroupId. DeleteFirewallRule is the only operation that succeeds against a rule whose Status is CREATION_FAILED. parameters: - name: X-Amz-Target in: header @@ -624,7 +726,7 @@ paths: description: The ID that is created for a DNS Firewall Advanced rule. Qtype: $ref: "#/components/schemas/Qtype" - description: "The DNS query type that the rule you are deleting evaluates. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types." + description: "The DNS query type that the rule you are deleting evaluates. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types." required: - FirewallRuleGroupId responses: @@ -1662,10 +1764,47 @@ paths: application/json: schema: $ref: "#/components/schemas/ListFirewallRuleGroupsResponse" + /ListFirewallRuleTypes: + post: + operationId: ListFirewallRuleTypes + description: Retrieves the rule-type variants that can be used in the FirewallRuleType field of CreateFirewallRule and UpdateFirewallRule. Each returned FirewallRuleTypeDefinition identifies one variant + value combination — for example, FirewallAdvancedContentCategory + VIOLENCE_AND_HATE_SPEECH, or PartnerThreatProtection + a partner-managed feed. The supported RuleType filter values are FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. When a returned definition's variant requires an external subscription (currently only PartnerThreatProtection), the response also includes a SubscriptionInfo identifying the AWS Marketplace product that backs it; absence of SubscriptionInfo means the variant is fully managed by AWS and requires no separate subscription. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - Route53Resolver.ListFirewallRuleTypes + default: Route53Resolver.ListFirewallRuleTypes + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + RuleType: + $ref: "#/components/schemas/RuleTypeName" + description: "An optional filter that restricts the response to a single FirewallRuleType variant. Supported values: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. If omitted, definitions across all variants are returned." + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects. + NextToken: + $ref: "#/components/schemas/NextToken" + description: For the first call to this list request, omit this value. When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver provides a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListFirewallRuleTypesResponse" /ListFirewallRules: post: operationId: ListFirewallRules - description: Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A single call might return only a partial list of the rules. For information, see MaxResults. + description: Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A single call might return only a partial list of the rules. For information, see MaxResults. For rules that require asynchronous provisioning, the response includes Status (see FirewallRuleStatus) and, on failure, StatusMessage with the reason. parameters: - name: X-Amz-Target in: header @@ -2356,7 +2495,7 @@ paths: /UpdateFirewallRule: post: operationId: UpdateFirewallRule - description: Updates the specified firewall rule. + description: Updates the specified firewall rule. The rule's FirewallRuleType, FirewallDomainListId, and top-level DnsThreatProtection match source cannot be changed after creation. Rules whose Status is CREATING or CREATION_FAILED cannot be updated; remove a failed rule with DeleteFirewallRule. parameters: - name: X-Amz-Target in: header @@ -2409,13 +2548,16 @@ paths: description: "How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list." Qtype: $ref: "#/components/schemas/Qtype" - description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types. If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled." + description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types. If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled." DnsThreatProtection: $ref: "#/components/schemas/DnsThreatProtection" - description: "The type of the DNS Firewall Advanced rule. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client." + description: "The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." ConfidenceThreshold: $ref: "#/components/schemas/ConfidenceThreshold" description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + FirewallRuleType: + $ref: "#/components/schemas/FirewallRuleType" + description: "The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of: FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account. To enumerate the values supported in your account, call ListFirewallRuleTypes." required: - FirewallRuleGroupId responses: @@ -3070,56 +3212,65 @@ components: - DELETING - FAILED - OVERRIDDEN - CreateFirewallDomainListResponse: - type: object - properties: - FirewallDomainList: - $ref: "#/components/schemas/FirewallDomainList" - description: The domain list that you just created. - FirewallDomainList: - description: High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList. To retrieve the domains that are defined for this domain list, call ListFirewallDomains. + CreateFirewallRuleEntries: + type: array + items: + $ref: "#/components/schemas/CreateFirewallRuleEntry" + CreateFirewallRuleEntry: + description: The details for creating a single firewall rule in a batch operation. type: object properties: - Id: + CreatorRequestId: + $ref: "#/components/schemas/CreatorRequestId" + description: A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + FirewallRuleGroupId: $ref: "#/components/schemas/ResourceId" - description: The ID of the domain list. - Arn: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the firewall domain list. + description: The unique identifier of the firewall rule group where you want to create the rule. + FirewallDomainListId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the domain list that you want to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType. + Priority: + $ref: "#/components/schemas/Priority" + description: The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. + Action: + $ref: "#/components/schemas/Action" + description: "The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule: ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules. ALERT - Permit the request and send metrics and logs to CloudWatch. BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse." + BlockResponse: + $ref: "#/components/schemas/BlockResponse" + description: The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK. NODATA - Respond indicating that the query was successful, but no response is available for it. NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist. OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings. + BlockOverrideDomain: + $ref: "#/components/schemas/BlockOverrideDomain" + description: The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. + BlockOverrideDnsType: + $ref: "#/components/schemas/BlockOverrideDnsType" + description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. + BlockOverrideTtl: + $ref: "#/components/schemas/BlockOverrideTtl" + description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse setting is OVERRIDE. Name: $ref: "#/components/schemas/Name" - description: The name of the domain list. - DomainCount: - $ref: "#/components/schemas/Unsigned" - description: The number of domain names that are specified in the domain list. - Status: - $ref: "#/components/schemas/FirewallDomainListStatus" - description: The status of the domain list. - StatusMessage: - $ref: "#/components/schemas/StatusMessage" - description: Additional information about the status of the list, if available. - ManagedOwnerName: - $ref: "#/components/schemas/ServicePrinciple" - description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall. - CreatorRequestId: - $ref: "#/components/schemas/CreatorRequestId" - description: A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. - CreationTime: - $ref: "#/components/schemas/Rfc3339TimeString" - description: The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC). - ModificationTime: - $ref: "#/components/schemas/Rfc3339TimeString" - description: The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC). - Unsigned: - type: integer - FirewallDomainListStatus: - type: string - enum: - - COMPLETE - - COMPLETE_IMPORT_FAILED - - IMPORTING - - DELETING - - UPDATING + description: A name that lets you identify the rule in the rule group. + FirewallDomainRedirectionAction: + $ref: "#/components/schemas/FirewallDomainRedirectionAction" + description: "How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list." + Qtype: + $ref: "#/components/schemas/Qtype" + description: "The DNS query type you want the rule to evaluate. Allowed values are: A: Returns an IPv4 address. AAAA: Returns an IPv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types." + DnsThreatProtection: + $ref: "#/components/schemas/DnsThreatProtection" + description: "The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." + ConfidenceThreshold: + $ref: "#/components/schemas/ConfidenceThreshold" + description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + FirewallRuleType: + $ref: "#/components/schemas/FirewallRuleType" + description: "The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of: FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account. To enumerate the values supported in your account, call ListFirewallRuleTypes." + required: + - CreatorRequestId + - FirewallRuleGroupId + - Priority + - Action + - Name Action: type: string enum: @@ -3160,17 +3311,101 @@ components: - DNS_TUNNELING - DICTIONARY_DGA ConfidenceThreshold: + description: "The confidence threshold for a DNS Firewall Advanced rule. One of: LOW — Provides the highest detection rate for threats, but also increases false positives. MEDIUM — Provides a balance between detecting threats and false positives. HIGH — Detects only the most well-corroborated threats with a low rate of false positives." type: string enum: - LOW - MEDIUM - HIGH - CreateFirewallRuleResponse: + FirewallRuleType: + description: The rule-type configuration for a DNS Firewall rule. FirewallRuleType is a tagged union — exactly one member must be set per rule, and the member determines what the rule matches against. This shape is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields on CreateFirewallRule and UpdateFirewallRule. Call ListFirewallRuleTypes to discover which rule-type variants and which values within each variant are available in your account and Region. type: object properties: - FirewallRule: - $ref: "#/components/schemas/FirewallRule" - description: The firewall rule that you just created. + PartnerThreatProtection: + $ref: "#/components/schemas/PartnerThreatProtectionConfig" + description: Configures the rule to match a third-party threat feed delivered through AWS Marketplace. The calling account must hold an active subscription to the partner product named in Partner; if the subscription is missing or revoked, the rule is created with Status CREATION_FAILED and cannot be modified — only deleted. See PartnerThreatProtectionConfig. + FirewallAdvancedContentCategory: + $ref: "#/components/schemas/FirewallAdvancedContentCategoryConfig" + description: Configures the rule to match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). See FirewallAdvancedContentCategoryConfig. + FirewallAdvancedThreatCategory: + $ref: "#/components/schemas/FirewallAdvancedThreatCategoryConfig" + description: Configures the rule to match an AWS-managed advanced threat category (for example, PHISHING). See FirewallAdvancedThreatCategoryConfig. + DnsThreatProtection: + $ref: "#/components/schemas/DnsThreatProtectionRuleTypeConfig" + description: Configures the rule to match a built-in DNS Firewall Advanced threat detector — DGA, DNS_TUNNELING, or DICTIONARY_DGA. See DnsThreatProtectionRuleTypeConfig. + PartnerThreatProtectionConfig: + description: The configuration for a partner threat-protection rule. To enumerate the partners available in your account, call ListFirewallRuleTypes with RuleType set to PartnerThreatProtection — each returned FirewallRuleTypeDefinition includes a SubscriptionInfo identifying the AWS Marketplace product that backs it. + type: object + properties: + Partner: + $ref: "#/components/schemas/PartnerValue" + description: The identifier of the partner threat-protection product, exactly as returned in the Value field of a FirewallRuleTypeDefinition with RuleType set to PartnerThreatProtection. The calling account must hold an active AWS Marketplace subscription to this product. + required: + - Partner + PartnerValue: + description: The identifier of a partner threat-protection product, returned in the Value field of a FirewallRuleTypeDefinition for the PartnerThreatProtection rule type. Pass this string as PartnerThreatProtectionConfig.Partner when creating a partner-managed firewall rule. + type: string + minLength: 1 + maxLength: 128 + FirewallAdvancedContentCategoryConfig: + description: The configuration for a content category-based filtering rule. This specifies which content category to use for DNS query evaluation. + type: object + properties: + Category: + $ref: "#/components/schemas/FirewallAdvancedContentCategoryValue" + description: The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory. + required: + - Category + FirewallAdvancedContentCategoryValue: + description: The identifier of an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH), returned in the Value field of a FirewallRuleTypeDefinition for the FirewallAdvancedContentCategory rule type. Pass this string as FirewallAdvancedContentCategoryConfig.Category when creating a content-category firewall rule. + type: string + minLength: 1 + maxLength: 128 + FirewallAdvancedThreatCategoryConfig: + description: The configuration for a threat category-based filtering rule. This specifies which threat category to use for DNS query evaluation. + type: object + properties: + Category: + $ref: "#/components/schemas/FirewallAdvancedThreatCategoryValue" + description: The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory. + required: + - Category + FirewallAdvancedThreatCategoryValue: + description: The identifier of an AWS-managed advanced threat category (for example, PHISHING), returned in the Value field of a FirewallRuleTypeDefinition for the FirewallAdvancedThreatCategory rule type. Pass this string as FirewallAdvancedThreatCategoryConfig.Category when creating a threat-category firewall rule. + type: string + minLength: 1 + maxLength: 128 + DnsThreatProtectionRuleTypeConfig: + description: The configuration for a DNS threat protection rule type within the rule type framework. + type: object + properties: + Value: + $ref: "#/components/schemas/DnsThreatProtectionRuleTypeValue" + description: "The type of DNS threat protection. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." + ConfidenceThreshold: + $ref: "#/components/schemas/ConfidenceThreshold" + description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + required: + - Value + - ConfidenceThreshold + DnsThreatProtectionRuleTypeValue: + description: The identifier of a built-in DNS Firewall Advanced threat detector. Known values are DGA, DNS_TUNNELING, and DICTIONARY_DGA. Returned in the Value field of a FirewallRuleTypeDefinition for the DnsThreatProtection rule type, and used as DnsThreatProtectionRuleTypeConfig.Value when creating a DNS threat protection firewall rule. + type: string + minLength: 1 + maxLength: 128 + BatchCreateFirewallRuleResponse: + type: object + properties: + CreatedFirewallRules: + $ref: "#/components/schemas/FirewallRules" + description: The firewall rules that were successfully created by the request. + CreateErrors: + $ref: "#/components/schemas/BatchCreateFirewallRuleErrors" + description: A list of errors that occurred while creating the firewall rules. + FirewallRules: + type: array + items: + $ref: "#/components/schemas/FirewallRule" FirewallRule: description: A single firewall rule in a rule group. type: object @@ -3219,13 +3454,248 @@ components: description: "How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list." Qtype: $ref: "#/components/schemas/Qtype" - description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types." + description: "The DNS query type you want the rule to evaluate. Allowed values are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types." DnsThreatProtection: $ref: "#/components/schemas/DnsThreatProtection" - description: "The type of the DNS Firewall Advanced rule. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client." + description: "The type of the DNS Firewall Advanced rule. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." ConfidenceThreshold: $ref: "#/components/schemas/ConfidenceThreshold" description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + FirewallRuleType: + $ref: "#/components/schemas/FirewallRuleType" + description: "The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are: FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace. To enumerate the values supported in your account, call ListFirewallRuleTypes." + Status: + $ref: "#/components/schemas/FirewallRuleStatus" + description: "The lifecycle state of the firewall rule. Possible values: CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement. COMPLETE — The rule is provisioned and enforcing matches. CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule. For rules that do not require asynchronous provisioning, this field may be absent." + StatusMessage: + $ref: "#/components/schemas/FirewallRuleStatusMessage" + description: An additional message about the rule's lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed. + Unsigned: + type: integer + FirewallRuleStatus: + description: "The lifecycle state of a DNS Firewall rule. Known values: CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement. COMPLETE — The rule is provisioned and enforcing matches. CREATION_FAILED — Provisioning failed. UpdateFirewallRule rejects updates to a rule in this state; the rule must be removed with DeleteFirewallRule." + type: string + maxLength: 32 + FirewallRuleStatusMessage: + description: A human-readable description of why a firewall rule is in CREATION_FAILED state. + type: string + maxLength: 1024 + BatchCreateFirewallRuleErrors: + type: array + items: + $ref: "#/components/schemas/BatchCreateFirewallRuleError" + BatchCreateFirewallRuleError: + description: An error that occurred while creating a firewall rule in a batch operation. + type: object + properties: + FirewallRule: + $ref: "#/components/schemas/CreateFirewallRuleEntry" + description: The firewall rule entry that caused the error. + Code: + $ref: "#/components/schemas/String" + description: The error code for the failure. + Message: + $ref: "#/components/schemas/String" + description: A message that provides details about the error. + String: + type: string + DeleteFirewallRuleEntries: + type: array + items: + $ref: "#/components/schemas/DeleteFirewallRuleEntry" + DeleteFirewallRuleEntry: + description: The details for deleting a single firewall rule in a batch operation. + type: object + properties: + FirewallRuleGroupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the firewall rule group for the rule. + FirewallDomainListId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the domain list that's used in the rule. + FirewallThreatProtectionId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the DNS Firewall Advanced rule. + Qtype: + $ref: "#/components/schemas/Qtype" + description: The DNS query type that the rule evaluates. + required: + - FirewallRuleGroupId + BatchDeleteFirewallRuleResponse: + type: object + properties: + DeletedFirewallRules: + $ref: "#/components/schemas/FirewallRules" + description: The firewall rules that were successfully deleted by the request. + DeleteErrors: + $ref: "#/components/schemas/BatchDeleteFirewallRuleErrors" + description: A list of errors that occurred while deleting the firewall rules. + BatchDeleteFirewallRuleErrors: + type: array + items: + $ref: "#/components/schemas/BatchDeleteFirewallRuleError" + BatchDeleteFirewallRuleError: + description: An error that occurred while deleting a firewall rule in a batch operation. + type: object + properties: + FirewallRule: + $ref: "#/components/schemas/DeleteFirewallRuleEntry" + description: The firewall rule entry that caused the error. + Code: + $ref: "#/components/schemas/String" + description: The error code for the failure. + Message: + $ref: "#/components/schemas/String" + description: A message that provides details about the error. + UpdateFirewallRuleEntries: + type: array + items: + $ref: "#/components/schemas/UpdateFirewallRuleEntry" + UpdateFirewallRuleEntry: + description: The details for updating a single firewall rule in a batch operation. + type: object + properties: + FirewallRuleGroupId: + $ref: "#/components/schemas/ResourceId" + description: The unique identifier of the firewall rule group for the rule. + FirewallDomainListId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the domain list to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType. + FirewallThreatProtectionId: + $ref: "#/components/schemas/ResourceId" + description: The ID of the DNS Firewall Advanced rule. + Priority: + $ref: "#/components/schemas/Priority" + description: The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. + Action: + $ref: "#/components/schemas/Action" + description: "The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule: ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules. ALERT - Permit the request and send metrics and logs to CloudWatch. BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse." + BlockResponse: + $ref: "#/components/schemas/BlockResponse" + description: The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK. NODATA - Respond indicating that the query was successful, but no response is available for it. NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist. OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings. + BlockOverrideDomain: + $ref: "#/components/schemas/BlockOverrideDomain" + description: The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. + BlockOverrideDnsType: + $ref: "#/components/schemas/BlockOverrideDnsType" + description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. + BlockOverrideTtl: + $ref: "#/components/schemas/BlockOverrideTtl" + description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse setting is OVERRIDE. + Name: + $ref: "#/components/schemas/Name" + description: The name of the rule. + FirewallDomainRedirectionAction: + $ref: "#/components/schemas/FirewallDomainRedirectionAction" + description: "How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list." + Qtype: + $ref: "#/components/schemas/Qtype" + description: "The DNS query type you want the rule to evaluate. Allowed values are: A: Returns an IPv4 address. AAAA: Returns an IPv6 address. CAA: Restricts CAs that can create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV: Application specific values that identify servers. TXT: Verifies email senders and application-specific values. A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types." + DnsThreatProtection: + $ref: "#/components/schemas/DnsThreatProtection" + description: "The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are: DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks. DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs." + ConfidenceThreshold: + $ref: "#/components/schemas/ConfidenceThreshold" + description: "The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean: LOW: Provides the highest detection rate for threats, but also increases false positives. MEDIUM: Provides a balance between detecting threats and false positives. HIGH: Detects only the most well corroborated threats with a low rate of false positives." + FirewallRuleType: + $ref: "#/components/schemas/FirewallRuleType" + description: "The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of: FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account. To enumerate the values supported in your account, call ListFirewallRuleTypes." + required: + - FirewallRuleGroupId + BatchUpdateFirewallRuleResponse: + type: object + properties: + UpdatedFirewallRules: + $ref: "#/components/schemas/FirewallRules" + description: The firewall rules that were successfully updated by the request. + UpdateErrors: + $ref: "#/components/schemas/BatchUpdateFirewallRuleErrors" + description: A list of errors that occurred while updating the firewall rules. + BatchUpdateFirewallRuleErrors: + type: array + items: + $ref: "#/components/schemas/BatchUpdateFirewallRuleError" + BatchUpdateFirewallRuleError: + description: An error that occurred while updating a firewall rule in a batch operation. + type: object + properties: + FirewallRule: + $ref: "#/components/schemas/UpdateFirewallRuleEntry" + description: The firewall rule entry that caused the error. + Code: + $ref: "#/components/schemas/String" + description: The error code for the failure. + Message: + $ref: "#/components/schemas/String" + description: A message that provides details about the error. + CreateFirewallDomainListResponse: + type: object + properties: + FirewallDomainList: + $ref: "#/components/schemas/FirewallDomainList" + description: The domain list that you just created. + FirewallDomainList: + description: High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList. To retrieve the domains that are defined for this domain list, call ListFirewallDomains. + type: object + properties: + Id: + $ref: "#/components/schemas/ResourceId" + description: The ID of the domain list. + Arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the firewall domain list. + Name: + $ref: "#/components/schemas/Name" + description: The name of the domain list. + DomainCount: + $ref: "#/components/schemas/Unsigned" + description: The number of domain names that are specified in the domain list. + Status: + $ref: "#/components/schemas/FirewallDomainListStatus" + description: The status of the domain list. + StatusMessage: + $ref: "#/components/schemas/StatusMessage" + description: Additional information about the status of the list, if available. + ManagedOwnerName: + $ref: "#/components/schemas/ServicePrinciple" + description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall. + CreatorRequestId: + $ref: "#/components/schemas/CreatorRequestId" + description: A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. + CreationTime: + $ref: "#/components/schemas/Rfc3339TimeString" + description: The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC). + ModificationTime: + $ref: "#/components/schemas/Rfc3339TimeString" + description: The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC). + Category: + $ref: "#/components/schemas/Category" + description: The category of the domain list. + ManagedListType: + $ref: "#/components/schemas/DomainListType" + description: The type of the managed domain list, for example THREAT. + FirewallDomainListStatus: + type: string + enum: + - COMPLETE + - COMPLETE_IMPORT_FAILED + - IMPORTING + - DELETING + - UPDATING + Category: + type: string + maxLength: 256 + DomainListType: + type: string + enum: + - THREAT + - CONTENT + CreateFirewallRuleResponse: + type: object + properties: + FirewallRule: + $ref: "#/components/schemas/FirewallRule" + description: The firewall rule that you just created. CreateFirewallRuleGroupResponse: type: object properties: @@ -3853,6 +4323,12 @@ components: ManagedOwnerName: $ref: "#/components/schemas/ServicePrinciple" description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall. + ManagedListType: + $ref: "#/components/schemas/DomainListType" + description: The type of the managed domain list, for example THREAT. + Category: + $ref: "#/components/schemas/Category" + description: The category of the domain list. ListDomainMaxResults: type: integer minimum: 1 @@ -3918,6 +4394,69 @@ components: ShareStatus: $ref: "#/components/schemas/ShareStatus" description: Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM). + RuleTypeName: + description: The variant name of a rule type. Known values are FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. Returned in the RuleType field of a FirewallRuleTypeDefinition. + type: string + maxLength: 128 + ListFirewallRuleTypesResponse: + type: object + properties: + FirewallRuleTypes: + $ref: "#/components/schemas/FirewallRuleTypeDefinitions" + description: A list of the available rule type definitions. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request. + FirewallRuleTypeDefinitions: + type: array + items: + $ref: "#/components/schemas/FirewallRuleTypeDefinition" + FirewallRuleTypeDefinition: + description: The definition of an available rule type that can be used in DNS Firewall rules. This is returned by ListFirewallRuleTypes. + type: object + properties: + RuleType: + $ref: "#/components/schemas/RuleTypeName" + description: The category or class of the rule type, such as FirewallAdvancedContentCategory or FirewallAdvancedThreatCategory. + Value: + $ref: "#/components/schemas/RuleTypeValue" + description: The specific identifier within the rule type category, such as VIOLENCE_AND_HATE_SPEECH or PHISHING. + DisplayName: + $ref: "#/components/schemas/DisplayName" + description: The display name of the rule type. + Description: + $ref: "#/components/schemas/RuleTypeDescription" + description: A description of the rule type. + SubscriptionInfo: + $ref: "#/components/schemas/SubscriptionInfo" + description: For rule types that require an external subscription (today, only the PartnerThreatProtection variant), describes the AWS Marketplace product that backs the rule type. Absent for rule types that are managed by AWS and do not require a separate subscription. See SubscriptionInfo. + RuleTypeValue: + description: The variant-specific value of a rule type, returned in the Value field of a FirewallRuleTypeDefinition. The interpretation of this string depends on RuleType; see FirewallAdvancedContentCategoryValue, FirewallAdvancedThreatCategoryValue, DnsThreatProtectionRuleTypeValue, or PartnerValue. + type: string + maxLength: 128 + DisplayName: + type: string + maxLength: 256 + RuleTypeDescription: + description: A human-readable description of a rule-type definition returned by ListFirewallRuleTypes. + type: string + maxLength: 1024 + SubscriptionInfo: + description: Identifies the AWS Marketplace product that backs a partner-managed rule type. Returned as part of FirewallRuleTypeDefinition when the rule type variant requires an active customer subscription to the named product. + type: object + properties: + VendorName: + $ref: "#/components/schemas/VendorName" + description: The name of the AWS Marketplace seller (vendor) that publishes the partner threat-protection product (for example, Palo Alto Networks). + ProductId: + $ref: "#/components/schemas/ProductId" + description: The AWS Marketplace product identifier of the partner threat-protection product. Use this value to verify or manage the calling account's subscription in AWS Marketplace. + VendorName: + type: string + maxLength: 256 + ProductId: + type: string + maxLength: 256 ListFirewallRulesResponse: type: object properties: @@ -3927,10 +4466,6 @@ components: FirewallRules: $ref: "#/components/schemas/FirewallRules" description: A list of the rules that you have defined. This might be a partial list of the firewall rules that you've defined. For information, see MaxResults. - FirewallRules: - type: array - items: - $ref: "#/components/schemas/FirewallRule" ListOutpostResolversResponse: type: object properties: @@ -4049,6 +4584,7 @@ components: enum: - CREATING - FAILED_CREATION + - FAILED_CREATION_INSUFFICIENT_EC2_CAPACITY_IN_OUTPOST - ATTACHING - ATTACHED - REMAP_DETACHING @@ -5507,6 +6043,38 @@ components: update: - $ref: "#/components/x-stackQL-resources/firewall_domains/methods/update_firewall_domains" delete: [] + firewall_rule_types: + id: aws.route53resolver.firewall_rule_types + name: firewall_rule_types + title: firewall_rule_types + methods: + list_firewall_rule_types: + operation: + $ref: "#/paths/~1ListFirewallRuleTypes/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.FirewallRuleTypes + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/firewall_rule_types/methods/list_firewall_rule_types" + insert: [] + update: [] + delete: [] resolver_endpoint_ip_addresses: id: aws.route53resolver.resolver_endpoint_ip_addresses name: resolver_endpoint_ip_addresses diff --git a/providers/src/aws/v00.00.00000/services/rtbfabric.yaml b/providers/src/aws/v00.00.00000/services/rtbfabric.yaml index 765db7da..c8515be9 100644 --- a/providers/src/aws/v00.00.00000/services/rtbfabric.yaml +++ b/providers/src/aws/v00.00.00000/services/rtbfabric.yaml @@ -1623,27 +1623,27 @@ components: minimum: 1 maximum: 1000 RuleCondition: - description: Conditions bag for a routing rule. All non-null fields must match (AND logic). At least one field must be set (enforced by CP). + description: The conditions for a routing rule. All specified fields must match for the rule to apply (AND logic). At least one condition field must be set. type: object properties: hostHeader: $ref: "#/components/schemas/RuleConditionHostHeaderString" - description: Exact host match — RFC 3986 unreserved characters + description: The exact host header value to match. hostHeaderWildcard: $ref: "#/components/schemas/RuleConditionHostHeaderWildcardString" - description: Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved plus * + description: A wildcard pattern for host header matching (for example, *.example.com). pathPrefix: $ref: "#/components/schemas/RuleConditionPathPrefixString" - description: Path prefix matching — strict starts-with, no wildcard (preferred for new rules). Must start with /; RFC 3986 unreserved plus / + description: The path prefix to match. The request path must start with this value. Must start with /. pathExact: $ref: "#/components/schemas/RuleConditionPathExactString" - description: Exact path match — must start with /; RFC 3986 unreserved plus / + description: The exact path to match. Must start with /. queryStringEquals: $ref: "#/components/schemas/QueryStringKeyValuePair" - description: Query string key=value pair match (single pair) + description: A query string key-value pair that must be present and match exactly. queryStringExists: $ref: "#/components/schemas/RuleConditionQueryStringExistsString" - description: Query string key presence check (any value accepted) — RFC 3986 unreserved characters + description: A query string key that must be present in the request (any value is accepted). RuleConditionHostHeaderString: type: string minLength: 1 @@ -1665,15 +1665,15 @@ components: maxLength: 128 pattern: /[A-Za-z0-9._~/-]* QueryStringKeyValuePair: - description: Key-value pair for query string matching + description: A key-value pair for query string matching in a routing rule condition. type: object properties: key: $ref: "#/components/schemas/QueryStringKeyValuePairKeyString" - description: RFC 3986 unreserved characters + description: The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters. value: $ref: "#/components/schemas/QueryStringKeyValuePairValueString" - description: RFC 3986 unreserved characters + description: The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters. required: - key - value @@ -2448,9 +2448,9 @@ components: totalLinksCount: $ref: "#/components/schemas/Integer" description: The total count of links for the responder gateway. - inboundLinksCount: + linksRequestedCount: $ref: "#/components/schemas/Integer" - description: The count of inbound links for the responder gateway. + description: The count of requested links waiting for the responder gateway to accept or reject. gatewayType: $ref: "#/components/schemas/GatewayType" description: The type of gateway. Valid values are EXTERNAL or INTERNAL. @@ -2536,7 +2536,7 @@ components: items: $ref: "#/components/schemas/LinkRoutingRuleSummary" LinkRoutingRuleSummary: - description: Summary of a routing rule for list responses + description: A summary of a link routing rule. type: object properties: ruleId: diff --git a/providers/src/aws/v00.00.00000/services/s3.yaml b/providers/src/aws/v00.00.00000/services/s3.yaml index cbeeab26..14a4ba10 100644 --- a/providers/src/aws/v00.00.00000/services/s3.yaml +++ b/providers/src/aws/v00.00.00000/services/s3.yaml @@ -9,12 +9,12 @@ info: x-apiVersion: "2006-03-01" x-endpointPrefix: s3 servers: - - url: https://s3.amazonaws.com + - url: https://s3.{region}.amazonaws.com variables: region: default: us-east-1 description: AWS region - description: Global endpoint for s3 + description: Regional endpoint for s3 paths: /{bucket}/{key}: delete: @@ -362,6 +362,12 @@ paths: schema: $ref: "#/components/schemas/TaggingDirective" description: "Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request. The default value is COPY. Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations: When you attempt to COPY the tag-set from an S3 source object that has non-empty tags. When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging. When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY. Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed: When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty. When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty. When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value." + - name: x-amz-object-annotation-directive + in: header + required: false + schema: + $ref: "#/components/schemas/AnnotationDirective" + description: "Specifies whether you want to copy annotations from the source object or exclude them. If this header isn't specified, COPY is the default behavior. Valid Values: COPY | EXCLUDE You can specify this directive as either an HTTP header (x-amz-object-annotation-directive) or as a query string parameter. Use the query string form when generating presigned URLs that need to control annotation copy behavior. When set to COPY, you must have s3:GetObjectAnnotation permission on the source object and s3:PutObjectAnnotation permission on the destination. Each annotation copied is billed as a separate PUT request. If annotations on the source are modified during the copy, Amazon S3 returns a retryable error. For directory buckets, annotations are not supported. Use EXCLUDE to copy objects to directory buckets without errors. If you specify COPY for a directory bucket, the request returns HTTP 501 (Not Implemented). When you copy objects using multipart upload (for example, when the Amazon Web Services CLI or Amazon Web Services SDKs use Transfer Manager for objects larger than approximately 8 MB), annotations are not copied by default. To include annotations, specify --copy-props default in the Amazon Web Services CLI or the equivalent SDK configuration. With this opt-in, the SDK reads source annotations, completes the multipart upload, and then writes each annotation to the destination. Between the upload completion and the last annotation write, the destination object exists without all its annotations." - name: x-amz-server-side-encryption in: header required: false @@ -615,9 +621,13 @@ paths: "200": description: Success content: - application/json: + application/octet-stream: schema: - $ref: "#/components/schemas/GetObjectOutputDisplay" + type: object + properties: + contents: + type: string + description: The raw object content. Text objects only - binary content is not supported and may be mangled in transit. head: operationId: HeadObject description: "The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Permissions General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide. If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error. Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession . If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object. Encryption Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. Versioning If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header. Directory buckets - Delete marker is not supported for directory buckets. Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request. HTTP Host header syntax Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com. For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide. The following actions are related to HeadObject: GetObject GetObjectAttributes You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt." @@ -943,7 +953,7 @@ paths: /{bucket}?metadataConfiguration: post: operationId: CreateBucketMetadataConfiguration - description: "Creates an S3 Metadata V2 metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide. To query your metadata tables, you need additional permissions. For more information, see Permissions for querying metadata tables in the Amazon S3 User Guide. s3:CreateBucketMetadataTableConfiguration The IAM policy action name is the same for the V1 and V2 API operations. s3tables:CreateTableBucket s3tables:CreateNamespace s3tables:GetTable s3tables:CreateTable s3tables:PutTablePolicy s3tables:PutTableEncryption kms:DescribeKey The following operations are related to CreateBucketMetadataConfiguration: DeleteBucketMetadataConfiguration GetBucketMetadataConfiguration UpdateBucketMetadataInventoryTableConfiguration UpdateBucketMetadataJournalTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt." + description: "Creates an S3 Metadata V2 metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide. To query your metadata tables, you need additional permissions. For more information, see Permissions for querying metadata tables in the Amazon S3 User Guide. s3:CreateBucketMetadataTableConfiguration The IAM policy action name is the same for the V1 and V2 API operations. s3tables:CreateTableBucket s3tables:CreateNamespace s3tables:GetTable s3tables:CreateTable s3tables:PutTablePolicy s3tables:PutTableBucketPolicy s3tables:PutTableEncryption kms:DescribeKey iam:PassRole - required if you include an AnnotationTableConfiguration with an IAM role. The following operations are related to CreateBucketMetadataConfiguration: DeleteBucketMetadataConfiguration GetBucketMetadataConfiguration UpdateBucketMetadataInventoryTableConfiguration UpdateBucketMetadataJournalTableConfiguration UpdateBucketMetadataAnnotationTableConfiguration If you include an AnnotationTableConfiguration with an IAM role, the role must have a trust policy that allows the Amazon S3 metadata service to assume it, and a permissions policy that grants the actions needed to read annotations from your bucket. The following examples show a trust policy and a permissions policy that you can adapt for your bucket and account. You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt." parameters: - name: bucket in: path @@ -2479,6 +2489,246 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteObjectOutputDisplay" + /{bucket}/{key}?annotation: + delete: + operationId: DeleteObjectAnnotation + description: "Deletes a specific annotation from an Amazon S3 object. Use the x-amz-object-if-match header to perform a conditional delete that only succeeds if the object's ETag matches the provided value, preventing race conditions during concurrent updates. Deleting an annotation is permanent. Annotations are not independently versioned, so there is no delete marker or way to recover a deleted annotation. To use this operation, you must have the s3:DeleteObjectAnnotation permission. If the object is protected by Object Lock in governance mode, you must also include the x-amz-bypass-governance-retention header. Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets). The following operations are related to DeleteObjectAnnotation: PutObjectAnnotation GetObjectAnnotation ListObjectAnnotations" + parameters: + - name: bucket + in: path + required: true + schema: + $ref: "#/components/schemas/BucketName" + description: The name of the bucket that contains the object. + - name: key + in: path + required: true + schema: + $ref: "#/components/schemas/ObjectKey" + description: The object key. + - name: annotationName + in: query + required: true + schema: + $ref: "#/components/schemas/AnnotationName" + description: "The name of the annotation to delete. Annotation names are UTF-8 encoded and cannot start with aws or s3 (case-insensitive). Length Constraints: Minimum length of 1. Maximum length of 512 bytes." + - name: versionId + in: query + required: false + schema: + $ref: "#/components/schemas/ObjectVersionId" + description: The version ID of the object. + - name: x-amz-request-payer + in: header + required: false + schema: + $ref: "#/components/schemas/RequestPayer" + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: The account ID of the expected bucket owner. + - name: x-amz-object-if-match + in: header + required: false + schema: + $ref: "#/components/schemas/ObjectIfMatch" + description: If specified, the operation only succeeds if the object's ETag matches the provided value. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteObjectAnnotationOutputDisplay" + get: + operationId: GetObjectAnnotation + description: "Retrieves an annotation from an Amazon S3 object. To use this operation, you must have the s3:GetObjectAnnotation permission. If checksum mode is enabled via the x-amz-checksum-mode header, Amazon S3 returns the stored checksum in the response headers for client-side validation. Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets). The following operations are related to GetObjectAnnotation: PutObjectAnnotation ListObjectAnnotations DeleteObjectAnnotation" + parameters: + - name: bucket + in: path + required: true + schema: + $ref: "#/components/schemas/BucketName" + description: The name of the bucket that contains the object. + - name: key + in: path + required: true + schema: + $ref: "#/components/schemas/ObjectKey" + description: The object key. + - name: annotationName + in: query + required: true + schema: + $ref: "#/components/schemas/AnnotationName" + description: "The name of the annotation to retrieve. Length Constraints: Minimum length of 1. Maximum length of 512 bytes." + - name: versionId + in: query + required: false + schema: + $ref: "#/components/schemas/ObjectVersionId" + description: The version ID of the object. + - name: x-amz-request-payer + in: header + required: false + schema: + $ref: "#/components/schemas/RequestPayer" + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error. + - name: x-amz-checksum-mode + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumMode" + description: Set to ENABLED to validate the checksum of the annotation payload on retrieval. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetObjectAnnotationOutputDisplay" + put: + operationId: PutObjectAnnotation + description: "Attaches an annotation to an Amazon S3 object. An annotation is a named payload of 1 byte to 1 MiB that you can associate with a specific object or object version. Each object can have up to 1,000 annotations. For annotation naming rules and restrictions, see Annotation naming guidelines in the Amazon S3 User Guide. Annotations inherit the encryption of their parent object. For objects without server-side encryption, annotations are encrypted with SSE-S3 (the default for new objects). Objects encrypted with SSE-C cannot have annotations. To use this operation, you must have the s3:PutObjectAnnotation permission. If the bucket has Requester Pays enabled, you must include the x-amz-request-payer header. Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets). The following operations are related to PutObjectAnnotation: GetObjectAnnotation ListObjectAnnotations DeleteObjectAnnotation" + parameters: + - name: bucket + in: path + required: true + schema: + $ref: "#/components/schemas/BucketName" + description: The name of the bucket that contains the object. + - name: key + in: path + required: true + schema: + $ref: "#/components/schemas/ObjectKey" + description: The object key. + - name: versionId + in: query + required: false + schema: + $ref: "#/components/schemas/ObjectVersionId" + description: The version ID of the object to attach the annotation to. + - name: annotationName + in: query + required: true + schema: + $ref: "#/components/schemas/AnnotationName" + description: "The name of the annotation. Length Constraints: Minimum length of 1. Maximum length of 512 bytes." + - name: x-amz-object-if-match + in: header + required: false + schema: + $ref: "#/components/schemas/ObjectIfMatch" + description: If specified, the operation only succeeds if the object's ETag matches the provided value. + - name: x-amz-sdk-checksum-algorithm + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumAlgorithm" + description: "The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128." + - name: x-amz-checksum-crc32 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumCRC32" + description: Base64-encoded CRC32 checksum of the annotation payload. + - name: x-amz-checksum-crc32c + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumCRC32C" + description: Base64-encoded CRC32C checksum of the annotation payload. + - name: x-amz-checksum-crc64nvme + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumCRC64NVME" + description: Base64-encoded CRC64NVME checksum of the annotation payload. + - name: x-amz-checksum-sha1 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumSHA1" + description: Base64-encoded SHA1 checksum of the annotation payload. + - name: x-amz-checksum-sha256 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumSHA256" + description: Base64-encoded SHA256 checksum of the annotation payload. + - name: x-amz-checksum-sha512 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumSHA512" + description: Base64-encoded SHA512 checksum of the annotation payload. + - name: x-amz-checksum-md5 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumMD5" + description: Base64-encoded MD5 checksum of the annotation payload. + - name: x-amz-checksum-xxhash64 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumXXHASH64" + description: Base64-encoded XXHASH64 checksum of the annotation payload. + - name: x-amz-checksum-xxhash3 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumXXHASH3" + description: Base64-encoded XXHASH3 checksum of the annotation payload. + - name: x-amz-checksum-xxhash128 + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumXXHASH128" + description: Base64-encoded XXHASH128 checksum of the annotation payload. + - name: Content-MD5 + in: header + required: false + schema: + $ref: "#/components/schemas/ContentMD5" + description: Base64-encoded MD5 digest of the message. + - name: x-amz-request-payer + in: header + required: false + schema: + $ref: "#/components/schemas/RequestPayer" + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error. + requestBody: + required: true + content: + application/xml: + schema: + type: object + properties: + AnnotationPayload: + $ref: "#/components/schemas/AnnotationPayload" + required: + - AnnotationPayload + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutObjectAnnotationOutputDisplay" /{bucket}/{key}?tagging: delete: operationId: DeleteObjectTagging @@ -4142,6 +4392,65 @@ paths: application/json: schema: $ref: "#/components/schemas/ListMultipartUploadsOutputDisplay" + /{bucket}/{key}?annotation&x-id=ListObjectAnnotations: + get: + operationId: ListObjectAnnotations + description: "Lists the annotations attached to an Amazon S3 object. Results are paginated, with a maximum of 1,000 annotations per object. Use the AnnotationPrefix parameter to filter the results by name prefix. To use this operation, you must have the s3:ListObjectAnnotations permission. Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets). The following operations are related to ListObjectAnnotations: PutObjectAnnotation GetObjectAnnotation DeleteObjectAnnotation" + parameters: + - name: bucket + in: path + required: true + schema: + $ref: "#/components/schemas/BucketName" + description: The name of the bucket that contains the object. + - name: key + in: path + required: true + schema: + $ref: "#/components/schemas/ObjectKey" + description: The object key. + - name: versionId + in: query + required: false + schema: + $ref: "#/components/schemas/ObjectVersionId" + description: The version ID of the object. + - name: max-annotation-results + in: query + required: false + schema: + $ref: "#/components/schemas/MaxAnnotationResults" + description: The maximum number of annotations to return in the response. Maximum is 1,000. + - name: annotation-prefix + in: query + required: false + schema: + $ref: "#/components/schemas/AnnotationPrefix" + description: Filter results to annotations whose name begins with the specified prefix. + - name: continuation-token + in: query + required: false + schema: + $ref: "#/components/schemas/Token" + description: Continuation token returned by a previous request to retrieve the next page. + - name: x-amz-request-payer + in: header + required: false + schema: + $ref: "#/components/schemas/RequestPayer" + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: The account ID of the expected bucket owner. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListObjectAnnotationsOutputDisplay" /{bucket}?versions: get: operationId: ListObjectVersions @@ -4718,14 +5027,18 @@ paths: $ref: "#/components/schemas/AccountId" description: The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied). requestBody: - required: false + required: true content: - application/xml: + application/octet-stream: schema: type: object + required: + - contents properties: - Body: - $ref: "#/components/schemas/Body" + contents: + type: string + x-stackQL-stringOnly: true + description: The raw object content to write. Text objects only - binary content is not supported and may be mangled in transit. responses: "200": description: Success @@ -4945,6 +5258,49 @@ paths: application/json: schema: $ref: "#/components/schemas/SelectObjectContentOutputDisplay" + /{bucket}?metadataAnnotationTable: + put: + operationId: UpdateBucketMetadataAnnotationTableConfiguration + description: "Updates the annotation table configuration for an Amazon S3 bucket's metadata configuration. Use this operation to enable or disable the annotation table, or to update its associated IAM role. An annotation table is a queryable Iceberg table that contains records of all annotations attached to objects in the bucket. To use this operation, the bucket must have an existing Amazon S3 Metadata configuration. To use this operation, you must have the s3:UpdateBucketMetadataAnnotationTableConfiguration permission. If you are specifying or changing the IAM role, you must also have iam:PassRole permission for the role. The IAM role must have a trust policy that allows the Amazon S3 metadata service to assume it, and a permissions policy that grants the actions needed to read annotations from your bucket. The following examples show a trust policy and a permissions policy that you can adapt for your bucket and account. The following operations are related to UpdateBucketMetadataAnnotationTableConfiguration: CreateBucketMetadataConfiguration GetBucketMetadataConfiguration" + parameters: + - name: bucket + in: path + required: true + schema: + $ref: "#/components/schemas/BucketName" + description: The name of the bucket whose annotation table configuration to update. + - name: Content-MD5 + in: header + required: false + schema: + $ref: "#/components/schemas/ContentMD5" + description: Base64-encoded MD5 digest of the message body. + - name: x-amz-sdk-checksum-algorithm + in: header + required: false + schema: + $ref: "#/components/schemas/ChecksumAlgorithm" + description: Checksum algorithm for the request payload. + - name: x-amz-expected-bucket-owner + in: header + required: false + schema: + $ref: "#/components/schemas/AccountId" + description: The account ID of the expected bucket owner. + requestBody: + required: true + content: + application/xml: + schema: + type: object + properties: + AnnotationTableConfiguration: + $ref: "#/components/schemas/AnnotationTableConfigurationUpdates" + required: + - AnnotationTableConfiguration + responses: + "200": + description: Success /{bucket}?metadataInventoryTable: put: operationId: UpdateBucketMetadataInventoryTableConfiguration @@ -5034,7 +5390,7 @@ paths: /{bucket}/{key}?encryption: put: operationId: UpdateObjectEncryption - description: "This operation is not supported for directory buckets or Amazon S3 on Outposts buckets. Updates the server-side encryption type of an existing encrypted object in a general purpose bucket. You can use the UpdateObjectEncryption operation to change encrypted objects from server-side encryption with Amazon S3 managed keys (SSE-S3) to server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or to apply S3 Bucket Keys. You can also use the UpdateObjectEncryption operation to change the customer-managed KMS key used to encrypt your data so that you can comply with custom key-rotation standards. Using the UpdateObjectEncryption operation, you can atomically update the server-side encryption type of an existing object in a general purpose bucket without any data movement. The UpdateObjectEncryption operation uses envelope encryption to re-encrypt the data key used to encrypt and decrypt your object with your newly specified server-side encryption type. In other words, when you use the UpdateObjectEncryption operation, your data isn't copied, archived objects in the S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage classes aren't restored, and objects in the S3 Intelligent-Tiering storage class aren't moved between tiers. Additionally, the UpdateObjectEncryption operation preserves all object metadata properties, including the storage class, creation date, last modified date, ETag, and checksum properties. For more information, see Updating server-side encryption for existing objects in the Amazon S3 User Guide. By default, all UpdateObjectEncryption requests that specify a customer-managed KMS key are restricted to KMS keys that are owned by the bucket owner's Amazon Web Services account. If you're using Organizations, you can request the ability to use KMS keys owned by other member accounts within your organization by contacting Amazon Web Services Support. Source objects that are unencrypted, or encrypted with either dual-layer server-side encryption with KMS keys (DSSE-KMS) or server-side encryption with customer-provided keys (SSE-C) aren't supported by this operation. Additionally, you cannot specify SSE-S3 encryption as the requested new encryption type UpdateObjectEncryption request. Permissions To use the UpdateObjectEncryption operation, you must have the following permissions: s3:PutObject s3:UpdateObjectEncryption kms:Encrypt kms:Decrypt kms:GenerateDataKey kms:ReEncrypt* If you're using Organizations, to use this operation with customer-managed KMS keys from other Amazon Web Services accounts within your organization, you must have the organizations:DescribeAccount permission. Errors You might receive an InvalidRequest error for several reasons. Depending on the reason for the error, you might receive one of the following messages: The UpdateObjectEncryption operation doesn't supported unencrypted source objects. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. The UpdateObjectEncryption operation doesn't support source objects with the encryption type DSSE-KMS or SSE-C. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. The UpdateObjectEncryption operation doesn't support updating the encryption type to DSSE-KMS or SSE-C. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. Requests that modify an object encryption configuration require Amazon Web Services Signature Version 4. Modify the request to use Amazon Web Services Signature Version 4, and then try again. Requests that modify an object encryption configuration require a valid new encryption type. Valid values are SSEKMS. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. Requests that modify an object's encryption type to SSE-KMS require an Amazon Web Services KMS key Amazon Resource Name (ARN). Modify the request to specify a KMS key ARN, and then try again. Requests that modify an object's encryption type to SSE-KMS require a valid Amazon Web Services KMS key Amazon Resource Name (ARN). Confirm that you have a correctly formatted KMS key ARN in your request, and then try again. The BucketKeyEnabled value isn't valid. Valid values are true or false. Modify the request to specify a valid value, and then try again. You might receive an AccessDenied error for several reasons. Depending on the reason for the error, you might receive one of the following messages: The Amazon Web Services KMS key in the request must be owned by the same account as the bucket. Modify the request to specify a KMS key from the same account, and then try again. The bucket owner's account was approved to make UpdateObjectEncryption requests that use any Amazon Web Services KMS key in their organization, but the bucket owner's account isn't part of an organization in Organizations. Make sure that the bucket owner's account and the specified KMS key belong to the same organization, and then try again. The specified Amazon Web Services KMS key must be from the same organization in Organizations as the bucket. Specify a KMS key that belongs to the same organization as the bucket, and then try again. The encryption type for the specified object can’t be updated because that object is protected by S3 Object Lock. If the object has a governance-mode retention period or a legal hold, you must first remove the Object Lock status on the object before you issue your UpdateObjectEncryption request. You can't use the UpdateObjectEncryption operation with objects that have an Object Lock compliance mode retention period applied to them." + description: "This operation is not supported for directory buckets or Amazon S3 on Outposts buckets. Updates the server-side encryption type of an existing encrypted object in a general purpose bucket. You can use the UpdateObjectEncryption operation to change encrypted objects from server-side encryption with Amazon S3 managed keys (SSE-S3) to server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or to apply S3 Bucket Keys. You can also use the UpdateObjectEncryption operation to change the customer-managed KMS key used to encrypt your data so that you can comply with custom key-rotation standards. Using the UpdateObjectEncryption operation, you can atomically update the server-side encryption type of an existing object in a general purpose bucket without any data movement. The UpdateObjectEncryption operation uses envelope encryption to re-encrypt the data key used to encrypt and decrypt your object with your newly specified server-side encryption type. In other words, when you use the UpdateObjectEncryption operation, your data isn't copied, archived objects in the S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage classes aren't restored, and objects in the S3 Intelligent-Tiering storage class aren't moved between tiers. Additionally, the UpdateObjectEncryption operation preserves all object metadata properties, including the storage class, creation date, last modified date, ETag, and checksum properties. For more information, see Updating server-side encryption for existing objects in the Amazon S3 User Guide. By default, all UpdateObjectEncryption requests that specify a customer-managed KMS key are restricted to KMS keys that are owned by the bucket owner's Amazon Web Services account. If you're using Organizations, you can request the ability to use KMS keys owned by other member accounts within your organization by contacting Amazon Web Services Support. Source objects that are unencrypted, or encrypted with either dual-layer server-side encryption with KMS keys (DSSE-KMS) or server-side encryption with customer-provided keys (SSE-C) aren't supported by this operation. Additionally, you cannot specify SSE-S3 encryption as the requested new encryption type UpdateObjectEncryption request. Permissions To use the UpdateObjectEncryption operation, you must have the following permissions: s3:UpdateObjectEncryption kms:Encrypt kms:Decrypt kms:GenerateDataKey kms:ReEncrypt* If you're using Organizations, to use this operation with customer-managed KMS keys from other Amazon Web Services accounts within your organization, you must have the organizations:DescribeAccount permission. Errors You might receive an InvalidRequest error for several reasons. Depending on the reason for the error, you might receive one of the following messages: The UpdateObjectEncryption operation doesn't supported unencrypted source objects. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. The UpdateObjectEncryption operation doesn't support source objects with the encryption type DSSE-KMS or SSE-C. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. The UpdateObjectEncryption operation doesn't support updating the encryption type to DSSE-KMS or SSE-C. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. Requests that modify an object encryption configuration require Amazon Web Services Signature Version 4. Modify the request to use Amazon Web Services Signature Version 4, and then try again. Requests that modify an object encryption configuration require a valid new encryption type. Valid values are SSEKMS. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. Requests that modify an object's encryption type to SSE-KMS require an Amazon Web Services KMS key Amazon Resource Name (ARN). Modify the request to specify a KMS key ARN, and then try again. Requests that modify an object's encryption type to SSE-KMS require a valid Amazon Web Services KMS key Amazon Resource Name (ARN). Confirm that you have a correctly formatted KMS key ARN in your request, and then try again. The BucketKeyEnabled value isn't valid. Valid values are true or false. Modify the request to specify a valid value, and then try again. You might receive an AccessDenied error for several reasons. Depending on the reason for the error, you might receive one of the following messages: The Amazon Web Services KMS key in the request must be owned by the same account as the bucket. Modify the request to specify a KMS key from the same account, and then try again. The bucket owner's account was approved to make UpdateObjectEncryption requests that use any Amazon Web Services KMS key in their organization, but the bucket owner's account isn't part of an organization in Organizations. Make sure that the bucket owner's account and the specified KMS key belong to the same organization, and then try again. The specified Amazon Web Services KMS key must be from the same organization in Organizations as the bucket. Specify a KMS key that belongs to the same organization as the bucket, and then try again. The encryption type for the specified object can’t be updated because that object is protected by S3 Object Lock. If the object has a governance-mode retention period or a legal hold, you must first remove the Object Lock status on the object before you issue your UpdateObjectEncryption request. You can't use the UpdateObjectEncryption operation with objects that have an Object Lock compliance mode retention period applied to them." parameters: - name: bucket in: path @@ -5875,6 +6231,7 @@ components: format: date-time Expires: type: string + format: date-time GrantFullControl: type: string GrantRead: @@ -5896,11 +6253,17 @@ components: enum: - COPY - REPLACE + AnnotationDirective: + type: string + enum: + - COPY + - EXCLUDE ServerSideEncryption: type: string enum: - AES256 - aws:fsx + - aws:backup - aws:kms - aws:kms:dsse StorageClass: @@ -5919,6 +6282,8 @@ components: - EXPRESS_ONEZONE - FSX_OPENZFS - FSX_ONTAP + - AWS_BACKUP_WARM + - AWS_BACKUP_LOW_COST_WARM WebsiteRedirectLocation: type: string SSEKMSKeyId: @@ -6109,6 +6474,9 @@ components: InventoryTableConfiguration: $ref: "#/components/schemas/InventoryTableConfiguration" description: The inventory table configuration for a metadata configuration. + AnnotationTableConfiguration: + $ref: "#/components/schemas/AnnotationTableConfiguration" + description: Optional annotation table configuration to include with the metadata configuration. required: - JournalTableConfiguration JournalTableConfiguration: @@ -6178,6 +6546,27 @@ components: enum: - ENABLED - DISABLED + AnnotationTableConfiguration: + description: Specifies the configuration for the annotation table associated with a bucket's Amazon S3 Metadata configuration. The annotation table is an Iceberg table that records annotation events for objects in the bucket. + type: object + properties: + ConfigurationState: + $ref: "#/components/schemas/AnnotationConfigurationState" + description: The state of the annotation table. Valid values are ENABLED and DISABLED. + EncryptionConfiguration: + $ref: "#/components/schemas/MetadataTableEncryptionConfiguration" + Role: + $ref: "#/components/schemas/Role" + description: The ARN of the IAM role used to manage the annotation table. + required: + - ConfigurationState + AnnotationConfigurationState: + type: string + enum: + - ENABLED + - DISABLED + Role: + type: string MetadataTableConfiguration: description: The V1 S3 Metadata configuration for a general purpose bucket. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. type: object @@ -6250,6 +6639,17 @@ components: type: array items: $ref: "#/components/schemas/DeleteObjectOutputDisplay" + AnnotationName: + type: string + ObjectIfMatch: + type: string + DeleteObjectAnnotationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/DeleteObjectAnnotationOutputDisplay" DeleteObjectTaggingOutputDisplay: type: object properties: @@ -6676,20 +7076,20 @@ components: type: string enum: - ENABLED - GetObjectOutputDisplay: + GetObjectAclOutputDisplay: type: object properties: line_items: type: array items: - $ref: "#/components/schemas/GetObjectOutputDisplay" - GetObjectAclOutputDisplay: + $ref: "#/components/schemas/GetObjectAclOutputDisplay" + GetObjectAnnotationOutputDisplay: type: object properties: line_items: type: array items: - $ref: "#/components/schemas/GetObjectAclOutputDisplay" + $ref: "#/components/schemas/GetObjectAnnotationOutputDisplay" MaxParts: type: integer PartNumberMarker: @@ -6930,6 +7330,40 @@ components: type: array items: $ref: "#/components/schemas/MultipartUploadDisplay" + MaxAnnotationResults: + type: integer + minimum: 1 + maximum: 1000 + AnnotationPrefix: + type: string + AnnotationEntryDisplay: + type: object + properties: + AnnotationName: + type: string + description: The name of the annotation. + LastModified: + type: string + description: The date and time the annotation was last modified. + ETag: + type: string + description: The entity tag of the annotation. + ChecksumAlgorithm: + type: string + description: The checksum algorithm used for the annotation. + Size: + type: integer + description: The size of the annotation payload, in bytes. + ReplicationStatus: + type: string + description: The replication status of the annotation. + ListObjectAnnotationsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/AnnotationEntryDisplay" MaxKeys: type: integer VersionIdMarker: @@ -7687,7 +8121,7 @@ components: description: Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. Days: $ref: "#/components/schemas/Days" - description: Indicates the number of days after creation when objects are transitioned to the specified storage class. If the specified storage class is INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE, valid values are 0 or positive integers. If the specified storage class is STANDARD_IA or ONEZONE_IA, valid values are positive integers greater than 30. Be aware that some storage classes have a minimum storage duration and that you're charged for transitioning objects before their minimum storage duration. For more information, see Constraints and considerations for transitions in the Amazon S3 User Guide. + description: Indicates the number of days after creation when objects are transitioned to the specified storage class. The value can be 0 or any positive integer. Be aware that some storage classes have a minimum storage duration and that you're charged for transitioning objects before their minimum storage duration. For more information, see Constraints and considerations for transitions in the Amazon S3 User Guide. StorageClass: $ref: "#/components/schemas/TransitionStorageClass" description: The storage class to which you want the object to transition. @@ -8020,6 +8454,9 @@ components: - s3:ObjectTagging:* - s3:ObjectTagging:Put - s3:ObjectTagging:Delete + - s3:ObjectAnnotation:* + - s3:ObjectAnnotation:Put + - s3:ObjectAnnotation:Delete TopicArn: type: string QueueConfigurationDeprecated: @@ -8219,8 +8656,6 @@ components: required: - Role - Rules - Role: - type: string ReplicationRules: type: array items: @@ -8603,9 +9038,6 @@ components: WriteOffsetBytes: type: integer format: int64 - Body: - type: string - format: byte PutObjectOutputDisplay: type: object properties: @@ -8620,6 +9052,16 @@ components: type: array items: $ref: "#/components/schemas/PutObjectAclOutputDisplay" + AnnotationPayload: + type: string + format: byte + PutObjectAnnotationOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/PutObjectAnnotationOutputDisplay" ObjectLockLegalHold: description: A legal hold configuration for an object. type: object @@ -9071,6 +9513,20 @@ components: type: array items: $ref: "#/components/schemas/SelectObjectContentEventStreamDisplay" + AnnotationTableConfigurationUpdates: + description: Specifies updates to apply to the annotation table configuration. Used as the request body for UpdateBucketMetadataAnnotationTableConfiguration. + type: object + properties: + ConfigurationState: + $ref: "#/components/schemas/AnnotationConfigurationState" + description: The new configuration state to apply. + EncryptionConfiguration: + $ref: "#/components/schemas/MetadataTableEncryptionConfiguration" + Role: + $ref: "#/components/schemas/Role" + description: The new IAM role ARN to apply. + required: + - ConfigurationState InventoryTableConfigurationUpdates: description: The specified updates to the S3 Metadata inventory table configuration. type: object @@ -9131,6 +9587,9 @@ components: type: array items: $ref: "#/components/schemas/UpdateObjectEncryptionResponseDisplay" + Body: + type: string + format: byte UploadPartOutputDisplay: type: object properties: @@ -9200,13 +9659,11 @@ components: $ref: "#/paths/~1{bucket}~1{key}/get" response: openAPIDocKey: "200" - mediaType: application/xml + mediaType: application/octet-stream overrideMediaType: application/json - schema_override: - $ref: "#/components/schemas/GetObjectOutputDisplay" transform: - type: schema_driven_xml_v0.1.0 - objectKey: $.line_items + type: golang_template_text_v0.3.0 + body: '[{"contents": {{ toJson . }}}]' request: nativeCasing: pascal list_objects: @@ -9269,7 +9726,10 @@ components: objectKey: $.line_items request: nativeCasing: pascal - mediaType: application/xml + mediaType: application/octet-stream + transform: + type: golang_template_json_v0.1.0 + body: "{{ .contents }}" config: requestBodyTranslate: algorithm: naive @@ -9295,7 +9755,8 @@ components: select: - $ref: "#/components/x-stackQL-resources/objects/methods/get_object" - $ref: "#/components/x-stackQL-resources/objects/methods/list_objects" - insert: [] + insert: + - $ref: "#/components/x-stackQL-resources/objects/methods/put_object" update: - $ref: "#/components/x-stackQL-resources/objects/methods/update_object_encryption" replace: @@ -9345,6 +9806,17 @@ components: objectKey: $.line_items request: nativeCasing: pascal + update_bucket_metadata_annotation_table_configuration: + operation: + $ref: "#/paths/~1{bucket}?metadataAnnotationTable/put" + response: + openAPIDocKey: "200" + request: + nativeCasing: pascal + mediaType: application/xml + config: + requestBodyTranslate: + algorithm: naive update_bucket_metadata_inventory_table_configuration: operation: $ref: "#/paths/~1{bucket}?metadataInventoryTable/put" @@ -9373,6 +9845,7 @@ components: insert: - $ref: "#/components/x-stackQL-resources/buckets/methods/create_bucket" update: + - $ref: "#/components/x-stackQL-resources/buckets/methods/update_bucket_metadata_annotation_table_configuration" - $ref: "#/components/x-stackQL-resources/buckets/methods/update_bucket_metadata_inventory_table_configuration" - $ref: "#/components/x-stackQL-resources/buckets/methods/update_bucket_metadata_journal_table_configuration" delete: @@ -10100,6 +10573,81 @@ components: - $ref: "#/components/x-stackQL-resources/bucket_websites/methods/put_bucket_website" delete: - $ref: "#/components/x-stackQL-resources/bucket_websites/methods/delete_bucket_website" + object_annotations: + id: aws.s3.object_annotations + name: object_annotations + title: object_annotations + methods: + delete_object_annotation: + operation: + $ref: "#/paths/~1{bucket}~1{key}?annotation/delete" + response: + openAPIDocKey: "204" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/DeleteObjectAnnotationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + get_object_annotation: + operation: + $ref: "#/paths/~1{bucket}~1{key}?annotation/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/GetObjectAnnotationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + put_object_annotation: + operation: + $ref: "#/paths/~1{bucket}~1{key}?annotation/put" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/PutObjectAnnotationOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + mediaType: application/xml + config: + requestBodyTranslate: + algorithm: naive + list_object_annotations: + operation: + $ref: "#/paths/~1{bucket}~1{key}?annotation&x-id=ListObjectAnnotations/get" + response: + openAPIDocKey: "200" + mediaType: application/xml + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ListObjectAnnotationsOutputDisplay" + transform: + type: schema_driven_xml_v0.1.0 + objectKey: $.line_items + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/object_annotations/methods/get_object_annotation" + - $ref: "#/components/x-stackQL-resources/object_annotations/methods/list_object_annotations" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/object_annotations/methods/put_object_annotation" + delete: + - $ref: "#/components/x-stackQL-resources/object_annotations/methods/delete_object_annotation" object_taggings: id: aws.s3.object_taggings name: object_taggings diff --git a/providers/src/aws/v00.00.00000/services/s3control.yaml b/providers/src/aws/v00.00.00000/services/s3control.yaml index 361c128a..7624329b 100644 --- a/providers/src/aws/v00.00.00000/services/s3control.yaml +++ b/providers/src/aws/v00.00.00000/services/s3control.yaml @@ -5831,7 +5831,7 @@ components: MinStorageBytesPercentage: type: number format: double - minimum: 0.1 + minimum: 1 maximum: 100 AdvancedCostOptimizationMetrics: description: The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced cost-optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide. diff --git a/providers/src/aws/v00.00.00000/services/s3vectors.yaml b/providers/src/aws/v00.00.00000/services/s3vectors.yaml index dab42a38..f8395ace 100644 --- a/providers/src/aws/v00.00.00000/services/s3vectors.yaml +++ b/providers/src/aws/v00.00.00000/services/s3vectors.yaml @@ -512,7 +512,7 @@ paths: /QueryVectors: post: operationId: QueryVectors - description: "Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response), the vector data, and metadata of each vector in the response. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). Permissions You must have the s3vectors:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request vector data or metadata (by keeping the returnMetadata parameter set to false or not specified). If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering, vector data, or metadata without the s3vectors:GetVectors permission." + description: "Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response) and metadata of each vector in the response. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). Permissions You must have the s3vectors:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request metadata (by keeping the returnMetadata parameter set to false or not specified). If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering or metadata without the s3vectors:GetVectors permission." parameters: [] requestBody: required: true @@ -537,6 +537,8 @@ paths: $ref: "#/components/schemas/Boolean" returnDistance: $ref: "#/components/schemas/Boolean" + nextToken: + $ref: "#/components/schemas/QueryVectorsNextToken" required: - topK - queryVector @@ -1006,6 +1008,10 @@ components: minimum: 1 Document: type: object + QueryVectorsNextToken: + type: string + minLength: 1 + maxLength: 4096 QueryVectorsOutput: type: object properties: @@ -1015,6 +1021,9 @@ components: distanceMetric: $ref: "#/components/schemas/DistanceMetric" description: The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created. + nextToken: + $ref: "#/components/schemas/QueryVectorsNextToken" + description: Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required. required: - vectors - distanceMetric @@ -1298,6 +1307,13 @@ components: request: nativeCasing: pascal config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body requestBodyTranslate: algorithm: naive sqlVerbs: diff --git a/providers/src/aws/v00.00.00000/services/sagemaker.yaml b/providers/src/aws/v00.00.00000/services/sagemaker.yaml index 195cfb21..d5f87c19 100644 --- a/providers/src/aws/v00.00.00000/services/sagemaker.yaml +++ b/providers/src/aws/v00.00.00000/services/sagemaker.yaml @@ -465,6 +465,9 @@ paths: ComputeSpec: $ref: "#/components/schemas/AIRecommendationComputeSpec" description: The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration. + AdapterSource: + $ref: "#/components/schemas/AIAdapterSource" + description: The LoRA adapter source for the recommendation job. Specify either a list of model package ARNs or Amazon S3 URIs for your LoRA adapters. When this parameter is absent, the recommendation job runs without LoRA adapter support. Tags: $ref: "#/components/schemas/TagList" description: The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. @@ -938,6 +941,9 @@ paths: RestrictedInstanceGroups: $ref: "#/components/schemas/ClusterRestrictedInstanceGroupSpecifications" description: The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster. + RestrictedInstanceGroupsConfig: + $ref: "#/components/schemas/ClusterRestrictedInstanceGroupsConfig" + description: The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster. VpcConfig: $ref: "#/components/schemas/VpcConfig" description: "Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC. When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform: Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications. In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment. Additional resources for IPv6 configuration: For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC. For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide. To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod." @@ -1377,6 +1383,9 @@ paths: AppSecurityGroupManagement: $ref: "#/components/schemas/AppSecurityGroupManagement" description: The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service. + HomeEfsFileSystemCreation: + $ref: "#/components/schemas/HomeEfsFileSystemCreation" + description: Indicates whether to create a home EFS file system for the domain. Defaults to Enabled. Set to Disabled to skip EFS creation and reduce domain creation time. You can enable EFS later by calling UpdateDomain. TagPropagation: $ref: "#/components/schemas/TagPropagation" description: Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED. @@ -1604,7 +1613,7 @@ paths: description: An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. KmsKeyId: $ref: "#/components/schemas/KmsKeyId" - description: "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes." + description: "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, the KmsKeyId parameter does not encrypt instance local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes." AsyncInferenceConfig: $ref: "#/components/schemas/AsyncInferenceConfig" description: Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync. @@ -2317,6 +2326,58 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateInferenceRecommendationsJobResponse" + /CreateJob: + post: + operationId: CreateJob + description: "Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM role that grants Amazon SageMaker permission to access resources on your behalf. Use the AgentRFT category to fine-tune a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics such as pass@k and mean reward. Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified by JobConfigSchemaVersion. The following operations are related to CreateJob: DescribeJob ListJobs StopJob DeleteJob ListJobSchemaVersions DescribeJobSchemaVersion" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.CreateJob + default: SageMaker.CreateJob + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job. The name must be unique within your account and Amazon Web Services Region. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job. The category determines the type of workload that the job runs. + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category. + JobConfigDocument: + $ref: "#/components/schemas/JobConfigDocument" + description: The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation. + Tags: + $ref: "#/components/schemas/TagList" + description: An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources. + required: + - JobName + - RoleArn + - JobCategory + - JobConfigSchemaVersion + - JobConfigDocument + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateJobResponse" /CreateLabelingJob: post: operationId: CreateLabelingJob @@ -3081,7 +3142,7 @@ paths: description: Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users. PlatformIdentifier: $ref: "#/components/schemas/PlatformIdentifier" - description: The platform identifier of the notebook instance runtime environment. The default value is notebook-al2-v2. + description: The platform identifier of the notebook instance runtime environment. The default value is notebook-al2023-v1. InstanceMetadataServiceConfiguration: $ref: "#/components/schemas/InstanceMetadataServiceConfiguration" description: Information on the IMDS configuration of the notebook instance @@ -3191,6 +3252,9 @@ paths: VpcConfig: $ref: "#/components/schemas/OptimizationVpcConfig" description: A VPC in Amazon VPC that your optimized model has access to. + TrainingPlanArns: + $ref: "#/components/schemas/OptimizationJobTrainingPlanArns" + description: The Amazon Resource Name (ARN) of the training plan to use for this optimization job. When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. You can specify at most one training plan. For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans. required: - OptimizationJobName - RoleArn @@ -5315,6 +5379,43 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteInferenceExperimentResponse" + /DeleteJob: + post: + operationId: DeleteJob + description: "Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before deleting it by calling StopJob. The following operations are related to DeleteJob: CreateJob StopJob DescribeJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.DeleteJob + default: SageMaker.DeleteJob + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job to delete. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job to delete. + required: + - JobName + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteJobResponse" /DeleteMlflowApp: post: operationId: DeleteMlflowApp @@ -7534,6 +7635,79 @@ paths: application/json: schema: $ref: "#/components/schemas/DescribeInferenceRecommendationsJobResponse" + /DescribeJob: + post: + operationId: DescribeJob + description: "Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps. The following operations are related to DescribeJob: CreateJob ListJobs StopJob DeleteJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.DescribeJob + default: SageMaker.DescribeJob + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job to describe. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job. + required: + - JobName + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeJobResponse" + /DescribeJobSchemaVersion: + post: + operationId: DescribeJobSchemaVersion + description: "Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration. The following operations are related to DescribeJobSchemaVersion: ListJobSchemaVersions CreateJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.DescribeJobSchemaVersion + default: SageMaker.DescribeJobSchemaVersion + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job schema to describe. + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The version of the schema to retrieve. If not specified, the latest version is returned. + required: + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribeJobSchemaVersionResponse" /DescribeLabelingJob: post: operationId: DescribeLabelingJob @@ -7733,7 +7907,7 @@ paths: /DescribeModelCard: post: operationId: DescribeModelCard - description: Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card. + description: Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card. To retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model card Content and requires kms:Decrypt permission when a customer-managed key is configured. parameters: - name: X-Amz-Target in: header @@ -7757,6 +7931,9 @@ paths: ModelCardVersion: $ref: "#/components/schemas/Integer" description: The version of the model card to describe. If a version is not provided, then the latest version of the model card is described. + IncludedData: + $ref: "#/components/schemas/IncludedData" + description: "Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key. AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default. MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content. If you don't specify a value, SageMaker returns AllData." required: - ModelCardName responses: @@ -7835,7 +8012,7 @@ paths: /DescribeModelPackage: post: operationId: DescribeModelPackage - description: Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace. If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace. + description: Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace. If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To call this operation without requiring kms:Decrypt permission on the customer-managed key, set IncludedData to MetadataOnly; the response is returned with the embedded ModelCard.ModelCardContent field sanitized. To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace. parameters: - name: X-Amz-Target in: header @@ -7856,6 +8033,9 @@ paths: ModelPackageName: $ref: "#/components/schemas/VersionedArnOrName" description: The name or Amazon Resource Name (ARN) of the model package to describe. When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). + IncludedData: + $ref: "#/components/schemas/IncludedData" + description: "Specifies the level of model package data to include in the response. Use this parameter to call DescribeModelPackage on a model package that has an associated model card without requiring kms:Decrypt permission on the customer-managed KMS key associated with the embedded model card. AllData: Returns the full model package response, including the unredacted ModelCard.ModelCardContent. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the embedded model card. This is the default. MetadataOnly: Returns the full model package response, but with the embedded ModelCard.ModelCardContent sanitized to include only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. All other top-level response fields, including InferenceSpecification, ModelMetrics, DriftCheckBaselines, and SecurityConfig, are returned unchanged. For the list of fields preserved within ModelCardContent, see ModelCard. If you don't specify a value, SageMaker returns AllData." required: - ModelPackageName responses: @@ -11401,6 +11581,108 @@ paths: application/json: schema: $ref: "#/components/schemas/ListInferenceRecommendationsJobsResponse" + /ListJobSchemaVersions: + post: + operationId: ListJobSchemaVersions + description: "Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document. The following operations are related to ListJobSchemaVersions: DescribeJobSchemaVersion CreateJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.ListJobSchemaVersions + default: SageMaker.ListJobSchemaVersions + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of job schemas to list. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If the previous response was truncated, this token retrieves the next set of results. + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of schema versions to return in the response. The default value is 5. + required: + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListJobSchemaVersionsResponse" + /ListJobs: + post: + operationId: ListJobs + description: "Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently. The following operations are related to ListJobs: CreateJob DescribeJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.ListJobs + default: SageMaker.ListJobs + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of jobs to list. + NextToken: + $ref: "#/components/schemas/NextToken" + description: If the previous response was truncated, this token retrieves the next set of results. + MaxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of jobs to return in the response. The default value is 50. + CreationTimeAfter: + $ref: "#/components/schemas/Timestamp" + description: A filter that returns only jobs created after the specified time. + CreationTimeBefore: + $ref: "#/components/schemas/Timestamp" + description: A filter that returns only jobs created before the specified time. + LastModifiedTimeAfter: + $ref: "#/components/schemas/Timestamp" + description: A filter that returns only jobs modified after the specified time. + LastModifiedTimeBefore: + $ref: "#/components/schemas/Timestamp" + description: A filter that returns only jobs modified before the specified time. + NameContains: + $ref: "#/components/schemas/NameContains" + description: A string in the job name to filter results. Only jobs whose name contains the specified string are returned. + SortBy: + $ref: "#/components/schemas/SortBy" + description: The field to sort results by. + SortOrder: + $ref: "#/components/schemas/SortOrder" + description: The sort order for results. Valid values are Ascending and Descending. + StatusEquals: + $ref: "#/components/schemas/JobStatus" + description: A filter that returns only jobs with the specified status. + required: + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListJobsResponse" /ListLabelingJobs: post: operationId: ListLabelingJobs @@ -14711,6 +14993,43 @@ paths: responses: "200": description: Success + /StopJob: + post: + operationId: StopJob + description: "Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in progress. To delete a stopped job, call DeleteJob. The following operations are related to StopJob: CreateJob DescribeJob DeleteJob" + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - SageMaker.StopJob + default: SageMaker.StopJob + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job to stop. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job to stop. + required: + - JobName + - JobCategory + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StopJobResponse" /StopLabelingJob: post: operationId: StopLabelingJob @@ -15143,6 +15462,9 @@ paths: RestrictedInstanceGroups: $ref: "#/components/schemas/ClusterRestrictedInstanceGroupSpecifications" description: The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster. + RestrictedInstanceGroupsConfig: + $ref: "#/components/schemas/ClusterRestrictedInstanceGroupsConfig" + description: The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster. TieredStorageConfig: $ref: "#/components/schemas/ClusterTieredStorageConfig" description: Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage. @@ -15504,6 +15826,9 @@ paths: TagPropagation: $ref: "#/components/schemas/TagPropagation" description: Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED. + HomeEfsFileSystemCreation: + $ref: "#/components/schemas/HomeEfsFileSystemCreation" + description: Indicates whether to create a home EFS file system for the domain. You can change from Disabled to Enabled to provision EFS on demand, but you cannot change from Enabled to Disabled. VpcId: $ref: "#/components/schemas/VpcId" description: The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes. @@ -17433,6 +17758,90 @@ components: - ml.g7e.24xlarge - ml.g7e.48xlarge - ml.p6-b300.48xlarge + - ml.g4dn.xlarge + - ml.g4dn.2xlarge + - ml.g4dn.4xlarge + - ml.g4dn.8xlarge + - ml.g4dn.12xlarge + - ml.g4dn.16xlarge + - ml.c6g.medium + - ml.c6g.large + - ml.c6g.xlarge + - ml.c6g.2xlarge + - ml.c6g.4xlarge + - ml.c6g.8xlarge + - ml.c6g.12xlarge + - ml.c6g.16xlarge + - ml.c7g.medium + - ml.c7g.large + - ml.c7g.xlarge + - ml.c7g.2xlarge + - ml.c7g.4xlarge + - ml.c7g.8xlarge + - ml.c7g.12xlarge + - ml.c7g.16xlarge + - ml.c8g.medium + - ml.c8g.large + - ml.c8g.xlarge + - ml.c8g.2xlarge + - ml.c8g.4xlarge + - ml.c8g.8xlarge + - ml.c8g.12xlarge + - ml.c8g.16xlarge + - ml.c8g.24xlarge + - ml.c8g.48xlarge + - ml.c6a.large + - ml.c6a.xlarge + - ml.c6a.2xlarge + - ml.c6a.4xlarge + - ml.c6a.8xlarge + - ml.c6a.12xlarge + - ml.c6a.16xlarge + - ml.c6a.24xlarge + - ml.c6a.32xlarge + - ml.c6a.48xlarge + - ml.m6a.large + - ml.m6a.xlarge + - ml.m6a.2xlarge + - ml.m6a.4xlarge + - ml.m6a.8xlarge + - ml.m6a.12xlarge + - ml.m6a.16xlarge + - ml.m6a.24xlarge + - ml.m6a.32xlarge + - ml.m6a.48xlarge + - ml.m6g.medium + - ml.m6g.large + - ml.m6g.xlarge + - ml.m6g.2xlarge + - ml.m6g.4xlarge + - ml.m6g.8xlarge + - ml.m6g.12xlarge + - ml.m6g.16xlarge + - ml.m7g.medium + - ml.m7g.large + - ml.m7g.xlarge + - ml.m7g.2xlarge + - ml.m7g.4xlarge + - ml.m7g.8xlarge + - ml.m7g.12xlarge + - ml.m7g.16xlarge + - ml.m8g.medium + - ml.m8g.large + - ml.m8g.xlarge + - ml.m8g.2xlarge + - ml.m8g.4xlarge + - ml.m8g.8xlarge + - ml.m8g.12xlarge + - ml.m8g.16xlarge + - ml.m8g.24xlarge + - ml.m8g.48xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge BatchAddClusterNodesResponse: type: object properties: @@ -17821,6 +18230,9 @@ components: S3OutputLocation: $ref: "#/components/schemas/S3Uri" description: The Amazon S3 URI where benchmark results are stored. + MlflowConfig: + $ref: "#/components/schemas/AIMlflowConfig" + description: The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled. required: - S3OutputLocation S3Uri: @@ -17828,6 +18240,36 @@ components: minLength: 0 maxLength: 1024 pattern: (https|s3)://([^/]+)/?(.*) + AIMlflowConfig: + description: The MLflow tracking configuration for logging metrics and parameters to a SageMaker managed MLflow tracking server. + type: object + properties: + MlflowResourceArn: + $ref: "#/components/schemas/AIMlflowResourceArn" + description: The Amazon Resource Name (ARN) of the SageMaker managed MLflow resource. + MlflowExperimentName: + $ref: "#/components/schemas/AIMlflowExperimentName" + description: The MLflow experiment name used for tracking. + MlflowRunName: + $ref: "#/components/schemas/AIMlflowRunName" + description: The MLflow run name used for tracking. + required: + - MlflowResourceArn + AIMlflowResourceArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-(app|tracking-server)/.* + AIMlflowExperimentName: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9\\-_./]+" + AIMlflowRunName: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9\\-_./]+" RoleArn: type: string minLength: 20 @@ -17908,6 +18350,9 @@ components: ModelPackageGroupIdentifier: $ref: "#/components/schemas/AIResourceIdentifier" description: The name or Amazon Resource Name (ARN) of the model package group where the optimized model is registered as a new model package version. + MlflowConfig: + $ref: "#/components/schemas/AIMlflowConfig" + description: The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled. AIRecommendationPerformanceTarget: description: The performance targets for an AI recommendation job. type: object @@ -17991,6 +18436,12 @@ components: - ml.g6e.16xlarge - ml.g6e.24xlarge - ml.g6e.48xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge - ml.g7e.2xlarge - ml.g7e.4xlarge - ml.g7e.8xlarge @@ -18006,6 +18457,7 @@ components: - ml.p5.48xlarge - ml.p5e.48xlarge - ml.p5en.48xlarge + - ml.p6-b200.48xlarge AICapacityReservationConfig: description: The capacity reservation configuration for an AI recommendation job. type: object @@ -18029,6 +18481,56 @@ components: minLength: 0 maxLength: 256 pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z0-9\-]{1,14}/.* + AIAdapterSource: + description: The source of LoRA adapters for an AI recommendation job. This is a union type — specify exactly one of the members. + type: object + properties: + ModelPackageArns: + $ref: "#/components/schemas/AIAdapterModelPackageEntryList" + description: A list of LoRA adapters identified by their model package ARNs. Use this when your adapters were produced by a SageMaker AI fine-tuning workflow that registers model packages. + S3Uris: + $ref: "#/components/schemas/AIAdapterS3EntryList" + description: A list of LoRA adapters identified by their Amazon S3 URIs. Use this when your adapters are stored as raw artifacts in Amazon S3. + AIAdapterModelPackageEntryList: + type: array + items: + $ref: "#/components/schemas/AIAdapterModelPackageEntry" + AIAdapterModelPackageEntry: + description: A LoRA adapter entry identified by a model package ARN. + type: object + properties: + AdapterId: + $ref: "#/components/schemas/AIAdapterId" + description: A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long. + ModelPackageArn: + $ref: "#/components/schemas/ModelPackageArn" + description: The Amazon Resource Name (ARN) of the model package that contains the LoRA adapter artifacts. + required: + - AdapterId + - ModelPackageArn + AIAdapterId: + description: A unique identifier for a LoRA adapter within a recommendation job request. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long. This ID is used as the inference component name when the adapter is deployed. + type: string + minLength: 1 + maxLength: 63 + pattern: "[a-zA-Z0-9](-*[a-zA-Z0-9])*" + AIAdapterS3EntryList: + type: array + items: + $ref: "#/components/schemas/AIAdapterS3Entry" + AIAdapterS3Entry: + description: A LoRA adapter entry identified by an Amazon S3 URI. + type: object + properties: + AdapterId: + $ref: "#/components/schemas/AIAdapterId" + description: A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long. + S3Uri: + $ref: "#/components/schemas/S3Uri" + description: The Amazon S3 URI of the directory that contains the LoRA adapter artifacts in PEFT format. + required: + - AdapterId + - S3Uri CreateAIRecommendationJobResponse: type: object properties: @@ -18504,6 +19006,12 @@ components: - ml.g7e.12xlarge - ml.g7e.24xlarge - ml.g7e.48xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge MetricDefinitionList: type: array items: @@ -19136,6 +19644,12 @@ components: - ml.g7e.12xlarge - ml.g7e.24xlarge - ml.g7e.48xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge - ml.p4d.24xlarge - ml.c7g.large - ml.c7g.xlarge @@ -19820,7 +20334,6 @@ components: maxLength: 2048 pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:algorithm/[\S]{1,2048} DomainId: - description: Types duplicated from IronmanApiServiceModel for federation. These types are defined in other service directories and are not available via IronmanApiServiceCommonModel. type: string minLength: 0 maxLength: 63 @@ -20056,6 +20569,18 @@ components: - ml.r6id.24xlarge - ml.r6id.32xlarge - ml.p5.4xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge + - ml.g7e.2xlarge + - ml.g7e.4xlarge + - ml.g7e.8xlarge + - ml.g7e.12xlarge + - ml.g7e.24xlarge + - ml.g7e.48xlarge StudioLifecycleConfigArn: type: string minLength: 0 @@ -20844,7 +21369,13 @@ components: description: The configuration object of the schedule that SageMaker uses to update the AMI. ImageId: $ref: "#/components/schemas/ImageId" - description: "When configuring your HyperPod cluster, you can specify an image ID using one of the following options: HyperPodPublicAmiId: Use a HyperPod public AMI CustomAmiId: Use your custom AMI default: Use the default latest system image If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements: Encryption: The custom AMI must be unencrypted. Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster. Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported. When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image." + description: "When configuring your HyperPod cluster, you can specify an image ID using one of the following options: HyperPodPublicAmiId: Use a HyperPod public AMI CustomAmiId: Use your custom AMI default: Use the default latest system image. For clusters with continuous scaling node provisioning mode, new instance groups inherit the AMI from the earliest existing instance group If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements: Encryption: The custom AMI must be unencrypted. Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster. Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported. When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image." + AutoPatchConfig: + $ref: "#/components/schemas/ClusterAutoPatchConfig" + description: The configuration for automatic OS security patching. If present, the system automatically applies PATCH AMI updates to this instance group. + ImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The version of the HyperPod-managed AMI to use for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH (for example, 1.2.3). If omitted, the latest available version is used. KubernetesConfig: $ref: "#/components/schemas/ClusterKubernetesConfig" description: Specifies the Kubernetes configuration for the instance group. You describe what you want the labels and taints to look like, and the cluster works to reconcile the actual state with the declared state for nodes in this instance group. @@ -21071,6 +21602,39 @@ components: minLength: 7 maxLength: 21 pattern: ami-[0-9a-fA-F]{8,17}|default + ClusterAutoPatchConfig: + description: The configuration for automatic patching of the instance group. When configured, the system automatically applies security patch AMI updates to the instance group. + type: object + properties: + PatchingStrategy: + $ref: "#/components/schemas/ClusterPatchingStrategy" + description: "The strategy for applying patches to instances in the group. WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances. WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version." + PatchSchedule: + $ref: "#/components/schemas/ClusterPatchSchedule" + description: The schedule for automatic patching, including the next patch date. + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfiguration" + description: The deployment configuration for rolling patch updates, including rollback settings and batch sizes. Only applicable when using a rolling patching strategy. + required: + - PatchingStrategy + ClusterPatchingStrategy: + description: "The strategy for applying automatic patches to instances. WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances. WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version." + type: string + enum: + - WhenIdle + - WhenAllIdle + ClusterPatchSchedule: + description: The schedule configuration for automatic patching. + type: object + properties: + NextPatchDate: + $ref: "#/components/schemas/Timestamp" + description: The date and time of the next scheduled automatic patch. The system sets this automatically when a patch is detected. Use this field to reschedule the patch to a different date. + ImageReleaseVersion: + type: string + minLength: 0 + maxLength: 64 + pattern: "[0-9]+\\.[0-9]+\\.[0-9]+" ClusterKubernetesConfig: description: Kubernetes configuration that specifies labels and taints to be applied to cluster nodes in an instance group. type: object @@ -21245,6 +21809,34 @@ components: type: integer minimum: 125 maximum: 1000 + ClusterRestrictedInstanceGroupsConfig: + description: The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster. + type: object + properties: + SharedEnvironmentConfig: + $ref: "#/components/schemas/ClusterSharedEnvironmentConfig" + description: The shared environment configuration for the restricted instance groups (RIG). + required: + - SharedEnvironmentConfig + ClusterSharedEnvironmentConfig: + description: The shared environment configuration for the restricted instance groups (RIG). + type: object + properties: + FSxLustreDeletionPolicy: + $ref: "#/components/schemas/ClusterFSxLustreDeletionPolicy" + description: The deletion policy for the Amazon FSx for Lustre file system in the shared environment. + FSxLustreConfig: + $ref: "#/components/schemas/FSxLustreConfig" + description: Configuration settings for an Amazon FSx for Lustre file system in the shared environment. + required: + - FSxLustreDeletionPolicy + - FSxLustreConfig + ClusterFSxLustreDeletionPolicy: + description: The deletion policy for the Amazon FSx for Lustre file system used in the shared environment of restricted instance groups (RIG). + type: string + enum: + - DeleteIfNotUsed + - Keep ClusterOrchestrator: description: The type of orchestrator used for the SageMaker HyperPod cluster. type: object @@ -22303,6 +22895,12 @@ components: - ml.g7e.12xlarge - ml.g7e.24xlarge - ml.g7e.48xlarge + - ml.g7.2xlarge + - ml.g7.4xlarge + - ml.g7.8xlarge + - ml.g7.12xlarge + - ml.g7.24xlarge + - ml.g7.48xlarge ProcessingVolumeSizeInGB: type: integer minimum: 1 @@ -23164,6 +23762,12 @@ components: enum: - Service - Customer + HomeEfsFileSystemCreation: + description: Indicates whether a home EFS file system is created for the domain. + type: string + enum: + - Enabled + - Disabled TagPropagation: type: string enum: @@ -23688,7 +24292,10 @@ components: properties: RoutingStrategy: $ref: "#/components/schemas/RoutingStrategy" - description: "Sets how the endpoint routes incoming traffic: LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them. RANDOM: The endpoint routes each request to a randomly chosen instance." + description: "Sets how the endpoint routes incoming traffic: LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them. RANDOM: The endpoint routes each request to a randomly chosen instance. PREFIX_AWARE: The endpoint routes requests that share the same prompt prefix to the same instance. When the number of in-flight requests on the selected instance reaches the configured threshold, the endpoint routes the request to an instance with more available capacity." + PrefixAwareRoutingConfig: + $ref: "#/components/schemas/PrefixAwareRoutingConfig" + description: The configuration for prefix-aware routing. Specify this parameter only when you set RoutingStrategy to PREFIX_AWARE. required: - RoutingStrategy RoutingStrategy: @@ -23696,6 +24303,25 @@ components: enum: - LEAST_OUTSTANDING_REQUESTS - RANDOM + - PREFIX_AWARE + PrefixAwareRoutingConfig: + description: The configuration for prefix-aware routing on a SageMaker real-time inference endpoint. Specify PrefixLength and ConcurrencyThreshold to control routing behavior. + type: object + properties: + PrefixLength: + $ref: "#/components/schemas/PrefixAwareRoutingPrefixLength" + description: The maximum length of the prefix used for routing decisions. Required when RoutingStrategy is PREFIX_AWARE. For the SageMaker Runtime InvokeEndpoint and InvokeEndpointWithResponseStream APIs, this value specifies the number of bytes from the beginning of the request body. For OpenAI-compatible API, this value specifies the number of characters from the text content of the messages array. The endpoint routes requests that share the same prefix to the same instance. Set this value to cover shared content (such as system prompts) plus enough unique content to distribute workloads across instances. + ConcurrencyThreshold: + $ref: "#/components/schemas/PrefixAwareRoutingConcurrencyThreshold" + description: The maximum number of in-flight requests on the target instance before the endpoint routes to another instance. Required when RoutingStrategy is PREFIX_AWARE. When in-flight requests on the prefix-selected instance reach this threshold, the endpoint routes the request to an instance with more available capacity. + PrefixAwareRoutingPrefixLength: + type: integer + minimum: 1024 + maximum: 65536 + PrefixAwareRoutingConcurrencyThreshold: + type: integer + minimum: 1 + maximum: 1024 ProductionVariantInferenceAmiVersion: type: string enum: @@ -24128,11 +24754,16 @@ components: EnableEnhancedMetrics: $ref: "#/components/schemas/EnableEnhancedMetrics" description: Specifies whether to enable enhanced metrics for the endpoint. Enhanced metrics provide utilization and invocation data at instance and container granularity. Container granularity is supported for Inference Components. The default is False. + EnableDetailedObservability: + $ref: "#/components/schemas/EnableDetailedObservability" + description: "Indicates whether detailed observability is enabled for the endpoint. When set to True, the following metrics are published at the configured frequency: Container-level inference metrics scraped from the container's Prometheus endpoint (such as request latency, error counts, and throughput). Available metrics vary by framework. Per-GPU metrics (utilization, memory, and temperature) attributed to individual inference components. Per-instance host metrics (CPU, memory, and disk utilization). Inference component placement metrics (copy count per Availability Zone). For first-party and Deep Learning Containers (DLC), the Prometheus endpoint path is determined automatically. For Bring-Your-Own-Container (BYOC) cases, you can optionally set ContainerMetricsConfig to specify a custom endpoint path. If not specified, the default path /metrics on port 8080 is used. When set to False, these additional metrics are not published. Standard invocation and utilization metrics controlled by EnableEnhancedMetrics are unaffected. The default value for new endpoint configurations is True. For existing endpoint configurations created before this feature, the value is False unless explicitly set." MetricPublishFrequencyInSeconds: $ref: "#/components/schemas/MetricPublishFrequencyInSeconds" - description: "The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to 60. Valid values: 10, 30, 60, 120, 180, 240, 300. When EnableEnhancedMetrics is set to False, this interval applies to utilization metrics only; invocation metrics continue to be published at the default 60-second interval. When EnableEnhancedMetrics is set to True, this interval applies to both utilization and invocation metrics." + description: "The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to 60. Valid values: 10, 30, 60, 120, 180, 240, 300. When EnableEnhancedMetrics is set to False, this interval applies to utilization metrics only. Invocation metrics continue to be published at the default 60-second interval. When EnableEnhancedMetrics is set to True, this interval applies to both utilization and invocation metrics. When EnableDetailedObservability is set to True, this interval applies to per-GPU metrics, per-instance host metrics, container metrics, and fleet-level inference component lifecycle and placement metrics." EnableEnhancedMetrics: type: boolean + EnableDetailedObservability: + type: boolean MetricPublishFrequencyInSeconds: type: integer CreateEndpointConfigOutput: @@ -25315,6 +25946,39 @@ components: type: object properties: {} description: The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map. + ContainerMetricsConfig: + $ref: "#/components/schemas/ContainerMetricsConfig" + description: The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency for the inference component's container. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional. + ContainerMetricsConfig: + description: The configuration for container-level metrics scraping. Use this configuration to specify a custom metrics endpoint path and publishing frequency for container metrics. When EnableDetailedObservability is set to True in MetricsConfig, metrics are scraped from the container's Prometheus endpoint. If this configuration is not provided, the default path /metrics on port 8080 is used with a default publishing frequency of 60 seconds. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional. + type: object + properties: + MetricsEndpoints: + $ref: "#/components/schemas/MetricsEndpointList" + description: A list of metrics endpoints to scrape from the container. Each endpoint specifies the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them. You can specify a maximum of 1 endpoint. + MetricsEndpointList: + description: A list of metrics endpoints for a container. + type: array + items: + $ref: "#/components/schemas/MetricsEndpoint" + MetricsEndpoint: + description: Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch. + type: object + properties: + MetricsEndpointPath: + $ref: "#/components/schemas/MetricsEndpointPath" + description: The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics. + MetricPublishFrequencyInSeconds: + $ref: "#/components/schemas/MetricPublishFrequencyInSeconds" + description: "The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60." + required: + - MetricsEndpointPath + MetricsEndpointPath: + description: Per-container Prometheus metrics scraping configuration + type: string + minLength: 0 + maxLength: 256 + pattern: /(?!.*\.\.)[a-zA-Z0-9/_.\-]+ InferenceComponentStartupParameters: description: Settings that take effect while the model container starts up. type: object @@ -25948,6 +26612,38 @@ components: minLength: 0 maxLength: 256 pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-recommendations-job/.* + JobName: + type: string + minLength: 1 + maxLength: 63 + pattern: "[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + JobCategory: + type: string + enum: + - AgentRFT + - AgentRFTEvaluation + JobSchemaVersion: + type: string + minLength: 5 + maxLength: 16 + pattern: \d+\.\d+\.\d+ + JobConfigDocument: + type: string + minLength: 1 + maxLength: 262144 + CreateJobResponse: + type: object + properties: + JobArn: + $ref: "#/components/schemas/JobArn" + description: The Amazon Resource Name (ARN) of the job. + required: + - JobArn + JobArn: + type: string + minLength: 0 + maxLength: 256 + pattern: arn:(aws[a-z\-]*):sagemaker:[a-z0-9\-]+:[0-9]{12}:job/[a-zA-Z0-9]+/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} LabelingJobName: type: string minLength: 1 @@ -26297,6 +26993,9 @@ components: MultiModelConfig: $ref: "#/components/schemas/MultiModelConfig" description: Specifies additional configuration for multi-model endpoints. + ContainerMetricsConfig: + $ref: "#/components/schemas/ContainerMetricsConfig" + description: The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional. ImageConfig: description: Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). type: object @@ -27277,6 +27976,22 @@ components: - ml.g6.16xlarge - ml.g6.24xlarge - ml.g6.48xlarge + - ml.g7e.2xlarge + - ml.g7e.4xlarge + - ml.g7e.8xlarge + - ml.g7e.12xlarge + - ml.g7e.24xlarge + - ml.g7e.48xlarge + - ml.p5.4xlarge + - ml.p5en.48xlarge + - ml.g6e.xlarge + - ml.g6e.2xlarge + - ml.g6e.4xlarge + - ml.g6e.8xlarge + - ml.g6e.12xlarge + - ml.g6e.16xlarge + - ml.g6e.24xlarge + - ml.g6e.48xlarge NotebookInstanceLifecycleConfigName: type: string minLength: 0 @@ -27456,6 +28171,13 @@ components: - ml.trn1.2xlarge - ml.trn1.32xlarge - ml.trn1n.32xlarge + - ml.p6-b200.48xlarge + - ml.g7e.2xlarge + - ml.g7e.4xlarge + - ml.g7e.8xlarge + - ml.g7e.12xlarge + - ml.g7e.24xlarge + - ml.g7e.48xlarge OptimizationJobMaxInstanceCount: type: integer minimum: 1 @@ -27600,6 +28322,11 @@ components: minLength: 0 maxLength: 32 pattern: "[-0-9a-zA-Z]+" + OptimizationJobTrainingPlanArns: + description: Amazon Resource Names (ARNs) of the training plans whose reserved capacity backs the optimization job. Bounded to a single plan for now; the list shape allows widening to multiple plans in the future without a breaking scalar-to-list change. + type: array + items: + $ref: "#/components/schemas/TrainingPlanArn" CreateOptimizationJobResponse: type: object properties: @@ -28141,8 +28868,6 @@ components: $ref: "#/components/schemas/KmsKeyId" description: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job. Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes. required: - - InstanceCount - - InstanceType - VolumeSizeInGB ProcessingStoppingCondition: description: Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped. @@ -28814,6 +29539,9 @@ components: EvaluatorArn: $ref: "#/components/schemas/EvaluatorArn" description: The evaluator Amazon Resource Name (ARN) used as reward function or reward prompt. + SequenceLength: + $ref: "#/components/schemas/SequenceLength" + description: "The maximum sequence length, in tokens, that the customization job supports. SageMaker uses this value to select a training configuration for the base model that you specify. The parameter supports the following values: 1K 2K 4K 8K 16K 32K 64K 128K If you don't specify a value, SageMaker selects a training configuration based on the other values that you specify. The selection is not restricted to a particular sequence length." required: - BaseModelArn - JobType @@ -28848,6 +29576,11 @@ components: EvaluatorArn: type: string pattern: .* + SequenceLength: + type: string + minLength: 1 + maxLength: 50 + pattern: \d+K MlflowConfig: description: The MLflow configuration using SageMaker managed MLflow. type: object @@ -29410,6 +30143,8 @@ components: description: The ARN of the deleted inference experiment. required: - InferenceExperimentArn + DeleteJobResponse: + type: object DeleteMlflowAppResponse: type: object properties: @@ -29537,6 +30272,9 @@ components: CloudWatchLogs: $ref: "#/components/schemas/AICloudWatchLogsList" description: The CloudWatch log information for the benchmark job. + MlflowConfig: + $ref: "#/components/schemas/AIMlflowConfig" + description: The MLflow tracking configuration for the job. required: - S3OutputLocation AICloudWatchLogsList: @@ -29595,6 +30333,9 @@ components: ComputeSpec: $ref: "#/components/schemas/AIRecommendationComputeSpec" description: The compute resource specification for the recommendation job. + AdapterSource: + $ref: "#/components/schemas/AIAdapterSource" + description: The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters. CreationTime: $ref: "#/components/schemas/Timestamp" description: A timestamp that indicates when the recommendation job was created. @@ -29634,6 +30375,9 @@ components: ModelPackageGroupIdentifier: $ref: "#/components/schemas/AIResourceIdentifier" description: The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages are registered. + MlflowConfig: + $ref: "#/components/schemas/AIMlflowConfig" + description: The MLflow tracking configuration for the job. required: - S3OutputLocation AIRecommendationList: @@ -29662,6 +30406,9 @@ components: ExpectedPerformance: $ref: "#/components/schemas/ExpectedPerformanceList" description: The expected performance metrics for this recommendation. + AdapterDetails: + $ref: "#/components/schemas/AIRecommendationAdapterDetails" + description: The LoRA adapter details for this recommendation. This field contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied. This field is absent when the job was created without LoRA adapters. AIRecommendationOptimizationDetailList: type: array items: @@ -29746,6 +30493,9 @@ components: type: object properties: {} description: The environment variables for the deployment. + MinCpuMemoryRequiredInMb: + $ref: "#/components/schemas/AIRecommendationMinCpuMemoryRequiredInMb" + description: The minimum host (CPU) memory, in MiB, to reserve for each model copy when deploying the recommendation as an Inference Component. This value maps to the Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb field. AIRecommendationDeploymentS3ChannelList: type: array items: @@ -29760,6 +30510,9 @@ components: Uri: $ref: "#/components/schemas/S3Uri" description: The Amazon S3 URI of the data for this channel. + AIRecommendationMinCpuMemoryRequiredInMb: + type: integer + minimum: 1 ExpectedPerformanceList: type: array items: @@ -29783,6 +30536,19 @@ components: required: - Metric - Value + AIRecommendationAdapterDetails: + description: The per-recommendation LoRA adapter details. Contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied in the request. When you supply only Amazon S3 URIs, Amazon SageMaker AI creates model packages on your behalf. + type: object + properties: + ModelPackageArns: + $ref: "#/components/schemas/AIAdapterModelPackageEntryList" + description: The list of LoRA adapters with their model package ARNs. + S3Uris: + $ref: "#/components/schemas/AIAdapterS3EntryList" + description: The list of LoRA adapters with their Amazon S3 URIs. + required: + - ModelPackageArns + - S3Uris DescribeAIWorkloadConfigResponse: type: object properties: @@ -30636,6 +31402,9 @@ components: RestrictedInstanceGroups: $ref: "#/components/schemas/ClusterRestrictedInstanceGroupDetailsList" description: The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster. + RestrictedInstanceGroupsConfig: + $ref: "#/components/schemas/ClusterRestrictedInstanceGroupsConfigOutput" + description: The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster. VpcConfig: $ref: "#/components/schemas/VpcConfig" Orchestrator: @@ -30729,12 +31498,21 @@ components: ScheduledUpdateConfig: $ref: "#/components/schemas/ScheduledUpdateConfig" description: The configuration object of the schedule that SageMaker follows when updating the AMI. + AutoPatchConfig: + $ref: "#/components/schemas/ClusterAutoPatchConfigDetails" + description: The auto-patching configuration for the instance group, including the current patching strategy and next scheduled patch date. CurrentImageId: $ref: "#/components/schemas/ImageId" description: The ID of the Amazon Machine Image (AMI) currently in use by the instance group. DesiredImageId: $ref: "#/components/schemas/ImageId" description: The ID of the Amazon Machine Image (AMI) desired for the instance group. + CurrentImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The version of the HyperPod-managed AMI currently running on the instance group. + DesiredImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The desired version of the HyperPod-managed AMI for the instance group. This may differ from the current version when an update is pending. ImageVersionStatus: $ref: "#/components/schemas/ClusterImageVersionStatus" description: The status of the image version for the instance group. Indicates whether the instance group is running the latest image version or if an update is available. @@ -30806,12 +31584,37 @@ components: type: string minLength: 1 maxLength: 63 + ClusterAutoPatchConfigDetails: + description: The auto-patching configuration details for the instance group, including the patching strategy and schedule. + type: object + properties: + PatchingStrategy: + $ref: "#/components/schemas/ClusterPatchingStrategy" + description: "The strategy used for applying patches to instances in the group. WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances. WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version." + CurrentPatchSchedule: + $ref: "#/components/schemas/ClusterPatchScheduleDetails" + description: The currently active patch schedule that the system will execute. + DesiredPatchSchedule: + $ref: "#/components/schemas/ClusterPatchScheduleDetails" + description: The requested patch schedule. Differs from CurrentPatchSchedule when a reschedule request is pending. + DeploymentConfig: + $ref: "#/components/schemas/DeploymentConfiguration" + description: The deployment configuration for rolling patch updates. + ClusterPatchScheduleDetails: + description: The schedule details for automatic patching, including the next scheduled patch date. + type: object + properties: + NextPatchDate: + $ref: "#/components/schemas/Timestamp" + description: The date and time of the next scheduled automatic patch. ClusterImageVersionStatus: - description: "The status of the Amazon Machine Image (AMI) version for the HyperPod cluster instance group, node, or cluster. The AMI version is determined at the instance group level, and all nodes within an instance group run the same AMI. The cluster-level status is aggregated across all instance groups. UpToDate: The resource is running the latest available AMI version. UpdateAvailable: A newer AMI version is available for the resource." + description: "The status of the Amazon Machine Image (AMI) version for the HyperPod cluster instance group, node, or cluster. The AMI version is determined at the instance group level, and all nodes within an instance group run the same AMI. The cluster-level status is aggregated across all instance groups. UpToDate: The resource is running the latest available AMI version. UpdateAvailable: A newer AMI version is available for the resource. SecurityUpdateRequired: The current AMI has known security vulnerabilities, and a patched version is available. EndOfLife: The AMI variant has reached end of support and an upgrade is required." type: string enum: - UpToDate - UpdateAvailable + - SecurityUpdateRequired + - EndOfLife ClusterKubernetesConfigDetails: description: Detailed Kubernetes configuration showing both the current and desired state of labels and taints for cluster nodes. type: object @@ -30916,6 +31719,31 @@ components: S3OutputPath: $ref: "#/components/schemas/S3Uri" description: The Amazon S3 path where output data from the restricted instance group (RIG) environment will be stored. + ClusterRestrictedInstanceGroupsConfigOutput: + description: The output configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster. + type: object + properties: + SharedEnvironmentConfig: + $ref: "#/components/schemas/ClusterSharedEnvironmentConfigDetails" + description: The shared environment configuration details for the restricted instance groups (RIG). + required: + - SharedEnvironmentConfig + ClusterSharedEnvironmentConfigDetails: + description: The shared environment configuration details for the restricted instance groups (RIG). + type: object + properties: + CurrentFSxLustreConfig: + $ref: "#/components/schemas/FSxLustreConfig" + description: The current Amazon FSx for Lustre file system configuration in the shared environment. + DesiredFSxLustreConfig: + $ref: "#/components/schemas/FSxLustreConfig" + description: The desired Amazon FSx for Lustre file system configuration in the shared environment. + CurrentFSxLustreDeletionPolicy: + $ref: "#/components/schemas/ClusterFSxLustreDeletionPolicy" + description: The current deletion policy for the Amazon FSx for Lustre file system in the shared environment. + DesiredFSxLustreDeletionPolicy: + $ref: "#/components/schemas/ClusterFSxLustreDeletionPolicy" + description: The desired deletion policy for the Amazon FSx for Lustre file system in the shared environment. ClusterAutoScalingConfigOutput: description: The autoscaling configuration and status information for a HyperPod cluster. type: object @@ -31213,6 +32041,12 @@ components: DesiredImageId: $ref: "#/components/schemas/ImageId" description: The ID of the Amazon Machine Image (AMI) desired for the node. + CurrentImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The version of the HyperPod-managed AMI currently running on the node. + DesiredImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The desired version of the HyperPod-managed AMI for the node. This may differ from the current version when an update is pending. ImageVersionStatus: $ref: "#/components/schemas/ClusterImageVersionStatus" description: The status of the image version for the cluster node. @@ -31813,6 +32647,9 @@ components: AppSecurityGroupManagement: $ref: "#/components/schemas/AppSecurityGroupManagement" description: The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. + HomeEfsFileSystemCreation: + $ref: "#/components/schemas/HomeEfsFileSystemCreation" + description: Indicates whether a home EFS file system is created for the domain. TagPropagation: $ref: "#/components/schemas/TagPropagation" description: Indicates whether custom tag propagation is supported for the domain. @@ -33338,6 +34175,9 @@ components: type: object properties: {} description: The environment variables to set in the Docker container. + ContainerMetricsConfig: + $ref: "#/components/schemas/ContainerMetricsConfig" + description: The container metrics scraping configuration for this inference component, including the metrics endpoint path and publishing frequency. InferenceComponentDataCacheConfigSummary: description: Settings that affect how the inference component caches data. type: object @@ -33786,6 +34626,129 @@ components: required: - MaxInvocations - ModelLatency + DescribeJobResponse: + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job. + JobArn: + $ref: "#/components/schemas/JobArn" + description: The Amazon Resource Name (ARN) of the job. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role associated with the job. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job. + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The schema version used for the job configuration document. + JobConfigDocument: + $ref: "#/components/schemas/JobConfigDocument" + description: The JSON configuration document for the job. + CreationTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was created. + LastModifiedTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was last modified. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job ended. + JobStatus: + $ref: "#/components/schemas/JobStatus" + description: The current status of the job. + SecondaryStatus: + $ref: "#/components/schemas/JobSecondaryStatus" + description: The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases. + SecondaryStatusTransitions: + $ref: "#/components/schemas/JobSecondaryStatusTransitions" + description: A list of secondary status transitions for the job, with timestamps and optional status messages. + FailureReason: + $ref: "#/components/schemas/FailureReason" + description: If the job failed, the reason it failed. + Tags: + $ref: "#/components/schemas/TagList" + description: The tags associated with the job. + required: + - JobName + - JobArn + - RoleArn + - JobCategory + - JobConfigSchemaVersion + - CreationTime + - LastModifiedTime + - JobStatus + - SecondaryStatus + - SecondaryStatusTransitions + JobStatus: + type: string + enum: + - InProgress + - Completed + - Failed + - Stopping + - Stopped + - Deleting + - DeleteFailed + JobSecondaryStatus: + type: string + enum: + - Starting + - Downloading + - Training + - Uploading + - Stopping + - Stopped + - MaxRuntimeExceeded + - Interrupted + - Failed + - Completed + - Restarting + - Pending + - Evaluating + - Deleting + - DeleteFailed + JobSecondaryStatusTransitions: + type: array + items: + $ref: "#/components/schemas/JobSecondaryStatusTransition" + JobSecondaryStatusTransition: + description: Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details. + type: object + properties: + Status: + $ref: "#/components/schemas/JobSecondaryStatus" + description: The secondary status of the job at this transition point. + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the status transition started. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the status transition ended. + StatusMessage: + $ref: "#/components/schemas/String" + description: A detailed message about the status transition. + required: + - Status + - StartTime + DescribeJobSchemaVersionResponse: + type: object + properties: + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job schema. + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The version of the schema. + JobConfigSchema: + $ref: "#/components/schemas/JobConfigDocument" + description: The JSON schema document that defines the structure of the job configuration. + required: + - JobCategory + - JobConfigSchemaVersion + - JobConfigSchema DescribeLabelingJobResponse: type: object properties: @@ -34196,6 +35159,11 @@ components: - ModelBiasJobOutputConfig - JobResources - RoleArn + IncludedData: + type: string + enum: + - AllData + - MetadataOnly DescribeModelCardResponse: type: object properties: @@ -34210,7 +35178,7 @@ components: description: The version of the model card. Content: $ref: "#/components/schemas/ModelCardContent" - description: The content of the model card. + description: "The content of the model card. Content is provided as a string in the model card JSON schema. When you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes only the following JSON paths, when present in the model card: model_overview.model_id model_overview.model_name intended_uses.risk_rating model_package_details.model_package_group_name model_package_details.model_package_arn All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the complete Content, set IncludedData to AllData or omit the parameter." ModelCardStatus: $ref: "#/components/schemas/ModelCardStatus" description: "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. Draft: The model card is a work in progress. PendingReview: The model card is pending review. Approved: The model card is approved. Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported." @@ -34436,7 +35404,7 @@ components: description: The KMS Key ID (KMSKeyId) used for encryption of model package information. ModelCard: $ref: "#/components/schemas/ModelPackageModelCard" - description: The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version. + description: "The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version. When you set IncludedData to MetadataOnly in the request, ModelCardStatus is preserved and ModelCardContent is sanitized to include only the following JSON paths, when present in the model card: model_overview.model_id model_overview.model_name intended_uses.risk_rating model_package_details.model_package_group_name model_package_details.model_package_arn Because the ModelPackageModelCard schema does not include model_package_details and limits model_overview to model_creator and model_artifact, the sanitized ModelCardContent for a model package typically contains only intended_uses.risk_rating if it was provided when the model card was created. To retrieve the complete ModelCardContent, set IncludedData to AllData or omit the parameter." ModelLifeCycle: $ref: "#/components/schemas/ModelLifeCycle" description: A structure describing the current state of the model in its life cycle. @@ -34763,6 +35731,8 @@ components: - Failed - Deleting - Updating + - PendingMaintenance + - InMaintenance NetworkInterfaceId: type: string DescribeNotebookInstanceLifecycleConfigOutput: @@ -34843,6 +35813,9 @@ components: VpcConfig: $ref: "#/components/schemas/OptimizationVpcConfig" description: A VPC in Amazon VPC that your optimized model has access to. + TrainingPlanArns: + $ref: "#/components/schemas/OptimizationJobTrainingPlanArns" + description: The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field. required: - OptimizationJobArn - OptimizationJobStatus @@ -36159,6 +37132,9 @@ components: AvailabilityZone: $ref: "#/components/schemas/AvailabilityZone" description: The availability zone for the reserved capacity. + AvailabilityZoneId: + $ref: "#/components/schemas/AvailabilityZoneId" + description: The Availability Zone ID of the reserved capacity. DurationHours: $ref: "#/components/schemas/ReservedCapacityDurationHours" description: The number of whole hours in the total duration for this reserved capacity. @@ -36176,6 +37152,9 @@ components: - InstanceType - TotalInstanceCount - Status + AvailabilityZoneId: + type: string + pattern: "[a-z]{3}\\d-az\\d" DescribeTrainingPlanExtensionHistoryResponse: type: object properties: @@ -36232,9 +37211,6 @@ components: - TrainingPlanExtensionOfferingId TrainingPlanExtensionOfferingId: type: string - AvailabilityZoneId: - type: string - pattern: "[a-z]{3}\\d-az\\d" TrainingPlanExtensionDurationHours: type: integer minimum: 0 @@ -37048,6 +38024,7 @@ components: - HyperParameterTuningJob - ModelCard - PipelineVersion + - Job SuggestionQuery: description: Specified in the GetSearchSuggestions request. Limits the property names that are included in the response. type: object @@ -37730,6 +38707,9 @@ components: PrivateDnsHostname: $ref: "#/components/schemas/ClusterPrivateDnsHostname" description: The private DNS hostname of the SageMaker HyperPod cluster node. + CurrentImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The version of the HyperPod-managed AMI currently running on the node. ImageVersionStatus: $ref: "#/components/schemas/ClusterImageVersionStatus" description: The status of the image version for the cluster node. @@ -37826,6 +38806,9 @@ components: TrainingPlanArns: $ref: "#/components/schemas/TrainingPlanArns" description: A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster. For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan . + ImageVersionStatus: + $ref: "#/components/schemas/ClusterImageVersionStatus" + description: The aggregate status of the image version across the cluster's instance groups. required: - ClusterArn - ClusterName @@ -39205,12 +40188,87 @@ components: - CreationTime - RoleArn - LastModifiedTime + ListJobSchemaVersionsResponse: + type: object + properties: + NextToken: + $ref: "#/components/schemas/NextToken" + description: If the response is truncated, this token retrieves the next set of results. + JobConfigSchemas: + $ref: "#/components/schemas/JobConfigSchemas" + description: An array of JobConfigSchemaVersionSummary objects listing the available schema versions. + required: + - JobConfigSchemas + JobConfigSchemas: + type: array + items: + $ref: "#/components/schemas/JobConfigSchemaVersionSummary" + JobConfigSchemaVersionSummary: + description: Provides summary information about a job configuration schema version. + type: object + properties: + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The version of the job configuration schema. + required: + - JobConfigSchemaVersion SortBy: type: string enum: - Name - CreationTime - Status + ListJobsResponse: + type: object + properties: + NextToken: + $ref: "#/components/schemas/NextToken" + description: If the response is truncated, this token retrieves the next set of results. + JobSummaries: + $ref: "#/components/schemas/JobSummaries" + description: An array of JobSummary objects that provide summary information about the jobs. + required: + - JobSummaries + JobSummaries: + type: array + items: + $ref: "#/components/schemas/JobSummary" + JobSummary: + description: Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job. + type: object + properties: + JobArn: + $ref: "#/components/schemas/JobArn" + description: The Amazon Resource Name (ARN) of the job. + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job. + JobStatus: + $ref: "#/components/schemas/JobStatus" + description: The current status of the job. + JobSecondaryStatus: + $ref: "#/components/schemas/JobSecondaryStatus" + description: The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases. + CreationTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was created. + LastModifiedTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was last modified. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job ended. + required: + - JobArn + - JobName + - JobCategory + - JobStatus + - JobSecondaryStatus + - CreationTime + - LastModifiedTime ListLabelingJobsResponse: type: object properties: @@ -40437,6 +41495,9 @@ components: Lineage: $ref: "#/components/schemas/LineageMetadata" description: The metadata of the lineage used in pipeline execution step. + Job: + $ref: "#/components/schemas/JobStepMetadata" + description: The metadata for a SageMaker job used in a pipeline execution step. TrainingJobStepMetadata: description: Metadata for a training job step. type: object @@ -40717,6 +41778,13 @@ components: required: - SourceArn - DestinationArn + JobStepMetadata: + description: Metadata for a SageMaker job step. + type: object + properties: + Arn: + $ref: "#/components/schemas/String1024" + description: The Amazon Resource Name (ARN) of the SageMaker job that was run by this step execution. SelectiveExecutionResult: description: The ARN from an execution of the current pipeline. type: object @@ -42055,6 +43123,9 @@ components: description: An Amazon SageMaker Model Card that documents details about a machine learning model. Model: $ref: "#/components/schemas/ModelDashboardModel" + Job: + $ref: "#/components/schemas/Job" + description: The properties of a job. TrainingJob: description: Contains information about a training job. type: object @@ -43200,6 +44271,52 @@ components: RiskRating: $ref: "#/components/schemas/String" description: A model card's risk rating. Can be low, medium, or high. + Job: + description: The properties of a job returned by the Search API. + type: object + properties: + JobName: + $ref: "#/components/schemas/JobName" + description: The name of the job. + JobArn: + $ref: "#/components/schemas/JobArn" + description: The Amazon Resource Name (ARN) of the job. + RoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM role associated with the job. + JobCategory: + $ref: "#/components/schemas/JobCategory" + description: The category of the job. + JobConfigSchemaVersion: + $ref: "#/components/schemas/JobSchemaVersion" + description: The schema version used for the job configuration document. + JobConfigDocument: + $ref: "#/components/schemas/JobConfigDocument" + description: The JSON configuration document for the job. + CreationTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was created. + LastModifiedTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job was last modified. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the job ended. + JobStatus: + $ref: "#/components/schemas/JobStatus" + description: The current status of the job. + SecondaryStatus: + $ref: "#/components/schemas/JobSecondaryStatus" + description: The detailed secondary status of the job, providing more granular information about the job's progress. + SecondaryStatusTransitions: + $ref: "#/components/schemas/JobSecondaryStatusTransitions" + description: A list of secondary status transitions for the job, with timestamps and optional status messages. + FailureReason: + $ref: "#/components/schemas/FailureReason" + description: If the job failed, the reason it failed. + Tags: + $ref: "#/components/schemas/TagList" + description: The tags associated with the job. TotalHits: description: Represents the total number of matching results and indicates how accurate that count is. The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets. type: object @@ -43478,6 +44595,8 @@ components: description: The ARN of the stopped inference experiment. required: - InferenceExperimentArn + StopJobResponse: + type: object StopMlflowTrackingServerResponse: type: object properties: @@ -43552,6 +44671,9 @@ components: InstanceGroupName: $ref: "#/components/schemas/ClusterInstanceGroupName" description: The name of the instance group to update. + ImageReleaseVersion: + $ref: "#/components/schemas/ImageReleaseVersion" + description: The version of the HyperPod-managed AMI to update to for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH. required: - InstanceGroupName UpdateClusterSoftwareResponse: @@ -47424,6 +48546,93 @@ components: - $ref: "#/components/x-stackQL-resources/inference_recommendations_jobs/methods/create_inference_recommendations_job" update: [] delete: [] + jobs: + id: aws.sagemaker.jobs + name: jobs + title: jobs + methods: + create_job: + operation: + $ref: "#/paths/~1CreateJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_job: + operation: + $ref: "#/paths/~1DeleteJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + describe_job: + operation: + $ref: "#/paths/~1DescribeJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_jobs: + operation: + $ref: "#/paths/~1ListJobs/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.JobSummaries + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + stop_job: + operation: + $ref: "#/paths/~1StopJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/jobs/methods/describe_job" + - $ref: "#/components/x-stackQL-resources/jobs/methods/list_jobs" + insert: + - $ref: "#/components/x-stackQL-resources/jobs/methods/create_job" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/jobs/methods/delete_job" labeling_jobs: id: aws.sagemaker.labeling_jobs name: labeling_jobs @@ -50083,6 +51292,51 @@ components: update: - $ref: "#/components/x-stackQL-resources/feature_metadatas/methods/update_feature_metadata" delete: [] + job_schema_versions: + id: aws.sagemaker.job_schema_versions + name: job_schema_versions + title: job_schema_versions + methods: + describe_job_schema_version: + operation: + $ref: "#/paths/~1DescribeJobSchemaVersion/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_job_schema_versions: + operation: + $ref: "#/paths/~1ListJobSchemaVersions/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.JobConfigSchemas + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/job_schema_versions/methods/list_job_schema_versions" + insert: [] + update: [] + delete: [] lineage_groups: id: aws.sagemaker.lineage_groups name: lineage_groups diff --git a/providers/src/aws/v00.00.00000/services/sagemaker_featurestore_runtime.yaml b/providers/src/aws/v00.00.00000/services/sagemaker_featurestore_runtime.yaml index 6b64b782..624281a0 100644 --- a/providers/src/aws/v00.00.00000/services/sagemaker_featurestore_runtime.yaml +++ b/providers/src/aws/v00.00.00000/services/sagemaker_featurestore_runtime.yaml @@ -42,6 +42,31 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetRecordResponse" + /BatchWriteRecord: + post: + operationId: BatchWriteRecord + description: Writes a batch of Records to one or more FeatureGroups. Use this API for bulk ingestion of records into the OnlineStore and OfflineStore. You can set the ingested records to expire at a given time to live (TTL) duration after the record's event time by specifying the TtlDuration parameter. A request level TtlDuration applies to all entries that do not specify their own TtlDuration. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Entries: + $ref: "#/components/schemas/BatchWriteRecordEntries" + TtlDuration: + $ref: "#/components/schemas/TtlDuration" + required: + - Entries + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchWriteRecordResponse" /FeatureGroup/{feature_group_name}: delete: operationId: DeleteRecord @@ -141,6 +166,37 @@ paths: responses: "200": description: Success + /FeatureGroup/{feature_group_name}/ListRecords: + post: + operationId: ListRecords + description: Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore. This enables you to discover which records exist without retrieving the full record data. + parameters: + - name: feature_group_name + in: path + required: true + schema: + $ref: "#/components/schemas/FeatureGroupNameOrArn" + description: The name or Amazon Resource Name (ARN) of the feature group to list records from. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/ListRecordsMaxResults" + NextToken: + $ref: "#/components/schemas/ListRecordsNextToken" + IncludeSoftDeletedRecords: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecordsOutputDisplay" components: parameters: X-Amz-Content-Sha256: @@ -330,6 +386,29 @@ components: type: array items: $ref: "#/components/schemas/BatchGetRecordIdentifier" + BatchWriteRecordEntries: + type: array + items: + $ref: "#/components/schemas/BatchWriteRecordEntry" + BatchWriteRecordEntry: + description: An entry to write as part of a BatchWriteRecord request. + type: object + properties: + FeatureGroupName: + $ref: "#/components/schemas/FeatureGroupNameOrArn" + description: The name or Amazon Resource Name (ARN) of the FeatureGroup to write the record to. + Record: + $ref: "#/components/schemas/Record" + description: List of FeatureValues to be inserted. This will be a full over-write. + TargetStores: + $ref: "#/components/schemas/TargetStores" + description: A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup. + TtlDuration: + $ref: "#/components/schemas/TtlDuration" + description: Time to live duration for this entry, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. This overrides the request level TtlDuration. + required: + - FeatureGroupName + - Record TargetStores: type: array items: @@ -339,20 +418,6 @@ components: enum: - OnlineStore - OfflineStore - DeletionMode: - type: string - enum: - - SoftDelete - - HardDelete - GetRecordResponse: - type: object - properties: - Record: - $ref: "#/components/schemas/Record" - description: The record you requested. A list of FeatureValues. - ExpiresAt: - $ref: "#/components/schemas/ExpiresAt" - description: The ExpiresAt ISO string of the requested record. TtlDuration: description: Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide. type: object @@ -377,6 +442,80 @@ components: TtlDurationValue: type: integer minimum: 1 + BatchWriteRecordResponse: + type: object + properties: + Errors: + $ref: "#/components/schemas/BatchWriteRecordErrors" + description: A list of errors that occurred when writing records in the batch. + UnprocessedEntries: + $ref: "#/components/schemas/UnprocessedBatchWriteRecordEntries" + description: A list of entries that were not processed. These entries can be retried. + required: + - Errors + - UnprocessedEntries + BatchWriteRecordErrors: + type: array + items: + $ref: "#/components/schemas/BatchWriteRecordError" + BatchWriteRecordError: + description: The error that has occurred when attempting to write a record in a batch. + type: object + properties: + Entry: + $ref: "#/components/schemas/BatchWriteRecordEntry" + description: The entry that failed to be written. + ErrorCode: + $ref: "#/components/schemas/ValueAsString" + description: The error code for the failed record write. + ErrorMessage: + $ref: "#/components/schemas/Message" + description: The error message for the failed record write. + required: + - Entry + - ErrorCode + - ErrorMessage + UnprocessedBatchWriteRecordEntries: + type: array + items: + $ref: "#/components/schemas/BatchWriteRecordEntry" + DeletionMode: + type: string + enum: + - SoftDelete + - HardDelete + GetRecordResponse: + type: object + properties: + Record: + $ref: "#/components/schemas/Record" + description: The record you requested. A list of FeatureValues. + ExpiresAt: + $ref: "#/components/schemas/ExpiresAt" + description: The ExpiresAt ISO string of the requested record. + ListRecordsMaxResults: + type: integer + minimum: 1 + maximum: 100 + ListRecordsNextToken: + type: string + minLength: 1 + maxLength: 8192 + Boolean: + type: boolean + ListRecordsRowDisplay: + type: object + properties: + record_identifier: + type: string + description: A list of record identifier values for the records stored in the OnlineStore. + ListRecordsOutputDisplay: + type: object + properties: + line_items: + type: array + items: + $ref: "#/components/schemas/ListRecordsRowDisplay" x-stackQL-resources: records: id: aws.sagemaker_featurestore_runtime.records @@ -419,10 +558,36 @@ components: config: requestBodyTranslate: algorithm: naive + list_records: + operation: + $ref: "#/paths/~1FeatureGroup~1{feature_group_name}~1ListRecords/post" + response: + openAPIDocKey: "200" + mediaType: application/json + overrideMediaType: application/json + schema_override: + $ref: "#/components/schemas/ListRecordsOutputDisplay" + transform: + type: golang_template_json_v0.3.0 + body: '{{- $lst := index . "RecordIdentifiers" -}}{{- $tok := index . "NextToken" -}}{"line_items": [{{- if eq (kindOf $lst) "slice" -}}{{- range $i, $v := $lst -}}{{- if $i }},{{ end }}{"record_identifier": {{ toJson $v }}}{{- end -}}{{- end -}}]{{- if $tok }}, "NextToken": {{ toJson $tok }}{{- end }}}' + objectKey: $.line_items + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/records/methods/get_record" - $ref: "#/components/x-stackQL-resources/records/methods/batch_get_record" + - $ref: "#/components/x-stackQL-resources/records/methods/list_records" insert: [] update: [] replace: diff --git a/providers/src/aws/v00.00.00000/services/sagemakerjobruntime.yaml b/providers/src/aws/v00.00.00000/services/sagemakerjobruntime.yaml new file mode 100644 index 00000000..4cc488f6 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/sagemakerjobruntime.yaml @@ -0,0 +1,281 @@ +openapi: 3.0.0 +info: + version: "2026-02-01" + title: Sagemaker Job Runtime Service + description: Sagemaker Job Runtime Service + x-serviceName: sagemaker + x-serviceAlias: sagemakerjobruntime + x-protocol: rest-json + x-apiVersion: "2026-02-01" + x-endpointPrefix: job-runtime.sagemaker +servers: + - url: https://job-runtime.sagemaker.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for sagemakerjobruntime +paths: + /complete-rollout: + post: + operationId: CompleteRollout + description: Marks a rollout as complete, indicating that no further turns will be appended to the trajectory. After calling this operation, the trajectory is sealed and eligible for reward submission via the UpdateReward operation. + parameters: + - name: X-Amzn-SageMaker-Job-Arn + in: header + required: true + schema: + $ref: "#/components/schemas/JobArn" + description: The job ARN. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TrajectoryId: + $ref: "#/components/schemas/TrajectoryId" + Status: + $ref: "#/components/schemas/CompletionStatus" + ClientToken: + $ref: "#/components/schemas/String" + required: + - TrajectoryId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CompleteRolloutResponse" + /sample: + post: + operationId: Sample + description: Sends an inference request to the model during a job execution. The request and response bodies are forwarded to and from the model without modification. Each turn (prompt and response) is captured for later use. + parameters: + - name: X-Amzn-SageMaker-Job-Arn + in: header + required: true + schema: + $ref: "#/components/schemas/JobArn" + description: The job ARN that identifies which model session to route the inference request to. + - name: X-Amzn-SageMaker-Trajectory-Id + in: header + required: true + schema: + $ref: "#/components/schemas/TrajectoryId" + description: The trajectory ID for grouping turns into a single rollout. Each turn (prompt and response) is captured for later use. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Body: + $ref: "#/components/schemas/InferenceRequestBody" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SampleResponse" + /sample-with-response-stream: + post: + operationId: SampleWithResponseStream + description: Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use. + parameters: + - name: X-Amzn-SageMaker-Job-Arn + in: header + required: true + schema: + $ref: "#/components/schemas/JobArn" + description: The job ARN that identifies which model session to route the inference request to. + - name: X-Amzn-SageMaker-Trajectory-Id + in: header + required: true + schema: + $ref: "#/components/schemas/TrajectoryId" + description: The trajectory ID for grouping turns into a single rollout. Each turn is captured for later use. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Body: + $ref: "#/components/schemas/InferenceRequestBody" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SampleWithResponseStreamResponse" + /update-reward: + post: + operationId: UpdateReward + description: Updates the reward values for a trajectory and transitions it to reward-received status, signaling that it is eligible for processing. Call this operation after CompleteRollout to provide the computed reward scores. + parameters: + - name: X-Amzn-SageMaker-Job-Arn + in: header + required: true + schema: + $ref: "#/components/schemas/JobArn" + description: The job ARN. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TrajectoryId: + $ref: "#/components/schemas/TrajectoryId" + Rewards: + $ref: "#/components/schemas/DoubleList" + ClientToken: + $ref: "#/components/schemas/String" + required: + - TrajectoryId + - Rewards + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateRewardResponse" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + JobArn: + type: string + minLength: 1 + maxLength: 256 + pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:job/[a-zA-Z0-9_\-]+/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} + TrajectoryId: + type: string + minLength: 1 + maxLength: 256 + CompletionStatus: + description: Allowed target statuses for the CompleteTrajectory operation. + type: string + enum: + - ready + - failed + String: + type: string + CompleteRolloutResponse: + type: object + InferenceRequestBody: + description: Sensitive binary payload containing customer inference data. + type: string + format: byte + SampleResponse: + type: object + properties: + ContentType: + $ref: "#/components/schemas/String" + description: MIME type of the inference result. + Body: + $ref: "#/components/schemas/InferenceResponseBody" + description: The raw inference response body from the model. + required: + - Body + InferenceResponseBody: + description: Sensitive binary payload containing model inference response data. + type: string + format: byte + SampleWithResponseStreamResponse: + type: object + properties: + ContentType: + $ref: "#/components/schemas/String" + description: MIME type of the streaming inference result. + Body: + $ref: "#/components/schemas/ResponseStream" + description: The streaming response body, delivered as a series of PayloadPart events. + required: + - Body + ResponseStream: + description: Streaming response body composed of successive payload chunks. + type: string + format: byte + DoubleList: + type: array + items: + $ref: "#/components/schemas/Double" + Double: + type: number + format: double + UpdateRewardResponse: + type: object + x-stackQL-resources: + rewards: + id: aws.sagemakerjobruntime.rewards + name: rewards + title: rewards + methods: + update_reward: + operation: + $ref: "#/paths/~1update-reward/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/rewards/methods/update_reward" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/securityagent.yaml b/providers/src/aws/v00.00.00000/services/securityagent.yaml index bdec2dff..eb876fb5 100644 --- a/providers/src/aws/v00.00.00000/services/securityagent.yaml +++ b/providers/src/aws/v00.00.00000/services/securityagent.yaml @@ -48,6 +48,32 @@ paths: application/json: schema: $ref: "#/components/schemas/AddArtifactOutput" + /BatchCreateSecurityRequirements: + post: + operationId: BatchCreateSecurityRequirements + description: Batch creates security requirements in a customer managed pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + securityRequirements: + $ref: "#/components/schemas/CreateSecurityRequirementEntryList" + required: + - packId + - securityRequirements + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchCreateSecurityRequirementsOutput" /BatchDeleteCodeReviews: post: operationId: BatchDeleteCodeReviews @@ -100,6 +126,58 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchDeletePentestsOutput" + /BatchDeleteSecurityRequirements: + post: + operationId: BatchDeleteSecurityRequirements + description: Batch deletes security requirements from a customer managed pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + securityRequirementNames: + $ref: "#/components/schemas/SecurityRequirementNameList" + required: + - packId + - securityRequirementNames + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteSecurityRequirementsOutput" + /BatchDeleteThreatModels: + post: + operationId: BatchDeleteThreatModels + description: Deletes one or more threat models from an agent space. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatModelIds: + $ref: "#/components/schemas/ThreatModelIdList" + agentSpaceId: + $ref: "#/components/schemas/String" + required: + - threatModelIds + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchDeleteThreatModelsOutput" /BatchGetAgentSpaces: post: operationId: BatchGetAgentSpaces @@ -331,6 +409,32 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetPentestsOutput" + /BatchGetSecurityRequirements: + post: + operationId: BatchGetSecurityRequirements + description: Batch retrieves security requirements from a pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + securityRequirementNames: + $ref: "#/components/schemas/SecurityRequirementNameList" + required: + - packId + - securityRequirementNames + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetSecurityRequirementsOutput" /BatchGetTargetDomains: post: operationId: BatchGetTargetDomains @@ -354,6 +458,136 @@ paths: application/json: schema: $ref: "#/components/schemas/BatchGetTargetDomainsOutput" + /BatchGetThreatModelJobTasks: + post: + operationId: BatchGetThreatModelJobTasks + description: Retrieves information about one or more tasks within a threat model job. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/String" + threatModelJobTaskIds: + $ref: "#/components/schemas/TaskIdList" + required: + - agentSpaceId + - threatModelJobTaskIds + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetThreatModelJobTasksOutput" + /BatchGetThreatModelJobs: + post: + operationId: BatchGetThreatModelJobs + description: Retrieves information about one or more threat model jobs in an agent space. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatModelJobIds: + $ref: "#/components/schemas/ThreatModelJobIdList" + agentSpaceId: + $ref: "#/components/schemas/String" + required: + - threatModelJobIds + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetThreatModelJobsOutput" + /BatchGetThreatModels: + post: + operationId: BatchGetThreatModels + description: Retrieves information about one or more threat models in an agent space. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatModelIds: + $ref: "#/components/schemas/ThreatModelIdList" + agentSpaceId: + $ref: "#/components/schemas/String" + required: + - threatModelIds + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetThreatModelsOutput" + /BatchGetThreats: + post: + operationId: BatchGetThreats + description: Retrieves information about one or more threats. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatIds: + $ref: "#/components/schemas/ThreatIdList" + agentSpaceId: + $ref: "#/components/schemas/String" + required: + - threatIds + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchGetThreatsOutput" + /BatchUpdateSecurityRequirements: + post: + operationId: BatchUpdateSecurityRequirements + description: Batch updates security requirements within a customer managed pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + securityRequirements: + $ref: "#/components/schemas/UpdateSecurityRequirementEntryList" + required: + - packId + - securityRequirements + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/BatchUpdateSecurityRequirementsOutput" /CreateAgentSpace: post: operationId: CreateAgentSpace @@ -440,6 +674,10 @@ paths: $ref: "#/components/schemas/CloudWatchLog" codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" + validationMode: + $ref: "#/components/schemas/ValidationMode" + maxTaskHours: + $ref: "#/components/schemas/Double" required: - title - agentSpaceId @@ -473,6 +711,8 @@ paths: $ref: "#/components/schemas/KmsKeyId" tags: $ref: "#/components/schemas/TagMap" + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" required: - provider - input @@ -548,6 +788,10 @@ paths: $ref: "#/components/schemas/NetworkTrafficConfig" codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" + disableManagedSkills: + $ref: "#/components/schemas/SkillTypeList" + maxTaskHours: + $ref: "#/components/schemas/Double" required: - title - agentSpaceId @@ -558,10 +802,10 @@ paths: application/json: schema: $ref: "#/components/schemas/CreatePentestOutput" - /CreateTargetDomain: + /CreatePrivateConnection: post: - operationId: CreateTargetDomain - description: Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested. + operationId: CreatePrivateConnection + description: Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice. parameters: [] requestBody: required: true @@ -570,26 +814,26 @@ paths: schema: type: object properties: - targetDomainName: - $ref: "#/components/schemas/String" - verificationMethod: - $ref: "#/components/schemas/DomainVerificationMethod" + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + mode: + $ref: "#/components/schemas/PrivateConnectionMode" tags: $ref: "#/components/schemas/TagMap" required: - - targetDomainName - - verificationMethod + - privateConnectionName + - mode responses: - "200": + "201": description: Success content: application/json: schema: - $ref: "#/components/schemas/CreateTargetDomainOutput" - /DeleteAgentSpace: + $ref: "#/components/schemas/CreatePrivateConnectionOutput" + /CreateSecurityRequirementPack: post: - operationId: DeleteAgentSpace - description: Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts. + operationId: CreateSecurityRequirementPack + description: Creates a customer managed security requirement pack. parameters: [] requestBody: required: true @@ -598,21 +842,29 @@ paths: schema: type: object properties: - agentSpaceId: - $ref: "#/components/schemas/AgentSpaceId" + name: + $ref: "#/components/schemas/SecurityRequirementPackName" + description: + $ref: "#/components/schemas/String" + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + tags: + $ref: "#/components/schemas/TagMap" required: - - agentSpaceId + - name responses: - "200": + "201": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteAgentSpaceOutput" - /DeleteApplication: + $ref: "#/components/schemas/CreateSecurityRequirementPackOutput" + /CreateTargetDomain: post: - operationId: DeleteApplication - description: Deletes an application and its associated configuration, including IAM Identity Center settings. + operationId: CreateTargetDomain + description: Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested. parameters: [] requestBody: required: true @@ -621,17 +873,26 @@ paths: schema: type: object properties: - applicationId: - $ref: "#/components/schemas/ApplicationId" + targetDomainName: + $ref: "#/components/schemas/String" + verificationMethod: + $ref: "#/components/schemas/DomainVerificationMethod" + tags: + $ref: "#/components/schemas/TagMap" required: - - applicationId + - targetDomainName + - verificationMethod responses: "200": description: Success - /DeleteArtifact: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTargetDomainOutput" + /CreateThreat: post: - operationId: DeleteArtifact - description: Deletes an artifact from an agent space. + operationId: CreateThreat + description: Creates a new threat under a threat model job. parameters: [] requestBody: required: true @@ -641,23 +902,51 @@ paths: type: object properties: agentSpaceId: - $ref: "#/components/schemas/AgentSpaceId" - artifactId: - $ref: "#/components/schemas/ArtifactId" + $ref: "#/components/schemas/String" + threatJobId: + $ref: "#/components/schemas/String" + title: + $ref: "#/components/schemas/String" + statement: + $ref: "#/components/schemas/String" + severity: + $ref: "#/components/schemas/ThreatSeverity" + comments: + $ref: "#/components/schemas/String" + stride: + $ref: "#/components/schemas/StrideCategoryList" + threatSource: + $ref: "#/components/schemas/String" + prerequisites: + $ref: "#/components/schemas/String" + threatAction: + $ref: "#/components/schemas/String" + threatImpact: + $ref: "#/components/schemas/String" + impactedGoal: + $ref: "#/components/schemas/StringList" + impactedAssets: + $ref: "#/components/schemas/StringList" + anchor: + $ref: "#/components/schemas/ThreatAnchorShape" + evidence: + $ref: "#/components/schemas/ThreatEvidenceList" + recommendation: + $ref: "#/components/schemas/String" required: - agentSpaceId - - artifactId + - threatJobId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteArtifactOutput" - /DeleteIntegration: + $ref: "#/components/schemas/CreateThreatOutput" + /CreateThreatModel: post: - operationId: DeleteIntegration - description: Deletes an integration with a third-party provider. + operationId: CreateThreatModel + description: Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis. parameters: [] requestBody: required: true @@ -666,22 +955,129 @@ paths: schema: type: object properties: - integrationId: - $ref: "#/components/schemas/IntegrationId" + title: + $ref: "#/components/schemas/String" + agentSpaceId: + $ref: "#/components/schemas/String" + description: + $ref: "#/components/schemas/String" + assets: + $ref: "#/components/schemas/Assets" + scopeDocs: + $ref: "#/components/schemas/DocumentList" + serviceRole: + $ref: "#/components/schemas/ServiceRole" + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + reportDestination: + $ref: "#/components/schemas/ReportDestination" required: - - integrationId + - title + - agentSpaceId + - serviceRole responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/DeleteIntegrationOutput" - /DeleteMembership: + $ref: "#/components/schemas/CreateThreatModelOutput" + /DeleteAgentSpace: post: - operationId: DeleteMembership - description: Deletes a membership, revoking a user's access to an agent space. - parameters: [] + operationId: DeleteAgentSpace + description: Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/AgentSpaceId" + required: + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAgentSpaceOutput" + /DeleteApplication: + post: + operationId: DeleteApplication + description: Deletes an application and its associated configuration, including IAM Identity Center settings. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + applicationId: + $ref: "#/components/schemas/ApplicationId" + required: + - applicationId + responses: + "200": + description: Success + /DeleteArtifact: + post: + operationId: DeleteArtifact + description: Deletes an artifact from an agent space. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/AgentSpaceId" + artifactId: + $ref: "#/components/schemas/ArtifactId" + required: + - agentSpaceId + - artifactId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteArtifactOutput" + /DeleteIntegration: + post: + operationId: DeleteIntegration + description: Deletes an integration with a third-party provider. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + integrationId: + $ref: "#/components/schemas/IntegrationId" + required: + - integrationId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteIntegrationOutput" + /DeleteMembership: + post: + operationId: DeleteMembership + description: Deletes a membership, revoking a user's access to an agent space. + parameters: [] requestBody: required: true content: @@ -708,6 +1104,52 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteMembershipResponse" + /DeletePrivateConnection: + post: + operationId: DeletePrivateConnection + description: Deletes a private connection. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + required: + - privateConnectionName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeletePrivateConnectionOutput" + /DeleteSecurityRequirementPack: + post: + operationId: DeleteSecurityRequirementPack + description: Deletes a customer managed security requirement pack and all its associated security requirements. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + required: + - packId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSecurityRequirementPackOutput" /DeleteTargetDomain: post: operationId: DeleteTargetDomain @@ -731,6 +1173,29 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteTargetDomainOutput" + /DescribePrivateConnection: + post: + operationId: DescribePrivateConnection + description: Retrieves the details of a private connection. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + required: + - privateConnectionName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DescribePrivateConnectionOutput" /GetApplication: post: operationId: GetApplication @@ -803,6 +1268,55 @@ paths: application/json: schema: $ref: "#/components/schemas/GetIntegrationOutput" + /GetSecurityRequirementPack: + post: + operationId: GetSecurityRequirementPack + description: Retrieves information about a security requirement pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + required: + - packId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSecurityRequirementPackOutput" + /ImportSecurityRequirements: + post: + operationId: ImportSecurityRequirements + description: Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + input: + $ref: "#/components/schemas/ImportSource" + required: + - packId + - input + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ImportSecurityRequirementsOutput" /oauth2/provider/register: post: operationId: InitiateProviderRegistration @@ -1240,6 +1754,81 @@ paths: application/json: schema: $ref: "#/components/schemas/ListPentestsOutput" + /ListPrivateConnections: + post: + operationId: ListPrivateConnections + description: Lists the private connections in your account. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/MaxResults" + nextToken: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListPrivateConnectionsOutput" + /ListSecurityRequirementPacks: + post: + operationId: ListSecurityRequirementPacks + description: Lists all security requirement packs in the caller's account. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + filter: + $ref: "#/components/schemas/ListSecurityRequirementPackFilter" + nextToken: + $ref: "#/components/schemas/NextToken" + maxResults: + $ref: "#/components/schemas/MaxResults" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSecurityRequirementPacksOutput" + /ListSecurityRequirements: + post: + operationId: ListSecurityRequirements + description: Lists security requirements within a pack. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + nextToken: + $ref: "#/components/schemas/NextToken" + maxResults: + $ref: "#/components/schemas/MaxResults" + required: + - packId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSecurityRequirementsOutput" /tags/{resource_arn}: get: operationId: ListTagsForResource @@ -1332,10 +1921,10 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTargetDomainsOutput" - /StartCodeRemediation: + /ListThreatModelJobTasks: post: - operationId: StartCodeRemediation - description: Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities. + operationId: ListThreatModelJobTasks + description: Returns a paginated list of task summaries for the specified threat model job. parameters: [] requestBody: required: true @@ -1346,26 +1935,26 @@ paths: properties: agentSpaceId: $ref: "#/components/schemas/String" - pentestJobId: - $ref: "#/components/schemas/String" - codeReviewJobId: + maxResults: + $ref: "#/components/schemas/MaxResults" + threatModelJobId: $ref: "#/components/schemas/String" - findingIds: - $ref: "#/components/schemas/FindingIdList" + nextToken: + $ref: "#/components/schemas/NextToken" required: - agentSpaceId - - findingIds + - threatModelJobId responses: "200": description: Success content: application/json: schema: - $ref: "#/components/schemas/StartCodeRemediationOutput" - /StartCodeReviewJob: + $ref: "#/components/schemas/ListThreatModelJobTasksOutput" + /ListThreatModelJobs: post: - operationId: StartCodeReviewJob - description: Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review. + operationId: ListThreatModelJobs + description: Returns a paginated list of threat model job summaries for the specified threat model. parameters: [] requestBody: required: true @@ -1374,10 +1963,129 @@ paths: schema: type: object properties: + maxResults: + $ref: "#/components/schemas/MaxResults" + threatModelId: + $ref: "#/components/schemas/String" agentSpaceId: $ref: "#/components/schemas/String" - codeReviewId: + nextToken: + $ref: "#/components/schemas/NextToken" + required: + - threatModelId + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListThreatModelJobsOutput" + /ListThreatModels: + post: + operationId: ListThreatModels + description: Returns a paginated list of threat model summaries for the specified agent space. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/MaxResults" + nextToken: + $ref: "#/components/schemas/NextToken" + agentSpaceId: + $ref: "#/components/schemas/String" + required: + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListThreatModelsOutput" + /ListThreats: + post: + operationId: ListThreats + description: Returns a paginated list of threats for a threat model job. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatJobId: + $ref: "#/components/schemas/String" + agentSpaceId: + $ref: "#/components/schemas/String" + nextToken: + $ref: "#/components/schemas/NextToken" + maxResults: + $ref: "#/components/schemas/MaxResults" + required: + - threatJobId + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListThreatsOutput" + /StartCodeRemediation: + post: + operationId: StartCodeRemediation + description: Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/String" + pentestJobId: + $ref: "#/components/schemas/String" + codeReviewJobId: + $ref: "#/components/schemas/String" + findingIds: + $ref: "#/components/schemas/FindingIdList" + required: + - agentSpaceId + - findingIds + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartCodeRemediationOutput" + /StartCodeReviewJob: + post: + operationId: StartCodeReviewJob + description: Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: $ref: "#/components/schemas/String" + codeReviewId: + $ref: "#/components/schemas/String" + diffSource: + $ref: "#/components/schemas/DiffSource" required: - agentSpaceId - codeReviewId @@ -1404,6 +2112,10 @@ paths: $ref: "#/components/schemas/String" pentestId: $ref: "#/components/schemas/String" + jobType: + $ref: "#/components/schemas/JobType" + selectedFindingIds: + $ref: "#/components/schemas/StringList" required: - agentSpaceId - pentestId @@ -1414,6 +2126,32 @@ paths: application/json: schema: $ref: "#/components/schemas/StartPentestJobOutput" + /StartThreatModelJob: + post: + operationId: StartThreatModelJob + description: Starts a new threat model job for a threat model configuration. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/String" + threatModelId: + $ref: "#/components/schemas/String" + required: + - agentSpaceId + - threatModelId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartThreatModelJobOutput" /StopCodeReviewJob: post: operationId: StopCodeReviewJob @@ -1466,6 +2204,32 @@ paths: application/json: schema: $ref: "#/components/schemas/StopPentestJobOutput" + /StopThreatModelJob: + post: + operationId: StopThreatModelJob + description: Stops a running threat model job. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/String" + threatModelJobId: + $ref: "#/components/schemas/String" + required: + - agentSpaceId + - threatModelJobId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StopThreatModelJobOutput" /UpdateAgentSpace: post: operationId: UpdateAgentSpace @@ -1552,6 +2316,10 @@ paths: $ref: "#/components/schemas/CloudWatchLog" codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" + validationMode: + $ref: "#/components/schemas/ValidationMode" + maxTaskHours: + $ref: "#/components/schemas/Double" required: - codeReviewId - agentSpaceId @@ -1578,10 +2346,24 @@ paths: $ref: "#/components/schemas/String" agentSpaceId: $ref: "#/components/schemas/String" + name: + $ref: "#/components/schemas/String" + description: + $ref: "#/components/schemas/String" + riskType: + $ref: "#/components/schemas/String" riskLevel: $ref: "#/components/schemas/RiskLevel" + riskScore: + $ref: "#/components/schemas/String" + attackScript: + $ref: "#/components/schemas/String" + reasoning: + $ref: "#/components/schemas/String" status: $ref: "#/components/schemas/FindingStatus" + customerNote: + $ref: "#/components/schemas/String" required: - findingId - agentSpaceId @@ -1653,6 +2435,10 @@ paths: $ref: "#/components/schemas/NetworkTrafficConfig" codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" + disableManagedSkills: + $ref: "#/components/schemas/SkillTypeList" + maxTaskHours: + $ref: "#/components/schemas/Double" required: - pentestId - agentSpaceId @@ -1663,6 +2449,61 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdatePentestOutput" + /UpdatePrivateConnectionCertificate: + post: + operationId: UpdatePrivateConnectionCertificate + description: Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + certificate: + $ref: "#/components/schemas/CertificateChain" + required: + - privateConnectionName + - certificate + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdatePrivateConnectionCertificateOutput" + /UpdateSecurityRequirementPack: + post: + operationId: UpdateSecurityRequirementPack + description: Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + name: + $ref: "#/components/schemas/SecurityRequirementPackName" + description: + $ref: "#/components/schemas/String" + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + required: + - packId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateSecurityRequirementPackOutput" /UpdateTargetDomain: post: operationId: UpdateTargetDomain @@ -1689,6 +2530,98 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateTargetDomainOutput" + /UpdateThreat: + post: + operationId: UpdateThreat + description: Updates a threat. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatId: + $ref: "#/components/schemas/String" + agentSpaceId: + $ref: "#/components/schemas/String" + title: + $ref: "#/components/schemas/String" + status: + $ref: "#/components/schemas/ThreatStatus" + comments: + $ref: "#/components/schemas/String" + statement: + $ref: "#/components/schemas/String" + severity: + $ref: "#/components/schemas/ThreatSeverity" + threatSource: + $ref: "#/components/schemas/String" + prerequisites: + $ref: "#/components/schemas/String" + threatAction: + $ref: "#/components/schemas/String" + threatImpact: + $ref: "#/components/schemas/String" + impactedGoal: + $ref: "#/components/schemas/StringList" + impactedAssets: + $ref: "#/components/schemas/StringList" + anchor: + $ref: "#/components/schemas/ThreatAnchorShape" + evidence: + $ref: "#/components/schemas/ThreatEvidenceList" + recommendation: + $ref: "#/components/schemas/String" + required: + - threatId + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateThreatOutput" + /UpdateThreatModel: + post: + operationId: UpdateThreatModel + description: Updates an existing threat model configuration. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + agentSpaceId: + $ref: "#/components/schemas/String" + title: + $ref: "#/components/schemas/String" + description: + $ref: "#/components/schemas/String" + assets: + $ref: "#/components/schemas/Assets" + scopeDocs: + $ref: "#/components/schemas/DocumentList" + serviceRole: + $ref: "#/components/schemas/ServiceRole" + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + required: + - threatModelId + - agentSpaceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateThreatModelOutput" /VerifyTargetDomain: post: operationId: VerifyTargetDomain @@ -1789,17 +2722,128 @@ components: ArtifactId: description: The id of the artifact. type: string - CodeReviewIdList: - description: List of code review IDs. + SecurityRequirementPackId: + type: string + CreateSecurityRequirementEntryList: + description: List of security requirements to create. type: array items: - $ref: "#/components/schemas/String" - BatchDeleteCodeReviewsOutput: - description: Output for the BatchDeleteCodeReviews operation. + $ref: "#/components/schemas/CreateSecurityRequirementEntry" + CreateSecurityRequirementEntry: + description: Contains the details for a security requirement to create within a pack. type: object properties: - deleted: - $ref: "#/components/schemas/CodeReviewIdList" + name: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement. + domain: + $ref: "#/components/schemas/String" + description: The security domain the requirement belongs to. + evaluation: + $ref: "#/components/schemas/String" + description: The evaluation criteria used to assess compliance with this requirement. + remediation: + $ref: "#/components/schemas/String" + description: The recommended remediation steps when the requirement is not met. + required: + - name + - description + - domain + - evaluation + SecurityRequirementName: + type: string + BatchCreateSecurityRequirementsOutput: + type: object + properties: + securityRequirements: + $ref: "#/components/schemas/BatchCreateSecurityRequirementResultList" + description: The list of security requirements that were successfully created. + errors: + $ref: "#/components/schemas/BatchSecurityRequirementErrors" + description: The list of errors for security requirements that failed to be created. + required: + - securityRequirements + - errors + BatchCreateSecurityRequirementResultList: + description: List of successfully created security requirements. + type: array + items: + $ref: "#/components/schemas/BatchCreateSecurityRequirementResult" + BatchCreateSecurityRequirementResult: + description: Contains information about a successfully created security requirement. + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the pack containing the security requirement. + name: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement. + domain: + $ref: "#/components/schemas/String" + description: The security domain the requirement belongs to. + evaluation: + $ref: "#/components/schemas/String" + description: The evaluation criteria used to assess compliance with this requirement. + remediation: + $ref: "#/components/schemas/String" + description: The recommended remediation steps when the requirement is not met. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was last updated, in UTC format. + required: + - packId + - name + - description + - domain + - evaluation + - createdAt + - updatedAt + SyntheticTimestamp_date_time: + type: string + format: date-time + BatchSecurityRequirementErrors: + description: List of errors from a batch security requirement operation. + type: array + items: + $ref: "#/components/schemas/BatchSecurityRequirementError" + BatchSecurityRequirementError: + description: Contains information about an error that occurred for a specific security requirement during a batch operation. + type: object + properties: + securityRequirementName: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement that caused the error. + code: + $ref: "#/components/schemas/String" + description: The error code. + message: + $ref: "#/components/schemas/String" + description: The error message. + required: + - securityRequirementName + - code + - message + CodeReviewIdList: + description: List of code review IDs. + type: array + items: + $ref: "#/components/schemas/String" + BatchDeleteCodeReviewsOutput: + description: Output for the BatchDeleteCodeReviews operation. + type: object + properties: + deleted: + $ref: "#/components/schemas/CodeReviewIdList" description: The list of identifiers of the code reviews that were successfully deleted. failed: $ref: "#/components/schemas/DeleteCodeReviewFailureList" @@ -1871,6 +2915,15 @@ components: codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" description: The code remediation strategy for the pentest. + cleanUpStrategy: + $ref: "#/components/schemas/CleanUpStrategy" + description: Strategy for cleaning up resources after pentest job completion. + disableManagedSkills: + $ref: "#/components/schemas/SkillTypeList" + description: A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours allowed for jobs started from this pentest. If a job reaches the configured limit, it is gracefully stopped. If not set, jobs run to completion with no budget cap. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the pentest was created, in UTC format. @@ -1932,6 +2985,12 @@ components: description: $ref: "#/components/schemas/String" description: A description of the actor. + enableEmailMfa: + $ref: "#/components/schemas/Boolean" + description: Whether email-based MFA is enabled for this actor. + mfaForwardingAddress: + $ref: "#/components/schemas/SensitiveEmailAddress" + description: Server-generated email forwarding address for receiving MFA codes. UriList: type: array items: @@ -1954,6 +3013,10 @@ components: - AWS_LAMBDA - AWS_IAM_ROLE - AWS_INTERNAL + Boolean: + type: boolean + SensitiveEmailAddress: + type: string DocumentList: type: array items: @@ -1968,6 +3031,22 @@ components: artifactId: $ref: "#/components/schemas/String" description: The unique identifier of the artifact associated with the document. + integratedDocument: + $ref: "#/components/schemas/IntegratedDocument" + description: A reference to a document in an integrated third-party provider. + IntegratedDocument: + description: A reference to a document in a third-party provider, such as a Confluence page linked via an integration. + type: object + properties: + integrationId: + $ref: "#/components/schemas/String" + description: The identifier of the integration that provides access to the document. + resourceId: + $ref: "#/components/schemas/String" + description: The provider-specific resource identifier for the document. + required: + - integrationId + - resourceId SourceCodeRepositoryList: type: array items: @@ -1993,6 +3072,9 @@ components: providerResourceId: $ref: "#/components/schemas/String" description: The provider-specific resource identifier for the repository. + branch: + $ref: "#/components/schemas/String" + description: An optional override for the repository branch. required: - integrationId - providerResourceId @@ -2137,9 +3219,26 @@ components: enum: - AUTOMATIC - DISABLED - SyntheticTimestamp_date_time: + CleanUpStrategy: + description: Strategy for handling resources created during a pentest. type: string - format: date-time + enum: + - BEST_EFFORT_DELETE + - RETAIN_ALL + SkillTypeList: + description: A list of skill types. + type: array + items: + $ref: "#/components/schemas/SkillType" + SkillType: + description: Type of managed skill that can be enabled or disabled for a pentest. + type: string + enum: + - FINDING_PERSONALIZATION + - LOGIN_OPTIMIZATION + Double: + type: number + format: double DeletePentestFailureList: type: array items: @@ -2154,6 +3253,53 @@ components: reason: $ref: "#/components/schemas/String" description: The reason the pentest failed to delete. + SecurityRequirementNameList: + description: List of security requirement names. + type: array + items: + $ref: "#/components/schemas/SecurityRequirementName" + BatchDeleteSecurityRequirementsOutput: + type: object + properties: + deletedSecurityRequirementNames: + $ref: "#/components/schemas/SecurityRequirementNameList" + description: The list of security requirement names that were successfully deleted. + errors: + $ref: "#/components/schemas/BatchSecurityRequirementErrors" + description: The list of errors for security requirements that failed to be deleted. + required: + - deletedSecurityRequirementNames + - errors + ThreatModelIdList: + description: List of threat model IDs. + type: array + items: + $ref: "#/components/schemas/String" + BatchDeleteThreatModelsOutput: + description: Output for the BatchDeleteThreatModels operation. + type: object + properties: + deleted: + $ref: "#/components/schemas/ThreatModelIdList" + description: The list of threat model identifiers that were successfully deleted. + failed: + $ref: "#/components/schemas/DeleteThreatModelFailureList" + description: The list of threat models that failed to delete, including the reason for each failure. + DeleteThreatModelFailureList: + description: List of threat model deletion failures. + type: array + items: + $ref: "#/components/schemas/DeleteThreatModelFailure" + DeleteThreatModelFailure: + description: Contains information about a threat model that failed to delete. + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model that failed to delete. + reason: + $ref: "#/components/schemas/String" + description: The reason the threat model failed to delete. AgentSpaceIdList: type: array items: @@ -2282,8 +3428,6 @@ components: required: - controlsScanning - generalPurposeScanning - Boolean: - type: boolean KmsKeyId: description: Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN. type: string @@ -2490,6 +3634,9 @@ components: codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" description: The code remediation strategy for the code review job. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours allowed for this code review job. If the cumulative task hours reach this limit, the job is gracefully stopped. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the code review job was created, in UTC format. @@ -2516,7 +3663,7 @@ components: properties: name: $ref: "#/components/schemas/StepName" - description: The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING. + description: The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING. status: $ref: "#/components/schemas/StepStatus" description: The current status of the step. @@ -2534,6 +3681,7 @@ components: - STATIC_ANALYSIS - PENTEST - FINALIZING + - VALIDATION StepStatus: description: Pentest job step status. type: string @@ -2625,6 +3773,12 @@ components: codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" description: The code remediation strategy for the code review. + validationMode: + $ref: "#/components/schemas/ValidationMode" + description: The validation mode for the code review. Valid values are SIMULATED and DISABLED. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours allowed for jobs started from this code review. If a job reaches the configured limit, it is gracefully stopped. If not set, jobs run to completion with no budget cap. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the code review was created, in UTC format. @@ -2636,6 +3790,12 @@ components: - agentSpaceId - title_ - assets + ValidationMode: + description: Mode of validation to perform on findings + type: string + enum: + - DISABLED + - SIMULATED FindingIdList: type: array items: @@ -2704,6 +3864,9 @@ components: confidence: $ref: "#/components/schemas/ConfidenceLevel" description: The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH. + validationStatus: + $ref: "#/components/schemas/ValidationStatus" + description: The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED. attackScript: $ref: "#/components/schemas/String" description: The attack script used to reproduce the finding. @@ -2713,9 +3876,24 @@ components: lastUpdatedBy: $ref: "#/components/schemas/String" description: The identifier of the entity that last updated the finding. + customerNote: + $ref: "#/components/schemas/String" + description: A customer-provided note on the finding. codeLocations: $ref: "#/components/schemas/CodeLocationList" description: The file locations involved in the vulnerability, as reported by the code scanner. + verificationScript: + $ref: "#/components/schemas/VerificationScript" + description: The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables. + alignmentRationale: + $ref: "#/components/schemas/String" + description: The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences. + revalidationJobIds: + $ref: "#/components/schemas/StringList" + description: The list of pentest job identifiers for revalidation jobs that retested this finding. + originalFindingId: + $ref: "#/components/schemas/String" + description: The identifier of the original finding that this revalidation finding was produced from. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the finding was created, in UTC format. @@ -2752,6 +3930,15 @@ components: - LOW - MEDIUM - HIGH + ValidationStatus: + description: Per-finding sandbox validation status + type: string + enum: + - CONFIRMED + - NOT_REPRODUCED + - VALIDATION_FAILED + - VALIDATING + - NOT_VALIDATED CodeRemediationTask: description: Represents a code remediation task that was initiated to fix a security finding. type: object @@ -2816,6 +4003,41 @@ components: - filePath Integer: type: integer + VerificationScript: + description: Contains metadata for a verification script that can be used to reproduce a security finding. + type: object + properties: + scriptType: + $ref: "#/components/schemas/String" + description: The type of script. Valid values are python and bash. + scriptUrl: + $ref: "#/components/schemas/String" + description: URL to download the verification script. + instructions: + $ref: "#/components/schemas/String" + description: Instructions for running the verification script, including prerequisites and how to interpret results. + envVars: + $ref: "#/components/schemas/VerificationScriptEnvVarList" + description: The list of environment variables required to run the verification script. + VerificationScriptEnvVarList: + description: List of environment variables required to run a verification script. + type: array + items: + $ref: "#/components/schemas/VerificationScriptEnvVar" + VerificationScriptEnvVar: + description: Represents an environment variable required to run a verification script. + type: object + properties: + name: + $ref: "#/components/schemas/String" + description: The name of the environment variable. + value: + $ref: "#/components/schemas/String" + description: The value of the environment variable. + StringList: + type: array + items: + $ref: "#/components/schemas/String" BatchGetPentestJobTasksOutput: description: Output for the BatchGetPentestJobTasks operation. type: object @@ -2867,6 +4089,9 @@ components: logsLocation: $ref: "#/components/schemas/LogLocation" description: The location of the task execution logs. + taskHours: + $ref: "#/components/schemas/Double" + description: The number of active work hours consumed by the task during execution. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the task was created, in UTC format. @@ -2960,12 +4185,33 @@ components: codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" description: The code remediation strategy for the pentest job. + cleanUpStrategy: + $ref: "#/components/schemas/CleanUpStrategy" + description: Strategy for cleaning up resources after pentest job completion. + disableManagedSkills: + $ref: "#/components/schemas/SkillTypeList" + description: A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped. + jobType: + $ref: "#/components/schemas/JobType" + description: The type of the pentest job. Valid values are FULL and REVALIDATION. + selectedFindingIds: + $ref: "#/components/schemas/StringList" + description: The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the pentest job was created, in UTC format. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the pentest job was last updated, in UTC format. + JobType: + description: The type of pentest job execution. + type: string + enum: + - FULL + - REVALIDATION BatchGetPentestsOutput: description: Output for the BatchGetPentests operation. type: object @@ -2976,6 +4222,59 @@ components: notFound: $ref: "#/components/schemas/PentestIdList" description: The list of pentest identifiers that were not found. + BatchGetSecurityRequirementsOutput: + type: object + properties: + securityRequirements: + $ref: "#/components/schemas/BatchGetSecurityRequirementResultList" + description: The list of security requirements that were successfully retrieved. + errors: + $ref: "#/components/schemas/BatchSecurityRequirementErrors" + description: The list of errors for security requirements that failed to be retrieved. + required: + - securityRequirements + - errors + BatchGetSecurityRequirementResultList: + description: List of successfully retrieved security requirements. + type: array + items: + $ref: "#/components/schemas/BatchGetSecurityRequirementResult" + BatchGetSecurityRequirementResult: + description: Contains information about a successfully retrieved security requirement. + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the pack containing the security requirement. + name: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement. + domain: + $ref: "#/components/schemas/String" + description: The security domain the requirement belongs to. + evaluation: + $ref: "#/components/schemas/String" + description: The evaluation criteria used to assess compliance with this requirement. + remediation: + $ref: "#/components/schemas/String" + description: The recommended remediation steps when the requirement is not met. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was last updated, in UTC format. + required: + - packId + - name + - description + - domain + - evaluation + - createdAt + - updatedAt BatchGetTargetDomainsOutput: description: Output for the BatchGetTargetDomains operation. type: object @@ -3078,105 +4377,478 @@ components: routePath: $ref: "#/components/schemas/String" description: The HTTP route path where the verification token must be served. - AgentName: - description: Name of an agent space. - type: string - TagMap: - description: Map of tags for a resource. + BatchGetThreatModelJobTasksOutput: + description: Output for the BatchGetThreatModelJobTasks operation. type: object - properties: {} - CreateAgentSpaceOutput: - description: Output for the CreateAgentSpace operation. + properties: + threatModelJobTasks: + $ref: "#/components/schemas/ThreatModelJobTaskList" + description: The list of threat model job tasks that were found. + notFound: + $ref: "#/components/schemas/TaskIdList" + description: The list of task identifiers that were not found. + ThreatModelJobTaskList: + description: List of threat model job tasks. + type: array + items: + $ref: "#/components/schemas/ThreatModelJobTask" + ThreatModelJobTask: + description: Represents an individual task within a threat model job. type: object properties: + taskId: + $ref: "#/components/schemas/String" + description: The unique identifier of the task. + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model associated with the task. + threatModelJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job that contains the task. agentSpaceId: - $ref: "#/components/schemas/AgentSpaceId" - description: The unique identifier of the created agent space. - name: - $ref: "#/components/schemas/AgentName" - description: The name of the agent space. + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space. + title_: + $ref: "#/components/schemas/String" + description: The title of the task. description: $ref: "#/components/schemas/String" - description: The description of the agent space. - awsResources: - $ref: "#/components/schemas/AWSResources" - description: The AWS resources associated with the agent space. - targetDomainIds: - $ref: "#/components/schemas/TargetDomainIdList" - description: The list of target domain identifiers associated with the agent space. - codeReviewSettings: - $ref: "#/components/schemas/CodeReviewSettings" - description: The code review settings for the agent space. - kmsKeyId: - $ref: "#/components/schemas/KmsKeyId" - description: The identifier of the AWS KMS key used to encrypt data in the agent space. + description: A description of the task. + executionStatus: + $ref: "#/components/schemas/TaskExecutionStatus" + description: The current execution status of the task. + logsLocation: + $ref: "#/components/schemas/LogLocation" + description: The location of the task execution logs. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the agent space was created, in UTC format. + description: The date and time the task was created, in UTC format. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the agent space was last updated, in UTC format. + description: The date and time the task was last updated, in UTC format. required: - - agentSpaceId - - name - IdCInstanceArn: - description: ARN of the IAM Identity Center instance used for user authentication. - type: string - RoleArn: - description: ARN of the IAM role that the application uses to access AWS resources on your behalf. - type: string - DefaultKmsKeyId: - description: Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN. - type: string - CreateApplicationResponse: + - taskId + ThreatModelJobIdList: + description: List of threat model job IDs. + type: array + items: + $ref: "#/components/schemas/String" + BatchGetThreatModelJobsOutput: + description: Output for the BatchGetThreatModelJobs operation. type: object properties: - applicationId: - $ref: "#/components/schemas/ApplicationId" - description: The unique identifier of the created application. - required: - - applicationId - ApplicationId: - description: Application identifier. - type: string - CreateCodeReviewOutput: - description: Output for the CreateCodeReview operation. + threatModelJobs: + $ref: "#/components/schemas/ThreatModelJobList" + description: The list of threat model jobs that were found. + notFound: + $ref: "#/components/schemas/ThreatModelJobIdList" + description: The list of threat model job identifiers that were not found. + ThreatModelJobList: + description: List of threat model jobs. + type: array + items: + $ref: "#/components/schemas/ThreatModelJob" + ThreatModelJob: + description: Represents a threat model job, which is an execution instance of a threat model. type: object properties: - codeReviewId: + threatModelJobId: $ref: "#/components/schemas/String" - description: The unique identifier of the created code review. + description: The unique identifier of the threat model job. + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model associated with the job. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space. title_: $ref: "#/components/schemas/String" - description: The title of the code review. + description: The title of the threat model job. + status: + $ref: "#/components/schemas/JobStatus" + description: The current status of the threat model job. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the code review was created, in UTC format. + description: The date and time the threat model job was created, in UTC format. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the code review was last updated, in UTC format. - assets: - $ref: "#/components/schemas/Assets" - description: The assets included in the code review. - serviceRole: - $ref: "#/components/schemas/ServiceRole" - description: The IAM service role used for the code review. - logConfig: - $ref: "#/components/schemas/CloudWatchLog" - description: The CloudWatch Logs configuration for the code review. - agentSpaceId: - $ref: "#/components/schemas/String" - description: The unique identifier of the agent space that contains the code review. - codeRemediationStrategy: - $ref: "#/components/schemas/CodeRemediationStrategy" - description: The code remediation strategy for the code review. - required: - - codeReviewId - Provider: + description: The date and time the threat model job was last updated, in UTC format. + executionStartTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model job execution started, in UTC format. + executionEndTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model job execution ended, in UTC format. + sourceCode: + $ref: "#/components/schemas/SourceCodeRepositoryList" + description: The list of source code repositories used for threat modeling. + integratedRepositories: + $ref: "#/components/schemas/IntegratedRepositoryList" + description: The list of integrated repositories used for threat modeling. + documents: + $ref: "#/components/schemas/DocumentList" + description: The list of documents used for threat modeling. + scopeDocs: + $ref: "#/components/schemas/DocumentList" + description: The scoped documents for the agent to focus on during threat modeling. + errorInformation: + $ref: "#/components/schemas/ErrorInformation" + description: Error information if the threat model job encountered an error. + systemOverview: + $ref: "#/components/schemas/String" + description: The system overview generated during threat modeling. + BatchGetThreatModelsOutput: + description: Output for the BatchGetThreatModels operation. + type: object + properties: + threatModels: + $ref: "#/components/schemas/ThreatModelList" + description: The list of threat models that were found. + notFound: + $ref: "#/components/schemas/ThreatModelIdList" + description: The list of threat model identifiers that were not found. + ThreatModelList: + description: List of threat models. + type: array + items: + $ref: "#/components/schemas/ThreatModel" + ThreatModel: + description: Represents a threat model configuration that defines the parameters for automated threat analysis, including target assets and logging configuration. + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space that contains the threat model. + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model. + description: + $ref: "#/components/schemas/String" + description: A description of the application or system being threat modeled. + assets: + $ref: "#/components/schemas/Assets" + description: The assets included in the threat model. + scopeDocs: + $ref: "#/components/schemas/DocumentList" + description: The scoped documents for the agent to focus on during threat modeling. + serviceRole: + $ref: "#/components/schemas/ServiceRole" + description: The IAM service role used for the threat model. + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + description: The CloudWatch Logs configuration for the threat model. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was last updated, in UTC format. + required: + - threatModelId + - agentSpaceId + - title_ + - assets + ThreatIdList: + description: List of threat IDs. + type: array + items: + $ref: "#/components/schemas/String" + BatchGetThreatsOutput: + description: Output for the BatchGetThreats operation. + type: object + properties: + threats: + $ref: "#/components/schemas/ThreatList" + description: The list of threats that were found. + notFound: + $ref: "#/components/schemas/ThreatIdList" + description: The list of threat identifiers that were not found. + ThreatList: + description: List of threats. + type: array + items: + $ref: "#/components/schemas/Threat" + Threat: + description: Represents a threat identified during threat modeling. + type: object + properties: + threatId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat. + threatJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job that produced the threat. + title_: + $ref: "#/components/schemas/String" + description: A short title summarizing the threat. + statement: + $ref: "#/components/schemas/String" + description: The natural-language threat statement. + severity: + $ref: "#/components/schemas/ThreatSeverity" + description: The severity level of the threat. + status: + $ref: "#/components/schemas/ThreatStatus" + description: The current status of the threat. + comments: + $ref: "#/components/schemas/String" + description: Optional customer comment on the threat. + threatSource: + $ref: "#/components/schemas/String" + description: The actor or origin of the threat. + prerequisites: + $ref: "#/components/schemas/String" + description: The conditions required for the threat to be exploitable. + threatAction: + $ref: "#/components/schemas/String" + description: What the threat source can do. + threatImpact: + $ref: "#/components/schemas/String" + description: The direct consequence of the threat action. + impactedGoal: + $ref: "#/components/schemas/StringList" + description: The security goals affected by the threat. + impactedAssets: + $ref: "#/components/schemas/StringList" + description: The specific assets affected by the threat. + anchor: + $ref: "#/components/schemas/ThreatAnchorShape" + description: The DFD element this threat is anchored to. + evidence: + $ref: "#/components/schemas/ThreatEvidenceList" + description: The source code files supporting the threat. + stride: + $ref: "#/components/schemas/StrideCategoryList" + description: The STRIDE categories applicable to this threat. + recommendation: + $ref: "#/components/schemas/String" + description: The recommended mitigation guidance for this threat. + createdBy: + $ref: "#/components/schemas/ThreatActor" + description: Who created this threat. + updatedBy: + $ref: "#/components/schemas/ThreatActor" + description: Who last updated this threat. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was last updated, in UTC format. + ThreatSeverity: + description: Severity level for a threat. + type: string + enum: + - CRITICAL + - HIGH + - MEDIUM + - LOW + - INFO + ThreatStatus: + description: Status of a threat. + type: string + enum: + - OPEN + - RESOLVED + - DISMISSED + ThreatAnchorShape: + description: DFD element that a threat is anchored to. + type: object + properties: + kind: + $ref: "#/components/schemas/String" + description: The kind of DFD element. + id: + $ref: "#/components/schemas/String" + description: The identifier of the DFD element. + packageId: + $ref: "#/components/schemas/String" + description: The package identifier containing the DFD element. + ThreatEvidenceList: + description: List of threat evidence. + type: array + items: + $ref: "#/components/schemas/ThreatEvidenceShape" + ThreatEvidenceShape: + description: Source code file supporting a threat. + type: object + properties: + packageId: + $ref: "#/components/schemas/String" + description: The package identifier containing the evidence file. + path: + $ref: "#/components/schemas/String" + description: The file path of the evidence. + StrideCategoryList: + description: List of STRIDE categories. + type: array + items: + $ref: "#/components/schemas/StrideCategory" + StrideCategory: + description: STRIDE threat classification category. + type: string + enum: + - SPOOFING + - TAMPERING + - REPUDIATION + - INFORMATION_DISCLOSURE + - DENIAL_OF_SERVICE + - ELEVATION_OF_PRIVILEGE + ThreatActor: + description: Indicates whether a threat was created or updated by a customer or an agent. + type: string + enum: + - CUSTOMER + - AGENT + UpdateSecurityRequirementEntryList: + description: List of security requirement updates to apply. + type: array + items: + $ref: "#/components/schemas/UpdateSecurityRequirementEntry" + UpdateSecurityRequirementEntry: + description: Contains the details for updating an existing security requirement within a pack. The name is an immutable identifier used to locate the requirement and cannot be modified. + type: object + properties: + name: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement to update. This is an immutable identifier and cannot be changed once the requirement is created. + description: + $ref: "#/components/schemas/String" + description: The updated description of the security requirement. + domain: + $ref: "#/components/schemas/String" + description: The updated security domain the requirement belongs to. + evaluation: + $ref: "#/components/schemas/String" + description: The updated evaluation criteria used to assess compliance with this requirement. + remediation: + $ref: "#/components/schemas/String" + description: The updated remediation steps when the requirement is not met. + required: + - name + BatchUpdateSecurityRequirementsOutput: + type: object + properties: + updatedSecurityRequirementNames: + $ref: "#/components/schemas/SecurityRequirementNameList" + description: The list of security requirement names that were successfully updated. + errors: + $ref: "#/components/schemas/BatchSecurityRequirementErrors" + description: The list of errors for security requirements that failed to be updated. + required: + - updatedSecurityRequirementNames + - errors + AgentName: + description: Name of an agent space. + type: string + TagMap: + description: Map of tags for a resource. + type: object + properties: {} + CreateAgentSpaceOutput: + description: Output for the CreateAgentSpace operation. + type: object + properties: + agentSpaceId: + $ref: "#/components/schemas/AgentSpaceId" + description: The unique identifier of the created agent space. + name: + $ref: "#/components/schemas/AgentName" + description: The name of the agent space. + description: + $ref: "#/components/schemas/String" + description: The description of the agent space. + awsResources: + $ref: "#/components/schemas/AWSResources" + description: The AWS resources associated with the agent space. + targetDomainIds: + $ref: "#/components/schemas/TargetDomainIdList" + description: The list of target domain identifiers associated with the agent space. + codeReviewSettings: + $ref: "#/components/schemas/CodeReviewSettings" + description: The code review settings for the agent space. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier of the AWS KMS key used to encrypt data in the agent space. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the agent space was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the agent space was last updated, in UTC format. + required: + - agentSpaceId + - name + IdCInstanceArn: + description: ARN of the IAM Identity Center instance used for user authentication. + type: string + RoleArn: + description: ARN of the IAM role that the application uses to access AWS resources on your behalf. + type: string + DefaultKmsKeyId: + description: Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN. + type: string + CreateApplicationResponse: + type: object + properties: + applicationId: + $ref: "#/components/schemas/ApplicationId" + description: The unique identifier of the created application. + required: + - applicationId + ApplicationId: + description: Application identifier. + type: string + CreateCodeReviewOutput: + description: Output for the CreateCodeReview operation. + type: object + properties: + codeReviewId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created code review. + title_: + $ref: "#/components/schemas/String" + description: The title of the code review. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the code review was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the code review was last updated, in UTC format. + assets: + $ref: "#/components/schemas/Assets" + description: The assets included in the code review. + serviceRole: + $ref: "#/components/schemas/ServiceRole" + description: The IAM service role used for the code review. + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + description: The CloudWatch Logs configuration for the code review. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space that contains the code review. + codeRemediationStrategy: + $ref: "#/components/schemas/CodeRemediationStrategy" + description: The code remediation strategy for the code review. + validationMode: + $ref: "#/components/schemas/ValidationMode" + description: The validation mode for the code review. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours configured for jobs started from this code review. Null if no budget cap is set. + required: + - codeReviewId + Provider: description: Third-party provider type. type: string enum: - GITHUB + - GITLAB + - BITBUCKET + - CONFLUENCE ProviderInput: description: The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration. type: object @@ -3184,6 +4856,15 @@ components: github: $ref: "#/components/schemas/GitHubIntegrationInput" description: The GitHub-specific input for creating an integration. + gitlab: + $ref: "#/components/schemas/GitLabIntegrationInput" + description: The configuration for a GitLab integration. + bitbucket: + $ref: "#/components/schemas/BitbucketIntegrationInput" + description: The configuration for a Bitbucket integration. + confluence: + $ref: "#/components/schemas/ConfluenceIntegrationInput" + description: The configuration for a Confluence integration. GitHubIntegrationInput: description: The input required to create a GitHub integration, including the OAuth authorization code and CSRF state. type: object @@ -3197,6 +4878,12 @@ components: organizationName: $ref: "#/components/schemas/String" description: The name of the GitHub organization to integrate with. + targetUrl: + $ref: "#/components/schemas/TargetUrl" + description: The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com. + installationId: + $ref: "#/components/schemas/String" + description: The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com. required: - code - state @@ -3206,6 +4893,94 @@ components: CsrfState: description: CSRF state token for OAuth security. type: string + TargetUrl: + description: The HTTPS URL of a customer self-hosted instance. + type: string + GitLabIntegrationInput: + description: The configuration for creating a GitLab integration. + type: object + properties: + accessToken: + $ref: "#/components/schemas/AccessToken" + description: The GitLab access token used to authenticate. This can be a personal access token or a group access token. + targetUrl: + $ref: "#/components/schemas/TargetUrl" + description: The HTTPS URL of a self-managed GitLab instance. Omit this value for GitLab SaaS (gitlab.com). + tokenType: + $ref: "#/components/schemas/GitLabTokenType" + description: The type of GitLab access token provided in accessToken. + groupId: + $ref: "#/components/schemas/String" + description: The identifier of the GitLab group. Required when tokenType is group and ignored for personal tokens. + required: + - accessToken + - tokenType + AccessToken: + description: A GitLab access token used to authenticate with the provider. + type: string + GitLabTokenType: + description: The type of GitLab access token. + type: string + enum: + - PERSONAL + - GROUP + BitbucketIntegrationInput: + description: The configuration for creating a Bitbucket integration. + type: object + properties: + installationId: + $ref: "#/components/schemas/BitbucketInstallationId" + description: The Atlassian installation identifier, available from the Atlassian administration console. + workspace: + $ref: "#/components/schemas/BitbucketWorkspace" + description: The Bitbucket workspace slug that identifies the workspace to integrate, for example acme-corp. + code: + $ref: "#/components/schemas/AuthCode" + description: The OAuth 2.0 authorization code returned from the consent redirect. + state: + $ref: "#/components/schemas/CsrfState" + description: The CSRF state token echoed back from the OAuth redirect. + required: + - installationId + - workspace + - code + - state + BitbucketInstallationId: + description: An Atlassian installation identifier for a Bitbucket integration. + type: string + BitbucketWorkspace: + description: A Bitbucket workspace slug that identifies a workspace. + type: string + ConfluenceIntegrationInput: + description: The configuration for creating a Confluence integration. + type: object + properties: + installationId: + $ref: "#/components/schemas/ConfluenceInstallationId" + description: The Atlassian installation identifier, available from the Atlassian administration console. + code: + $ref: "#/components/schemas/AuthCode" + description: The OAuth 2.0 authorization code returned from the consent redirect. + state: + $ref: "#/components/schemas/CsrfState" + description: The CSRF state token echoed back from the OAuth redirect. + siteUrl: + $ref: "#/components/schemas/ConfluenceSiteUrl" + description: The Confluence Cloud site URL, for example https://mysite.atlassian.net. + required: + - installationId + - code + - state + - siteUrl + ConfluenceInstallationId: + description: An Atlassian installation identifier for a Confluence integration. + type: string + ConfluenceSiteUrl: + description: The URL of a Confluence Cloud site. + type: string + PrivateConnectionName: + description: The unique name of a private connection within your account. + type: string CreateIntegrationOutput: type: object properties: @@ -3278,6 +5053,196 @@ components: agentSpaceId: $ref: "#/components/schemas/String" description: The unique identifier of the agent space that contains the pentest. + PrivateConnectionMode: + description: The configuration for a private connection. Specify either a service-managed or a self-managed mode. + type: object + properties: + serviceManaged: + $ref: "#/components/schemas/ServiceManagedInput" + description: The configuration for a service-managed private connection, where the service manages the resource gateway lifecycle. + selfManaged: + $ref: "#/components/schemas/SelfManagedInput" + description: The configuration for a self-managed private connection, where you manage your own resource configuration. + ServiceManagedInput: + description: The configuration for a service-managed private connection. + type: object + properties: + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The VPC to create the service-managed resource gateway in. + subnetIds: + $ref: "#/components/schemas/PrivateConnectionSubnetIds" + description: The subnets that the service-managed resource gateway spans. + securityGroupIds: + $ref: "#/components/schemas/PrivateConnectionSecurityGroupIds" + description: The security groups to attach to the service-managed resource gateway. + ipAddressType: + $ref: "#/components/schemas/IpAddressType" + description: The IP address type of the service-managed resource gateway. + ipv4AddressesPerEni: + $ref: "#/components/schemas/MaxIpv4AddressesPerEni" + description: The number of IPv4 addresses in each elastic network interface for the service-managed resource gateway. + portRanges: + $ref: "#/components/schemas/PortRanges" + description: The TCP port ranges that a consumer can use to access the resource. + certificate: + $ref: "#/components/schemas/CertificateChain" + description: The certificate for the private connection. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set. + required: + - hostAddress + - vpcId + - subnetIds + HostAddress: + description: The IP address or DNS name of a target resource. + type: string + PrivateConnectionVpcId: + description: The identifier of a VPC. + type: string + PrivateConnectionSubnetIds: + description: The subnets that the resource gateway spans. + type: array + items: + $ref: "#/components/schemas/PrivateConnectionSubnetId" + PrivateConnectionSubnetId: + description: The identifier of a subnet. + type: string + PrivateConnectionSecurityGroupIds: + description: The security groups attached to the resource gateway. + type: array + items: + $ref: "#/components/schemas/PrivateConnectionSecurityGroupId" + PrivateConnectionSecurityGroupId: + description: The identifier of a security group. + type: string + IpAddressType: + description: The IP address type of a resource gateway. + type: string + enum: + - IPV4 + - IPV6 + - DUAL_STACK + MaxIpv4AddressesPerEni: + description: The number of IPv4 addresses in each elastic network interface for the resource gateway. + type: integer + PortRanges: + description: The TCP port ranges that a consumer can use to access the resource. + type: array + items: + $ref: "#/components/schemas/PortRange" + PortRange: + description: A single TCP port or an inclusive range of TCP ports, for example 443 or 8000-8100. + type: string + CertificateChain: + description: A PEM-encoded certificate chain for a private connection. + type: string + ResourceConfigDnsResolution: + description: The DNS resolution mode for a resource gateway. + type: string + enum: + - PUBLIC + - IN_VPC + SelfManagedInput: + description: The configuration for a self-managed private connection. + type: object + properties: + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the resource configuration. + certificate: + $ref: "#/components/schemas/CertificateChain" + description: The certificate for the private connection. + required: + - resourceConfigurationId + ResourceConfigurationId: + description: The identifier or ARN of a VPC Lattice resource configuration. + type: string + CreatePrivateConnectionOutput: + type: object + properties: + name: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection. + type_: + $ref: "#/components/schemas/PrivateConnectionType" + description: The type of the private connection, indicating whether it is service-managed or self-managed. + status: + $ref: "#/components/schemas/PrivateConnectionStatus" + description: The current status of the private connection. + resourceGatewayId: + $ref: "#/components/schemas/ResourceGatewayId" + description: The identifier or ARN of the VPC Lattice resource gateway. + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The identifier of the VPC the resource gateway is created in. + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the VPC Lattice resource configuration. + certificateExpiryTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the connection's certificate expires, in UTC format. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. + failureMessage: + $ref: "#/components/schemas/String" + description: A message describing why the private connection entered a failed state, if applicable. + tags: + type: object + properties: {} + description: The tags attached to the private connection. + required: + - name + - type_ + - status + PrivateConnectionType: + description: The type of a private connection, indicating whether it is service-managed or self-managed. + type: string + enum: + - SERVICE_MANAGED + - SELF_MANAGED + PrivateConnectionStatus: + description: The status of a private connection. + type: string + enum: + - ACTIVE + - CREATE_IN_PROGRESS + - CREATE_FAILED + - DELETE_IN_PROGRESS + - DELETE_FAILED + ResourceGatewayId: + description: The identifier or ARN of a VPC Lattice resource gateway. + type: string + SecurityRequirementPackName: + type: string + SecurityRequirementPackStatus: + type: string + enum: + - ENABLED + - DISABLED + CreateSecurityRequirementPackOutput: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the created security requirement pack. + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + description: The status of the created security requirement pack. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier of the AWS KMS key used to encrypt pack contents. + required: + - packId + - status CreateTargetDomainOutput: description: Output for the CreateTargetDomain operation. type: object @@ -3307,6 +5272,131 @@ components: - targetDomainId - domainName - verificationStatus + CreateThreatOutput: + description: Output for the CreateThreat operation. + type: object + properties: + threatId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created threat. + threatJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job the threat belongs to. + title_: + $ref: "#/components/schemas/String" + description: A short title summarizing the threat. + statement: + $ref: "#/components/schemas/String" + description: The natural-language threat statement. + severity: + $ref: "#/components/schemas/ThreatSeverity" + description: The severity level of the threat. + status: + $ref: "#/components/schemas/ThreatStatus" + description: The current status of the threat. + comments: + $ref: "#/components/schemas/String" + description: Optional customer comment on the threat. + stride: + $ref: "#/components/schemas/StrideCategoryList" + description: The STRIDE categories applicable to this threat. + threatSource: + $ref: "#/components/schemas/String" + description: The actor or origin of the threat. + prerequisites: + $ref: "#/components/schemas/String" + description: The conditions required for the threat to be exploitable. + threatAction: + $ref: "#/components/schemas/String" + description: What the threat source can do. + threatImpact: + $ref: "#/components/schemas/String" + description: The direct consequence of the threat action. + impactedGoal: + $ref: "#/components/schemas/StringList" + description: The security goals affected by the threat. + impactedAssets: + $ref: "#/components/schemas/StringList" + description: The specific assets affected by the threat. + anchor: + $ref: "#/components/schemas/ThreatAnchorShape" + description: The DFD element this threat is anchored to. + evidence: + $ref: "#/components/schemas/ThreatEvidenceList" + description: The source code files supporting the threat. + recommendation: + $ref: "#/components/schemas/String" + description: The recommended mitigation guidance for this threat. + createdBy: + $ref: "#/components/schemas/ThreatActor" + description: Who created this threat. + updatedBy: + $ref: "#/components/schemas/ThreatActor" + description: Who last updated this threat. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was last updated, in UTC format. + required: + - threatId + - threatJobId + ReportDestination: + description: Destination for publishing scan reports to an integrated document provider. + type: object + properties: + integrationId: + $ref: "#/components/schemas/String" + description: The integration identifier for the document provider. + containerId: + $ref: "#/components/schemas/String" + description: The container identifier where the report will be published. + parentId: + $ref: "#/components/schemas/String" + description: The parent document identifier under which the report will be created. + documentId: + $ref: "#/components/schemas/String" + description: The existing document identifier to update instead of creating a new document. + required: + - integrationId + - containerId + CreateThreatModelOutput: + description: Output for the CreateThreatModel operation. + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the created threat model. + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space that contains the threat model. + description: + $ref: "#/components/schemas/String" + description: A description of the application or system being threat modeled. + assets: + $ref: "#/components/schemas/Assets" + description: The assets included in the threat model. + scopeDocs: + $ref: "#/components/schemas/DocumentList" + description: The scoped documents for the agent to focus on during threat modeling. + serviceRole: + $ref: "#/components/schemas/ServiceRole" + description: The IAM service role used for the threat model. + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + description: The CloudWatch Logs configuration for the threat model. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was last updated, in UTC format. + required: + - threatModelId DeleteAgentSpaceOutput: description: Output for the DeleteAgentSpace operation. type: object @@ -3321,6 +5411,49 @@ components: DeleteMembershipResponse: description: Response structure for removing a single member from an agent space. type: object + DeletePrivateConnectionOutput: + type: object + properties: + name: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection. + type_: + $ref: "#/components/schemas/PrivateConnectionType" + description: The type of the private connection, indicating whether it is service-managed or self-managed. + status: + $ref: "#/components/schemas/PrivateConnectionStatus" + description: The current status of the private connection. + resourceGatewayId: + $ref: "#/components/schemas/ResourceGatewayId" + description: The identifier or ARN of the VPC Lattice resource gateway. + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The identifier of the VPC the resource gateway is created in. + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the VPC Lattice resource configuration. + certificateExpiryTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the connection's certificate expires, in UTC format. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. + failureMessage: + $ref: "#/components/schemas/String" + description: A message describing why the private connection entered a failed state, if applicable. + tags: + type: object + properties: {} + description: The tags attached to the private connection. + required: + - name + - type_ + - status + DeleteSecurityRequirementPackOutput: + type: object DeleteTargetDomainOutput: description: Output for the DeleteTargetDomain operation. type: object @@ -3328,6 +5461,47 @@ components: targetDomainId: $ref: "#/components/schemas/TargetDomainId" description: The unique identifier of the deleted target domain. + DescribePrivateConnectionOutput: + type: object + properties: + name: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection. + type_: + $ref: "#/components/schemas/PrivateConnectionType" + description: The type of the private connection, indicating whether it is service-managed or self-managed. + status: + $ref: "#/components/schemas/PrivateConnectionStatus" + description: The current status of the private connection. + resourceGatewayId: + $ref: "#/components/schemas/ResourceGatewayId" + description: The identifier or ARN of the VPC Lattice resource gateway. + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The identifier of the VPC the resource gateway is created in. + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the VPC Lattice resource configuration. + certificateExpiryTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the connection's certificate expires, in UTC format. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. + failureMessage: + $ref: "#/components/schemas/String" + description: A message describing why the private connection entered a failed state, if applicable. + tags: + type: object + properties: {} + description: The tags attached to the private connection. + required: + - name + - type_ + - status GetApplicationResponse: type: object properties: @@ -3426,6 +5600,12 @@ components: kmsKeyId: $ref: "#/components/schemas/KmsKeyId" description: The identifier of the AWS KMS key used to encrypt data associated with the integration. + targetUrl: + $ref: "#/components/schemas/TargetUrl" + description: The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations. + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured. required: - integrationId - installationId @@ -3435,8 +5615,114 @@ components: description: Type of provider integration. type: string enum: - - SOURCE_CODE - - DOCUMENTATION + - SOURCE_CODE + - DOCUMENTATION + GetSecurityRequirementPackOutput: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the security requirement pack. + name: + $ref: "#/components/schemas/SecurityRequirementPackName" + description: The name of the security requirement pack. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement pack. + vendorName: + $ref: "#/components/schemas/String" + description: The vendor name for AWS managed packs, such as ISO or NIST. + managementType: + $ref: "#/components/schemas/ManagementType" + description: The management type of the pack. Valid values are AWS_MANAGED and CUSTOMER_MANAGED. + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + description: The status of the security requirement pack. + importStatus: + $ref: "#/components/schemas/SecurityRequirementPackImportStatus" + description: The status of the security requirements import workflow for this pack. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement pack was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement pack was last updated, in UTC format. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The identifier of the AWS KMS key used to encrypt pack contents. + required: + - packId + - name + - managementType + - status + - createdAt + - updatedAt + ManagementType: + type: string + enum: + - AWS_MANAGED + - CUSTOMER_MANAGED + SecurityRequirementPackImportStatus: + type: string + enum: + - PENDING + - IN_PROGRESS + - FAILED + - COMPLETED + ImportSource: + description: The source from which to import security requirements. Currently supports document uploads. + type: object + properties: + documents: + $ref: "#/components/schemas/SecurityRequirementArtifactList" + description: The list of documents to extract security requirements from. + SecurityRequirementArtifactList: + description: List of documents used as source material for importing security requirements. + type: array + items: + $ref: "#/components/schemas/SecurityRequirementArtifact" + SecurityRequirementArtifact: + description: A document used as source material for importing security requirements. + type: object + properties: + name: + $ref: "#/components/schemas/SecurityRequirementArtifactName" + description: The file name of the document. + format_: + $ref: "#/components/schemas/SecurityRequirementArtifactFormat" + description: The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC. + content: + $ref: "#/components/schemas/SecurityRequirementDocumentContent" + description: The binary content of the document. + required: + - name + - format_ + - content + SecurityRequirementArtifactName: + type: string + SecurityRequirementArtifactFormat: + type: string + enum: + - MD + - PDF + - TXT + - DOCX + - DOC + SecurityRequirementDocumentContent: + type: string + format: byte + ImportSecurityRequirementsOutput: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the security requirement pack. + importStatus: + $ref: "#/components/schemas/SecurityRequirementPackImportStatus" + description: The status of the import workflow. + required: + - packId + - importStatus InitiateProviderRegistrationOutput: type: object properties: @@ -3782,6 +6068,9 @@ components: confidence: $ref: "#/components/schemas/ConfidenceLevel" description: The confidence level of the finding. + validationStatus: + $ref: "#/components/schemas/ValidationStatus" + description: The simulated validation status of the finding. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the finding was created, in UTC format. @@ -3796,6 +6085,7 @@ components: type: string enum: - CODE_REPOSITORY + - DOCUMENT ListIntegratedResourcesOutput: type: object properties: @@ -3835,6 +6125,12 @@ components: githubRepository: $ref: "#/components/schemas/GitHubRepositoryMetadata" description: The GitHub repository metadata. + gitlabRepository: + $ref: "#/components/schemas/GitLabRepositoryMetadata" + bitbucketRepository: + $ref: "#/components/schemas/BitbucketRepositoryMetadata" + confluenceDocument: + $ref: "#/components/schemas/ConfluenceDocumentMetadata" GitHubRepositoryMetadata: description: Contains metadata about a GitHub repository that is integrated with the service. type: object @@ -3870,6 +6166,68 @@ components: enum: - PRIVATE - PUBLIC + GitLabRepositoryMetadata: + description: Metadata for an integrated GitLab repository. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + providerResourceId: + $ref: "#/components/schemas/ProviderResourceId" + namespace: + $ref: "#/components/schemas/GitLabNamespace" + description: The namespace (group or user path) that owns the project. + accessType: + $ref: "#/components/schemas/AccessType" + required: + - name + - providerResourceId + - namespace + GitLabNamespace: + description: A GitLab namespace (group or user path). + type: string + BitbucketRepositoryMetadata: + description: Metadata for an integrated Bitbucket repository. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + providerResourceId: + $ref: "#/components/schemas/ProviderResourceId" + workspace: + $ref: "#/components/schemas/BitbucketWorkspace" + description: The workspace slug that owns the repository. + accessType: + $ref: "#/components/schemas/AccessType" + required: + - name + - providerResourceId + - workspace + ConfluenceDocumentMetadata: + description: Metadata for an integrated Confluence document. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + providerResourceId: + $ref: "#/components/schemas/ProviderResourceId" + spaceKey: + $ref: "#/components/schemas/String" + description: The Confluence space key containing the document. + pageId: + $ref: "#/components/schemas/String" + description: The Confluence page identifier. + title_: + $ref: "#/components/schemas/String" + description: The display title of the Confluence page. + spaceTitle: + $ref: "#/components/schemas/String" + description: The display title of the Confluence space. + required: + - name + - providerResourceId + - spaceKey + - pageId ProviderResourceCapabilities: description: The capabilities for an integrated resource from a third-party provider. This is a union type that contains provider-specific capabilities. type: object @@ -3877,6 +6235,12 @@ components: github: $ref: "#/components/schemas/GitHubResourceCapabilities" description: The GitHub-specific resource capabilities. + gitlab: + $ref: "#/components/schemas/GitLabResourceCapabilities" + bitbucket: + $ref: "#/components/schemas/BitbucketResourceCapabilities" + confluence: + $ref: "#/components/schemas/ConfluenceResourceCapabilities" GitHubResourceCapabilities: description: The capabilities enabled for a GitHub resource integration. type: object @@ -3887,6 +6251,39 @@ components: remediateCode: $ref: "#/components/schemas/Boolean" description: Indicates whether the integration can create code remediation pull requests. + GitLabResourceCapabilities: + description: Capabilities for an integrated GitLab repository. + type: object + properties: + leaveComments: + $ref: "#/components/schemas/Boolean" + description: Whether to post code review comments on merge request discussions. + remediateCode: + $ref: "#/components/schemas/Boolean" + description: Whether to create merge requests with automated fixes. + BitbucketResourceCapabilities: + description: Capabilities for an integrated Bitbucket repository. + type: object + properties: + leaveComments: + $ref: "#/components/schemas/Boolean" + description: Whether to post code review comments on pull requests. + remediateCode: + $ref: "#/components/schemas/Boolean" + description: Whether to create pull requests with automated fixes. + ConfluenceResourceCapabilities: + description: Capabilities for an integrated Confluence space. + type: object + properties: + fetchDocument: + $ref: "#/components/schemas/Boolean" + description: Whether to fetch documents from this space. + createDocument: + $ref: "#/components/schemas/Boolean" + description: Whether to create documents in this space. + updateDocument: + $ref: "#/components/schemas/Boolean" + description: Whether to update documents in this space. IntegrationFilter: description: A filter for listing integrations. This is a union type where you can filter by provider or provider type. type: object @@ -3932,6 +6329,12 @@ components: displayName: $ref: "#/components/schemas/String" description: The display name of the integration. + targetUrl: + $ref: "#/components/schemas/TargetUrl" + description: The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations. + privateConnectionName: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured. required: - integrationId - installationId @@ -4066,6 +6469,9 @@ components: executionStatus: $ref: "#/components/schemas/TaskExecutionStatus" description: The current execution status of the task. + taskHours: + $ref: "#/components/schemas/Double" + description: The number of active work hours consumed by the task during execution. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The date and time the task was created, in UTC format. @@ -4150,6 +6556,166 @@ components: - pentestId - agentSpaceId - title_ + ListPrivateConnectionsOutput: + type: object + properties: + privateConnections: + $ref: "#/components/schemas/PrivateConnectionList" + description: The list of private connections. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token to use to retrieve the next page of results, if more results are available. + required: + - privateConnections + PrivateConnectionList: + description: A list of private connection summaries. + type: array + items: + $ref: "#/components/schemas/PrivateConnectionSummary" + PrivateConnectionSummary: + description: Summarizes a private connection. + type: object + properties: + name: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection. + type_: + $ref: "#/components/schemas/PrivateConnectionType" + description: The type of the private connection, indicating whether it is service-managed or self-managed. + status: + $ref: "#/components/schemas/PrivateConnectionStatus" + description: The current status of the private connection. + resourceGatewayId: + $ref: "#/components/schemas/ResourceGatewayId" + description: The identifier or ARN of the VPC Lattice resource gateway. + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The identifier of the VPC the resource gateway is created in. + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the VPC Lattice resource configuration. + certificateExpiryTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the connection's certificate expires, in UTC format. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. + failureMessage: + $ref: "#/components/schemas/String" + description: A message describing why the private connection entered a failed state, if applicable. + tags: + type: object + properties: {} + description: The tags attached to the private connection. + required: + - name + - type_ + - status + ListSecurityRequirementPackFilter: + description: Filter criteria for listing security requirement packs. + type: object + properties: + managementType: + $ref: "#/components/schemas/ManagementType" + description: Filter packs by management type. Valid values are AWS_MANAGED and CUSTOMER_MANAGED. + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + description: Filter packs by status. Valid values are ENABLED and DISABLED. + ListSecurityRequirementPacksOutput: + type: object + properties: + securityRequirementPackSummaries: + $ref: "#/components/schemas/SecurityRequirementPackSummaryList" + description: The list of security requirement pack summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use in a subsequent request to retrieve the next page of results. + required: + - securityRequirementPackSummaries + SecurityRequirementPackSummaryList: + description: List of security requirement pack summaries. + type: array + items: + $ref: "#/components/schemas/SecurityRequirementPackSummary" + SecurityRequirementPackSummary: + description: Contains summary information about a security requirement pack. + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the security requirement pack. + name: + $ref: "#/components/schemas/SecurityRequirementPackName" + description: The name of the security requirement pack. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement pack. + vendorName: + $ref: "#/components/schemas/String" + description: The vendor name for AWS managed packs. + managementType: + $ref: "#/components/schemas/ManagementType" + description: The management type of the pack. + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + description: The status of the security requirement pack. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement pack was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement pack was last updated, in UTC format. + required: + - packId + - name + - managementType + - status + - createdAt + - updatedAt + ListSecurityRequirementsOutput: + type: object + properties: + securityRequirementSummaries: + $ref: "#/components/schemas/SecurityRequirementSummaryList" + description: The list of security requirement summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use in a subsequent request to retrieve the next page of results. + required: + - securityRequirementSummaries + SecurityRequirementSummaryList: + description: List of security requirement summaries. + type: array + items: + $ref: "#/components/schemas/SecurityRequirementSummary" + SecurityRequirementSummary: + description: Contains summary information about a security requirement. + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the pack containing the security requirement. + name: + $ref: "#/components/schemas/SecurityRequirementName" + description: The name of the security requirement. + description: + $ref: "#/components/schemas/String" + description: A description of the security requirement. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the security requirement was last updated, in UTC format. + required: + - packId + - name + - description + - createdAt + - updatedAt ResourceArn: description: ARN of a taggable resource. type: string @@ -4191,9 +6757,194 @@ components: required: - targetDomainId - domainName + ListThreatModelJobTasksOutput: + description: Output for the ListThreatModelJobTasks operation. + type: object + properties: + threatModelJobTaskSummaries: + $ref: "#/components/schemas/ThreatModelJobTaskSummaryList" + description: The list of threat model job task summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for paginating results that are returned in the response. + ThreatModelJobTaskSummaryList: + description: List of threat model job task summaries. + type: array + items: + $ref: "#/components/schemas/ThreatModelJobTaskSummary" + ThreatModelJobTaskSummary: + description: Contains summary information about a threat model job task. + type: object + properties: + taskId: + $ref: "#/components/schemas/String" + description: The unique identifier of the task. + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model associated with the task. + threatModelJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job that contains the task. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space. + title_: + $ref: "#/components/schemas/String" + description: The title of the task. + executionStatus: + $ref: "#/components/schemas/TaskExecutionStatus" + description: The current execution status of the task. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the task was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the task was last updated, in UTC format. + required: + - taskId + ListThreatModelJobsOutput: + description: Output for the ListThreatModelJobs operation. + type: object + properties: + threatModelJobSummaries: + $ref: "#/components/schemas/ThreatModelJobSummaryList" + description: The list of threat model job summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for paginating results that are returned in the response. + ThreatModelJobSummaryList: + description: List of threat model job summaries. + type: array + items: + $ref: "#/components/schemas/ThreatModelJobSummary" + ThreatModelJobSummary: + description: Contains summary information about a threat model job. + type: object + properties: + threatModelJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job. + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model associated with the job. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space. + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model job. + status: + $ref: "#/components/schemas/JobStatus" + description: The current status of the threat model job. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model job was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model job was last updated, in UTC format. + required: + - threatModelJobId + - threatModelId + ListThreatModelsOutput: + description: Output for the ListThreatModels operation. + type: object + properties: + threatModelSummaries: + $ref: "#/components/schemas/ThreatModelSummaryList" + description: The list of threat model summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for paginating results that are returned in the response. + ThreatModelSummaryList: + description: List of threat model summaries. + type: array + items: + $ref: "#/components/schemas/ThreatModelSummary" + ThreatModelSummary: + description: Contains summary information about a threat model. + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space that contains the threat model. + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was last updated, in UTC format. + required: + - threatModelId + - agentSpaceId + - title_ + ListThreatsOutput: + description: Output for the ListThreats operation. + type: object + properties: + threats: + $ref: "#/components/schemas/ThreatSummaryList" + description: The list of threat summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: A token to use for paginating results that are returned in the response. + ThreatSummaryList: + description: List of threat summaries. + type: array + items: + $ref: "#/components/schemas/ThreatSummary" + ThreatSummary: + description: Contains summary information about a threat. + type: object + properties: + threatId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat. + threatJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job that produced the threat. + title_: + $ref: "#/components/schemas/String" + description: A short title summarizing the threat. + statement: + $ref: "#/components/schemas/String" + description: The natural-language threat statement. + severity: + $ref: "#/components/schemas/ThreatSeverity" + description: The severity level of the threat. + status: + $ref: "#/components/schemas/ThreatStatus" + description: The current status of the threat. + stride: + $ref: "#/components/schemas/StrideCategoryList" + description: The STRIDE categories applicable to this threat. + createdBy: + $ref: "#/components/schemas/ThreatActor" + description: Who created this threat. + updatedBy: + $ref: "#/components/schemas/ThreatActor" + description: Who last updated this threat. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was last updated, in UTC format. StartCodeRemediationOutput: description: Output for the StartCodeRemediation operation. type: object + DiffSource: + description: Source of the diff for a differential code scan. + type: object + properties: + s3Uri: + $ref: "#/components/schemas/String" + description: S3 URI pointing to a unified diff file. The file must be in standard unified diff format and stored in an S3 bucket connected to your Agent Space. StartCodeReviewJobOutput: description: Output for the StartCodeReviewJob operation. type: object @@ -4228,31 +6979,61 @@ components: properties: title_: $ref: "#/components/schemas/String" - description: The title of the pentest job. + description: The title of the pentest job. + status: + $ref: "#/components/schemas/JobStatus" + description: The current status of the pentest job. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the pentest job was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the pentest job was last updated, in UTC format. + pentestId: + $ref: "#/components/schemas/String" + description: The unique identifier of the pentest. + pentestJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the started pentest job. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space. + StartThreatModelJobOutput: + description: Output for the StartThreatModelJob operation. + type: object + properties: + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model job. status: $ref: "#/components/schemas/JobStatus" - description: The current status of the pentest job. + description: The current status of the threat model job. createdAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the pentest job was created, in UTC format. + description: The date and time the threat model job was created, in UTC format. updatedAt: $ref: "#/components/schemas/SyntheticTimestamp_date_time" - description: The date and time the pentest job was last updated, in UTC format. - pentestId: + description: The date and time the threat model job was last updated, in UTC format. + threatModelId: $ref: "#/components/schemas/String" - description: The unique identifier of the pentest. - pentestJobId: + description: The unique identifier of the threat model. + threatModelJobId: $ref: "#/components/schemas/String" - description: The unique identifier of the started pentest job. + description: The unique identifier of the started threat model job. agentSpaceId: $ref: "#/components/schemas/String" description: The unique identifier of the agent space. + required: + - threatModelJobId StopCodeReviewJobOutput: description: Output for the StopCodeReviewJob operation. type: object StopPentestJobOutput: description: Output for the StopPentestJob operation. type: object + StopThreatModelJobOutput: + description: Output for the StopThreatModelJob operation. + type: object TagResourceOutput: description: Output for TagResource operation. type: object @@ -4337,6 +7118,12 @@ components: codeRemediationStrategy: $ref: "#/components/schemas/CodeRemediationStrategy" description: The code remediation strategy for the code review. + validationMode: + $ref: "#/components/schemas/ValidationMode" + description: The validation mode for the code review. + maxTaskHours: + $ref: "#/components/schemas/Double" + description: The maximum number of billable task hours configured for jobs started from this code review. Null if no budget cap is set. required: - codeReviewId UpdateFindingOutput: @@ -4366,6 +7153,12 @@ components: githubRepository: $ref: "#/components/schemas/GitHubRepositoryResource" description: The GitHub repository resource information. + gitlabRepository: + $ref: "#/components/schemas/GitLabRepositoryResource" + bitbucketRepository: + $ref: "#/components/schemas/BitbucketRepositoryResource" + confluenceDocument: + $ref: "#/components/schemas/ConfluenceDocumentResource" GitHubRepositoryResource: description: Represents a GitHub repository resource used in an integration. type: object @@ -4379,6 +7172,52 @@ components: required: - name - owner + GitLabRepositoryResource: + description: A GitLab repository integrated as a resource. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + namespace: + $ref: "#/components/schemas/GitLabNamespace" + description: The namespace (group or user path) that owns the project. + required: + - name + - namespace + BitbucketRepositoryResource: + description: A Bitbucket repository integrated as a resource. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + workspace: + $ref: "#/components/schemas/BitbucketWorkspace" + description: The workspace slug that owns the repository. + required: + - name + - workspace + ConfluenceDocumentResource: + description: A Confluence document (page) integrated as a resource. + type: object + properties: + name: + $ref: "#/components/schemas/ProviderResourceName" + spaceKey: + $ref: "#/components/schemas/String" + description: The Confluence space key containing the document. + pageId: + $ref: "#/components/schemas/String" + description: The Confluence page identifier. + title_: + $ref: "#/components/schemas/String" + description: The display title of the Confluence page. + spaceTitle: + $ref: "#/components/schemas/String" + description: The display title of the Confluence space. + required: + - name + - spaceKey + - pageId UpdateIntegratedResourcesOutput: type: object UpdatePentestOutput: @@ -4412,6 +7251,64 @@ components: agentSpaceId: $ref: "#/components/schemas/String" description: The unique identifier of the agent space that contains the pentest. + UpdatePrivateConnectionCertificateOutput: + type: object + properties: + name: + $ref: "#/components/schemas/PrivateConnectionName" + description: The name of the private connection. + type_: + $ref: "#/components/schemas/PrivateConnectionType" + description: The type of the private connection, indicating whether it is service-managed or self-managed. + status: + $ref: "#/components/schemas/PrivateConnectionStatus" + description: The current status of the private connection. + resourceGatewayId: + $ref: "#/components/schemas/ResourceGatewayId" + description: The identifier or ARN of the VPC Lattice resource gateway. + hostAddress: + $ref: "#/components/schemas/HostAddress" + description: The IP address or DNS name of the target resource. + vpcId: + $ref: "#/components/schemas/PrivateConnectionVpcId" + description: The identifier of the VPC the resource gateway is created in. + resourceConfigurationId: + $ref: "#/components/schemas/ResourceConfigurationId" + description: The identifier or ARN of the VPC Lattice resource configuration. + certificateExpiryTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the connection's certificate expires, in UTC format. + dnsResolution: + $ref: "#/components/schemas/ResourceConfigDnsResolution" + description: The DNS resolution mode for the resource gateway. + failureMessage: + $ref: "#/components/schemas/String" + description: A message describing why the private connection entered a failed state, if applicable. + tags: + type: object + properties: {} + description: The tags attached to the private connection. + required: + - name + - type_ + - status + UpdateSecurityRequirementPackOutput: + type: object + properties: + packId: + $ref: "#/components/schemas/SecurityRequirementPackId" + description: The unique identifier of the security requirement pack. + name: + $ref: "#/components/schemas/SecurityRequirementPackName" + description: The name of the security requirement pack. + description: + $ref: "#/components/schemas/String" + description: The description of the security requirement pack. + status: + $ref: "#/components/schemas/SecurityRequirementPackStatus" + description: The status of the security requirement pack. + required: + - packId UpdateTargetDomainOutput: description: Output for the UpdateTargetDomain operation. type: object @@ -4441,6 +7338,112 @@ components: - targetDomainId - domainName - verificationStatus + UpdateThreatOutput: + description: Output for the UpdateThreat operation. + type: object + properties: + threatId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat. + threatJobId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model job the threat belongs to. + title_: + $ref: "#/components/schemas/String" + description: A short title summarizing the threat. + statement: + $ref: "#/components/schemas/String" + description: The natural-language threat statement. + severity: + $ref: "#/components/schemas/ThreatSeverity" + description: The severity level of the threat. + status: + $ref: "#/components/schemas/ThreatStatus" + description: The current status of the threat. + comments: + $ref: "#/components/schemas/String" + description: Optional customer comment on the threat. + stride: + $ref: "#/components/schemas/StrideCategoryList" + description: The STRIDE categories applicable to this threat. + threatSource: + $ref: "#/components/schemas/String" + description: The actor or origin of the threat. + prerequisites: + $ref: "#/components/schemas/String" + description: The conditions required for the threat to be exploitable. + threatAction: + $ref: "#/components/schemas/String" + description: What the threat source can do. + threatImpact: + $ref: "#/components/schemas/String" + description: The direct consequence of the threat action. + impactedGoal: + $ref: "#/components/schemas/StringList" + description: The security goals affected by the threat. + impactedAssets: + $ref: "#/components/schemas/StringList" + description: The specific assets affected by the threat. + anchor: + $ref: "#/components/schemas/ThreatAnchorShape" + description: The DFD element this threat is anchored to. + evidence: + $ref: "#/components/schemas/ThreatEvidenceList" + description: The source code files supporting the threat. + recommendation: + $ref: "#/components/schemas/String" + description: The recommended mitigation guidance for this threat. + createdBy: + $ref: "#/components/schemas/ThreatActor" + description: Who created this threat. + updatedBy: + $ref: "#/components/schemas/ThreatActor" + description: Who last updated this threat. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat was last updated, in UTC format. + required: + - threatId + - threatJobId + UpdateThreatModelOutput: + description: Output for the UpdateThreatModel operation. + type: object + properties: + threatModelId: + $ref: "#/components/schemas/String" + description: The unique identifier of the threat model. + title_: + $ref: "#/components/schemas/String" + description: The title of the threat model. + agentSpaceId: + $ref: "#/components/schemas/String" + description: The unique identifier of the agent space that contains the threat model. + description: + $ref: "#/components/schemas/String" + description: A description of the application or system being threat modeled. + assets: + $ref: "#/components/schemas/Assets" + description: The assets included in the threat model. + scopeDocs: + $ref: "#/components/schemas/DocumentList" + description: The scoped documents for the agent to focus on during threat modeling. + serviceRole: + $ref: "#/components/schemas/ServiceRole" + description: The IAM service role used for the threat model. + logConfig: + $ref: "#/components/schemas/CloudWatchLog" + description: The CloudWatch Logs configuration for the threat model. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was created, in UTC format. + updatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The date and time the threat model was last updated, in UTC format. + required: + - threatModelId VerifyTargetDomainOutput: description: Output for verifying ownership for a registered target domain in an agent space. type: object @@ -4533,6 +7536,92 @@ components: - $ref: "#/components/x-stackQL-resources/artifacts/methods/add_artifact" delete: - $ref: "#/components/x-stackQL-resources/artifacts/methods/delete_artifact" + security_requirements: + id: aws.securityagent.security_requirements + name: security_requirements + title: security_requirements + methods: + batch_create_security_requirements: + operation: + $ref: "#/paths/~1BatchCreateSecurityRequirements/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + batch_delete_security_requirements: + operation: + $ref: "#/paths/~1BatchDeleteSecurityRequirements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + batch_get_security_requirements: + operation: + $ref: "#/paths/~1BatchGetSecurityRequirements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + batch_update_security_requirements: + operation: + $ref: "#/paths/~1BatchUpdateSecurityRequirements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + import_security_requirements: + operation: + $ref: "#/paths/~1ImportSecurityRequirements/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_security_requirements: + operation: + $ref: "#/paths/~1ListSecurityRequirements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.securityRequirementSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/security_requirements/methods/batch_get_security_requirements" + - $ref: "#/components/x-stackQL-resources/security_requirements/methods/list_security_requirements" + insert: [] + update: [] + delete: [] code_reviews: id: aws.securityagent.code_reviews name: code_reviews @@ -4628,18 +7717,117 @@ components: - $ref: "#/components/x-stackQL-resources/code_reviews/methods/batch_get_code_reviews" - $ref: "#/components/x-stackQL-resources/code_reviews/methods/list_code_reviews" insert: - - $ref: "#/components/x-stackQL-resources/code_reviews/methods/create_code_review" + - $ref: "#/components/x-stackQL-resources/code_reviews/methods/create_code_review" + update: + - $ref: "#/components/x-stackQL-resources/code_reviews/methods/update_code_review" + delete: [] + pentests: + id: aws.securityagent.pentests + name: pentests + title: pentests + methods: + batch_delete_pentests: + operation: + $ref: "#/paths/~1BatchDeletePentests/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + batch_get_pentests: + operation: + $ref: "#/paths/~1BatchGetPentests/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_pentest: + operation: + $ref: "#/paths/~1CreatePentest/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_pentests: + operation: + $ref: "#/paths/~1ListPentests/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.pentestSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + start_pentest_job: + operation: + $ref: "#/paths/~1StartPentestJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + stop_pentest_job: + operation: + $ref: "#/paths/~1StopPentestJob/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_pentest: + operation: + $ref: "#/paths/~1UpdatePentest/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/pentests/methods/batch_get_pentests" + - $ref: "#/components/x-stackQL-resources/pentests/methods/list_pentests" + insert: + - $ref: "#/components/x-stackQL-resources/pentests/methods/create_pentest" update: - - $ref: "#/components/x-stackQL-resources/code_reviews/methods/update_code_review" + - $ref: "#/components/x-stackQL-resources/pentests/methods/update_pentest" delete: [] - pentests: - id: aws.securityagent.pentests - name: pentests - title: pentests + threat_models: + id: aws.securityagent.threat_models + name: threat_models + title: threat_models methods: - batch_delete_pentests: + batch_delete_threat_models: operation: - $ref: "#/paths/~1BatchDeletePentests/post" + $ref: "#/paths/~1BatchDeleteThreatModels/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4648,9 +7836,9 @@ components: config: requestBodyTranslate: algorithm: naive - batch_get_pentests: + batch_get_threat_models: operation: - $ref: "#/paths/~1BatchGetPentests/post" + $ref: "#/paths/~1BatchGetThreatModels/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4659,9 +7847,9 @@ components: config: requestBodyTranslate: algorithm: naive - create_pentest: + create_threat_model: operation: - $ref: "#/paths/~1CreatePentest/post" + $ref: "#/paths/~1CreateThreatModel/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4670,13 +7858,13 @@ components: config: requestBodyTranslate: algorithm: naive - list_pentests: + list_threat_models: operation: - $ref: "#/paths/~1ListPentests/post" + $ref: "#/paths/~1ListThreatModels/post" response: openAPIDocKey: "200" mediaType: application/json - objectKey: $.pentestSummaries + objectKey: $.threatModelSummaries request: nativeCasing: pascal config: @@ -4689,9 +7877,9 @@ components: location: body requestBodyTranslate: algorithm: naive - start_pentest_job: + start_threat_model_job: operation: - $ref: "#/paths/~1StartPentestJob/post" + $ref: "#/paths/~1StartThreatModelJob/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4700,9 +7888,9 @@ components: config: requestBodyTranslate: algorithm: naive - stop_pentest_job: + stop_threat_model_job: operation: - $ref: "#/paths/~1StopPentestJob/post" + $ref: "#/paths/~1StopThreatModelJob/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4711,9 +7899,9 @@ components: config: requestBodyTranslate: algorithm: naive - update_pentest: + update_threat_model: operation: - $ref: "#/paths/~1UpdatePentest/post" + $ref: "#/paths/~1UpdateThreatModel/post" response: openAPIDocKey: "200" mediaType: application/json @@ -4724,12 +7912,12 @@ components: algorithm: naive sqlVerbs: select: - - $ref: "#/components/x-stackQL-resources/pentests/methods/batch_get_pentests" - - $ref: "#/components/x-stackQL-resources/pentests/methods/list_pentests" + - $ref: "#/components/x-stackQL-resources/threat_models/methods/batch_get_threat_models" + - $ref: "#/components/x-stackQL-resources/threat_models/methods/list_threat_models" insert: - - $ref: "#/components/x-stackQL-resources/pentests/methods/create_pentest" + - $ref: "#/components/x-stackQL-resources/threat_models/methods/create_threat_model" update: - - $ref: "#/components/x-stackQL-resources/pentests/methods/update_pentest" + - $ref: "#/components/x-stackQL-resources/threat_models/methods/update_threat_model" delete: [] agent_spaces: id: aws.securityagent.agent_spaces @@ -5113,6 +8301,156 @@ components: - $ref: "#/components/x-stackQL-resources/target_domains/methods/update_target_domain" delete: - $ref: "#/components/x-stackQL-resources/target_domains/methods/delete_target_domain" + threat_model_job_tasks: + id: aws.securityagent.threat_model_job_tasks + name: threat_model_job_tasks + title: threat_model_job_tasks + methods: + batch_get_threat_model_job_tasks: + operation: + $ref: "#/paths/~1BatchGetThreatModelJobTasks/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_threat_model_job_tasks: + operation: + $ref: "#/paths/~1ListThreatModelJobTasks/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.threatModelJobTaskSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/threat_model_job_tasks/methods/batch_get_threat_model_job_tasks" + - $ref: "#/components/x-stackQL-resources/threat_model_job_tasks/methods/list_threat_model_job_tasks" + insert: [] + update: [] + delete: [] + threat_model_jobs: + id: aws.securityagent.threat_model_jobs + name: threat_model_jobs + title: threat_model_jobs + methods: + batch_get_threat_model_jobs: + operation: + $ref: "#/paths/~1BatchGetThreatModelJobs/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_threat_model_jobs: + operation: + $ref: "#/paths/~1ListThreatModelJobs/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.threatModelJobSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/threat_model_jobs/methods/batch_get_threat_model_jobs" + - $ref: "#/components/x-stackQL-resources/threat_model_jobs/methods/list_threat_model_jobs" + insert: [] + update: [] + delete: [] + threats: + id: aws.securityagent.threats + name: threats + title: threats + methods: + batch_get_threats: + operation: + $ref: "#/paths/~1BatchGetThreats/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + create_threat: + operation: + $ref: "#/paths/~1CreateThreat/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_threats: + operation: + $ref: "#/paths/~1ListThreats/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.threats + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_threat: + operation: + $ref: "#/paths/~1UpdateThreat/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/threats/methods/batch_get_threats" + - $ref: "#/components/x-stackQL-resources/threats/methods/list_threats" + insert: + - $ref: "#/components/x-stackQL-resources/threats/methods/create_threat" + update: + - $ref: "#/components/x-stackQL-resources/threats/methods/update_threat" + delete: [] applications: id: aws.securityagent.applications name: applications @@ -5310,6 +8648,162 @@ components: update: [] delete: - $ref: "#/components/x-stackQL-resources/memberships/methods/delete_membership" + private_connections: + id: aws.securityagent.private_connections + name: private_connections + title: private_connections + methods: + create_private_connection: + operation: + $ref: "#/paths/~1CreatePrivateConnection/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_private_connection: + operation: + $ref: "#/paths/~1DeletePrivateConnection/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + describe_private_connection: + operation: + $ref: "#/paths/~1DescribePrivateConnection/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_private_connections: + operation: + $ref: "#/paths/~1ListPrivateConnections/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.privateConnections + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_private_connection_certificate: + operation: + $ref: "#/paths/~1UpdatePrivateConnectionCertificate/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/private_connections/methods/describe_private_connection" + - $ref: "#/components/x-stackQL-resources/private_connections/methods/list_private_connections" + insert: + - $ref: "#/components/x-stackQL-resources/private_connections/methods/create_private_connection" + update: + - $ref: "#/components/x-stackQL-resources/private_connections/methods/update_private_connection_certificate" + delete: + - $ref: "#/components/x-stackQL-resources/private_connections/methods/delete_private_connection" + security_requirement_packs: + id: aws.securityagent.security_requirement_packs + name: security_requirement_packs + title: security_requirement_packs + methods: + create_security_requirement_pack: + operation: + $ref: "#/paths/~1CreateSecurityRequirementPack/post" + response: + openAPIDocKey: "201" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_security_requirement_pack: + operation: + $ref: "#/paths/~1DeleteSecurityRequirementPack/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_security_requirement_pack: + operation: + $ref: "#/paths/~1GetSecurityRequirementPack/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_security_requirement_packs: + operation: + $ref: "#/paths/~1ListSecurityRequirementPacks/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.securityRequirementPackSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + update_security_requirement_pack: + operation: + $ref: "#/paths/~1UpdateSecurityRequirementPack/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/security_requirement_packs/methods/get_security_requirement_pack" + - $ref: "#/components/x-stackQL-resources/security_requirement_packs/methods/list_security_requirement_packs" + insert: + - $ref: "#/components/x-stackQL-resources/security_requirement_packs/methods/create_security_requirement_pack" + update: + - $ref: "#/components/x-stackQL-resources/security_requirement_packs/methods/update_security_requirement_pack" + delete: + - $ref: "#/components/x-stackQL-resources/security_requirement_packs/methods/delete_security_requirement_pack" code_review_jobs_for_code_reviews: id: aws.securityagent.code_review_jobs_for_code_reviews name: code_review_jobs_for_code_reviews diff --git a/providers/src/aws/v00.00.00000/services/securityhub.yaml b/providers/src/aws/v00.00.00000/services/securityhub.yaml index e54930e0..2dfe2701 100644 --- a/providers/src/aws/v00.00.00000/services/securityhub.yaml +++ b/providers/src/aws/v00.00.00000/services/securityhub.yaml @@ -584,6 +584,78 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateConfigurationPolicyResponse" + /connectors: + post: + operationId: CreateConnector + description: Creates a connector to a third-party cloud provider in Security Hub CSPM. A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Name: + $ref: "#/components/schemas/NonEmptyString" + Description: + $ref: "#/components/schemas/NonEmptyString" + Provider: + $ref: "#/components/schemas/CspmProviderConfiguration" + Tags: + $ref: "#/components/schemas/TagMap" + ClientToken: + $ref: "#/components/schemas/ClientToken" + required: + - Provider + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateConnectorResponse" + get: + operationId: ListConnectors + description: Lists the CSPM connectors and their metadata for the calling account. + parameters: + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The pagination token to request the next page of results. + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return. + - name: ProviderName + in: query + required: false + schema: + $ref: "#/components/schemas/CspmConnectorProviderName" + description: The name of the cloud provider to filter connectors by. + - name: ConnectorStatus + in: query + required: false + schema: + $ref: "#/components/schemas/CspmConnectorStatus" + description: The connectivity status to filter connectors by. + - name: EnablementStatus + in: query + required: false + schema: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status to filter connectors by. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListConnectorsResponse" /connectorsv2: post: operationId: CreateConnectorV2 @@ -645,6 +717,12 @@ paths: schema: $ref: "#/components/schemas/ConnectorStatus" description: The status for the connectorV2. + - name: EnablementStatus + in: query + required: false + schema: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status to filter connectors by. responses: "200": description: Success @@ -994,6 +1072,69 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateConfigurationPolicyResponse" + /connectors/{connector_id}: + delete: + operationId: DeleteConnector + description: Deletes a CSPM connector. When you delete a connector, Security Hub CSPM stops ingesting findings and resource data from the connected cloud provider environment. + parameters: + - name: connector_id + in: path + required: true + schema: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteConnectorResponse" + get: + operationId: GetConnector + description: Retrieves details for a CSPM connector based on the connector ID. + parameters: + - name: connector_id + in: path + required: true + schema: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetConnectorResponse" + patch: + operationId: UpdateConnector + description: Updates a CSPM connector's configuration, such as the scope or regions for the connected cloud provider. + parameters: + - name: connector_id + in: path + required: true + schema: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + Description: + $ref: "#/components/schemas/NonEmptyString" + Provider: + $ref: "#/components/schemas/CspmProviderUpdateConfiguration" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateConnectorResponse" /connectorsv2/{connector_id}: delete: operationId: DeleteConnectorV2 @@ -1375,7 +1516,7 @@ paths: $ref: "#/components/schemas/DescribeSecurityHubV2Response" delete: operationId: DisableSecurityHubV2 - description: Disable the service for the current Amazon Web Services Region or specified Amazon Web Services Region. + description: Disable the service for the current Amazon Web Services Region or specified Amazon Web Services Region. Disabling the service also disables all opt-in features that are currently enabled in that Region. parameters: [] responses: "200": @@ -1421,6 +1562,12 @@ paths: schema: $ref: "#/components/schemas/MaxResults" description: The maximum number of standards to return. + - name: Providers + in: query + required: false + schema: + $ref: "#/components/schemas/StandardsProviders" + description: A list of cloud providers to filter the standards by. For example, specify Azure to return only standards that evaluate Azure resources. responses: "200": description: Success @@ -1501,6 +1648,41 @@ paths: application/json: schema: $ref: "#/components/schemas/DisableOrganizationAdminAccountResponse" + /hubv2/feature/{feature_name}: + delete: + operationId: DisableSecurityHubFeatureV2 + description: Disables an opt-in feature for the calling account in the current Amazon Web Services Region. The operation is idempotent. If the feature is already disabled, no changes are made. You cannot disable a feature that is managed by an organization policy. + parameters: + - name: feature_name + in: path + required: true + schema: + $ref: "#/components/schemas/FeatureName" + description: The name of the feature to disable. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DisableSecurityHubFeatureV2Response" + post: + operationId: EnableSecurityHubFeatureV2 + description: Enables an opt-in feature for the calling account in the current Amazon Web Services Region. The service must be enabled before you can enable a feature. The operation is idempotent. If the feature is already enabled, no changes are made. You cannot enable a feature that is managed by an organization policy. + parameters: + - name: feature_name + in: path + required: true + schema: + $ref: "#/components/schemas/FeatureName" + description: The name of the feature to enable. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/EnableSecurityHubFeatureV2Response" /administrator/disassociate: post: operationId: DisassociateFromAdministratorAccount @@ -1743,6 +1925,8 @@ paths: $ref: "#/components/schemas/NextToken" MaxResults: $ref: "#/components/schemas/MaxResults" + Providers: + $ref: "#/components/schemas/StandardsProviders" responses: "200": description: Success @@ -2023,7 +2207,7 @@ paths: /resourcesv2/statistics: post: operationId: GetResourcesStatisticsV2 - description: Retrieves statistical information about Amazon Web Services resources and their associated security findings. You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you aggregate resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes. + description: Retrieves statistical information about Amazon Web Services resources and their associated security findings. You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you aggregate resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes. If you set GroupByField to ResourceSubCategory, ResourceInfo.AIDetails.HostResourceType, or ResourceInfo.AIDetails.CanonicalId, you must include a ResourceCategory string filter with comparison set to EQUALS and value AI/ML in the corresponding ResourceGroupByRule. parameters: [] requestBody: required: true @@ -2084,7 +2268,7 @@ paths: /resourcesv2: post: operationId: GetResourcesV2 - description: Returns a list of resources. You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes. You can use the Filters parameter to refine results based on resource attributes. You can use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then Filters refines results within that scoped data set. + description: "Returns a list of resources. You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes. You can use the Filters parameter to refine results based on resource attributes. You can use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then Filters refines results within that scoped data set. For AI/ML resources, the response includes the ResourceSubCategory field. For self-hosted AI resources and their host resources, the response also includes ResourceInfo with AI-specific details. Self-hosted AI resources use a ResourceType with the SelfHosted::AI:: prefix, such as SelfHosted::AI::Model, SelfHosted::AI::Agent, SelfHosted::AI::InferenceEndpoint, and SelfHosted::AI::ExternalEndpoint. If you filter by ResourceSubCategory, you must also include a ResourceCategory string filter with comparison set to EQUALS and value AI/ML in the same request." parameters: [] requestBody: required: false @@ -2296,6 +2480,33 @@ paths: application/json: schema: $ref: "#/components/schemas/ListFindingAggregatorsResponse" + /freetrial/statusv2/list: + post: + operationId: ListFreeTrialStatusesV2 + description: Lists the free trial status of Security Hub features. A delegated Security Hub administrator can list the status for accounts in its organization. Any other account can list the status only for itself. Free trial status remains available after a feature is disabled. + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + AccountIds: + $ref: "#/components/schemas/FreeTrialAccountIdList" + Statuses: + $ref: "#/components/schemas/FreeTrialStatusValueList" + MaxResults: + $ref: "#/components/schemas/MaxResults" + NextToken: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListFreeTrialStatusesV2Response" /invitations: get: operationId: ListInvitations @@ -2373,6 +2584,12 @@ paths: schema: $ref: "#/components/schemas/MaxResults" description: An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned. + - name: Providers + in: query + required: false + schema: + $ref: "#/components/schemas/SecurityControlsProviders" + description: A list of cloud providers to filter the security control definitions by. For example, specify Azure to return only controls that evaluate Azure resources. responses: "200": description: Success @@ -2761,6 +2978,9 @@ components: StandardsStatusReason: $ref: "#/components/schemas/StandardsStatusReason" description: The reason for the current status. + Provider: + $ref: "#/components/schemas/StandardsProvider" + description: The cloud provider whose resources the standard evaluates. For example, AWS or Azure. required: - StandardsSubscriptionArn - StandardsArn @@ -2793,7 +3013,13 @@ components: enum: - NO_AVAILABLE_CONFIGURATION_RECORDER - MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED + - NO_AVAILABLE_MULTICLOUD_CONNECTOR - INTERNAL_ERROR + StandardsProvider: + type: string + enum: + - AWS + - Azure StandardsSubscriptionRequests: type: array items: @@ -2996,6 +3222,15 @@ components: AwsAccountName: $ref: "#/components/schemas/StringFilterList" description: "The name of the Amazon Web Services account in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 20 items." + ResourceProvider: + $ref: "#/components/schemas/StringFilterList" + description: The cloud provider that the resource belongs to. Valid values are AWS and Azure. + ResourceOwnerAccountId: + $ref: "#/components/schemas/StringFilterList" + description: The unique identifier of the account that owns the resource that the finding applies to, for example, Azure Subscription Id or Amazon Web Services Account Id + ResourceOwnerOrgId: + $ref: "#/components/schemas/StringFilterList" + description: The unique identifier of the organization that owns the resource that the finding applies to, for example, Azure Tenant Id StringFilterList: type: array items: @@ -3389,6 +3624,9 @@ components: LastUpdateReason: $ref: "#/components/schemas/AlphaNumericNonEmptyString" description: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. + Provider: + $ref: "#/components/schemas/SecurityControlsProvider" + description: The cloud provider whose resources the security control evaluates. For example, AWS or Azure. required: - SecurityControlId - SecurityControlArn @@ -3417,6 +3655,11 @@ components: AlphaNumericNonEmptyString: type: string pattern: ^([^\u0000-\u007F]|[-_ a-zA-Z0-9])+$ + SecurityControlsProvider: + type: string + enum: + - AWS + - Azure UnprocessedSecurityControls: type: array items: @@ -4017,6 +4260,12 @@ components: Region: $ref: "#/components/schemas/NonEmptyString" description: "The canonical Amazon Web Services external Region name where this resource is located. Length Constraints: Minimum length of 1. Maximum length of 16." + Provider: + $ref: "#/components/schemas/CloudProviderName" + description: The cloud provider that the resource belongs to. Valid values are AWS and Azure. + Owner: + $ref: "#/components/schemas/ResourceOwner" + description: Information about the account and organization that own the resource. ResourceRole: $ref: "#/components/schemas/NonEmptyString" description: Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity, @@ -4045,6 +4294,38 @@ components: - aws - aws-cn - aws-us-gov + - aws-us-iso + - aws-us-iso-b + - AzureCloud + CloudProviderName: + type: string + enum: + - Azure + - AWS + ResourceOwner: + description: Information about the owner of a resource, including the account and organization that the resource belongs to. + type: object + properties: + Account: + $ref: "#/components/schemas/ResourceOwnerAccount" + description: Information about the account that owns the resource, for example, an Azure Subscription or Amazon Web Services Account. + Org: + $ref: "#/components/schemas/ResourceOwnerOrg" + description: Information about the organization that owns the resource, for example, an Azure Tenant. + ResourceOwnerAccount: + description: Information about the account that owns a resource, for example, an Azure Subscription or Amazon Web Services Account. + type: object + properties: + Id: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the account that owns the resource, for example, Azure Subscription Id or Amazon Web Services Account Id. + ResourceOwnerOrg: + description: Information about the organization that owns a resource, for example, an Azure Tenant. + type: object + properties: + Id: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the organization that owns the resource, for example, Azure Tenant Id. DataClassificationDetails: description: Provides details about sensitive data that was detected on a resource. type: object @@ -4542,6 +4823,9 @@ components: CodeRepository: $ref: "#/components/schemas/CodeRepositoryDetails" description: Details about an external code repository with which you can connect your Amazon Web Services resources. The connection is established through Amazon Inspector. + AzureResource: + $ref: "#/components/schemas/AzureResourceDetails" + description: Details about an Azure resource that is related to a finding. AwsAutoScalingAutoScalingGroupDetails: description: Provides details about an auto scaling group. type: object @@ -14570,6 +14854,9 @@ components: CodeSecurityIntegrationArn: $ref: "#/components/schemas/NonEmptyString" description: The Amazon Resource Name (ARN) of the code security integration associated with the repository. + AzureResourceDetails: + description: Details about an Azure resource that is related to a finding. This field is a JSON object that contains provider-specific resource details. + type: object Compliance: description: This object typically provides details about a control finding, such as applicable standards and the status of control checks. While finding providers can add custom content in Compliance object fields, they are typically used to review details of Security Hub CSPM control findings. type: object @@ -15780,6 +16067,11 @@ components: - remediation.desc - remediation.references - resources.cloud_partition + - resources.name + - resources.owner.account.uid + - resources.owner.org.uid + - resources.owner.account.name + - resources.provider - resources.region - resources.type - resources.uid @@ -16092,6 +16384,90 @@ components: ConfigurationPolicy: $ref: "#/components/schemas/Policy" description: An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls). + CspmProviderConfiguration: + description: The cloud provider configuration for creating a connector. This is a union type that currently supports Azure. + type: object + properties: + Azure: + $ref: "#/components/schemas/AzureProviderConfiguration" + description: The Azure provider configuration. + AzureProviderConfiguration: + description: The configuration for connecting to an Azure environment. + type: object + properties: + AWSConfigConnectorArn: + $ref: "#/components/schemas/NonEmptyString" + description: The ARN of the multi-cloud configuration connector used to establish the connection to Azure. + ScopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfiguration" + description: The scope configuration that defines which Azure resources are monitored. + AzureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The list of Azure regions to monitor. + required: + - AWSConfigConnectorArn + - ScopeConfiguration + - AzureRegions + AzureScopeConfiguration: + description: The scope configuration for an Azure connector, defining the tenant or subscription scope. + type: object + properties: + ScopeType: + $ref: "#/components/schemas/ScopeType" + description: The type of scope. Valid values are tenant and subscription. + ScopeValues: + $ref: "#/components/schemas/ScopeValueList" + description: The list of scope values, such as subscription IDs, when the scope type is subscription. + required: + - ScopeType + ScopeType: + description: The type of scope for an Azure connector. Valid values are TENANT (monitor all subscriptions in the tenant) and SUBSCRIPTION (monitor specific subscriptions). + type: string + enum: + - TENANT + - SUBSCRIPTION + ScopeValueList: + type: array + items: + $ref: "#/components/schemas/NonEmptyString" + AzureRegionList: + type: array + items: + $ref: "#/components/schemas/NonEmptyString" + CreateConnectorResponse: + type: object + properties: + ConnectorArn: + $ref: "#/components/schemas/NonEmptyString" + description: The Amazon Resource Name (ARN) of the connector. + ConnectorId: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector. + ConnectorStatus: + $ref: "#/components/schemas/CspmConnectorStatus" + description: The connectivity status of the connector. + EnablementStatus: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status of the connector. + required: + - ConnectorArn + - ConnectorId + CspmConnectorStatus: + description: The connectivity status of a CSPM connector. + type: string + enum: + - CONNECTED + - DEGRADED + - FAILED_TO_CONNECT + - UNKNOWN + CspmEnablementStatus: + description: The enablement status of a CSPM connector. Indicates the lifecycle state of the connector resource. + type: string + enum: + - ENABLED + - PENDING_ENABLEMENT + - PENDING_UPDATE + - PENDING_DELETION ProviderConfiguration: description: The initial configuration settings required to establish an integration between Security Hub and third-party provider. type: object @@ -16102,6 +16478,9 @@ components: ServiceNow: $ref: "#/components/schemas/ServiceNowProviderConfiguration" description: The configuration settings required to establish an integration with ServiceNow ITSM. + Azure: + $ref: "#/components/schemas/AzureProviderConfiguration" + description: The configuration settings required to establish a CSPM integration with Microsoft Azure. JiraCloudProviderConfiguration: description: The initial configuration settings required to establish an integration between Security Hub and Jira Cloud. type: object @@ -16137,6 +16516,9 @@ components: ConnectorStatus: $ref: "#/components/schemas/ConnectorStatus" description: The current status of the connectorV2. + EnablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector after creation. required: - ConnectorArn - ConnectorId @@ -16144,9 +16526,21 @@ components: type: string enum: - CONNECTED + - DEGRADED - FAILED_TO_CONNECT - - PENDING_CONFIGURATION - PENDING_AUTHORIZATION + - PENDING_CONFIGURATION + - UNKNOWN + EnablementStatus: + type: string + enum: + - ENABLED + - PENDING_ENABLEMENT + - FAILED_TO_ENABLE + - PENDING_UPDATE + - FAILED_TO_UPDATE + - PENDING_DELETION + - FAILED_TO_DELETE CreateFindingAggregatorResponse: type: object properties: @@ -16478,6 +16872,15 @@ components: ResourceApplicationArn: $ref: "#/components/schemas/StringFilterList" description: The ARN of the application that is related to a finding. + ResourceOwnerAccountId: + $ref: "#/components/schemas/StringFilterList" + description: The unique identifier of the account that owns the resource that the finding applies to, for example, Azure Subscription Id or Amazon Web Services Account Id + ResourceOwnerOrgId: + $ref: "#/components/schemas/StringFilterList" + description: The unique identifier of the organization that owns the resource that the finding applies to, for example, Azure Tenant Id + ResourceProvider: + $ref: "#/components/schemas/StringFilterList" + description: The cloud provider that the resource belongs to. Valid values are AWS and Azure. IpFilterList: type: array items: @@ -16583,8 +16986,18 @@ components: type: object DeleteConfigurationPolicyResponse: type: object + DeleteConnectorResponse: + type: object + properties: + EnablementStatus: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status of the connector after the delete request. DeleteConnectorV2Response: type: object + properties: + EnablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector after deletion. DeleteFindingAggregatorResponse: type: object DeleteInsightResponse: @@ -16835,8 +17248,18 @@ components: $ref: "#/components/schemas/NonEmptyString" description: The ARN of the service resource. SubscribedAt: - $ref: "#/components/schemas/NonEmptyString" + $ref: "#/components/schemas/IsoString" description: The date and time when the service was enabled in the account. + Features: + type: object + properties: {} + description: A map of opt-in features and their current status and metadata for the account in the current Region. + IsoString: + type: string + StandardsProviders: + type: array + items: + $ref: "#/components/schemas/StandardsProvider" DescribeStandardsResponse: type: object properties: @@ -16866,6 +17289,9 @@ components: EnabledByDefault: $ref: "#/components/schemas/Boolean" description: Whether the standard is enabled by default. When Security Hub CSPM is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default. When Security Hub CSPM is enabled using the EnableSecurityHub API operation, the standard is enabled by default unless EnableDefaultStandards is set to false. + Provider: + $ref: "#/components/schemas/StandardsProvider" + description: The cloud provider whose resources the standard evaluates. For example, AWS or Azure. StandardsManagedBy: $ref: "#/components/schemas/StandardsManagedBy" description: Provides details about the management of a standard. @@ -16937,6 +17363,13 @@ components: type: object DisableSecurityHubResponse: type: object + FeatureName: + description: "The name of an opt-in feature. Valid values: NETWORK_SCANNING." + type: string + enum: + - NETWORK_SCANNING + DisableSecurityHubFeatureV2Response: + type: object DisableSecurityHubV2Response: type: object DisassociateFromAdministratorAccountResponse: @@ -16962,6 +17395,8 @@ components: description: The feature where the delegated administrator is enabled. The default is Security Hub CSPM CSPM if no delegated administrator is specified in the request. EnableSecurityHubResponse: type: object + EnableSecurityHubFeatureV2Response: + type: object EnableSecurityHubV2Response: type: object properties: @@ -17087,6 +17522,117 @@ components: AssociationStatusMessage: $ref: "#/components/schemas/NonEmptyString" description: The explanation for a FAILED value for AssociationStatus. + GetConnectorResponse: + type: object + properties: + ConnectorArn: + $ref: "#/components/schemas/NonEmptyString" + description: The Amazon Resource Name (ARN) of the connector. + ConnectorId: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector. + Name: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the connector. + Description: + $ref: "#/components/schemas/NonEmptyString" + description: The description of the connector. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The ISO 8601 UTC timestamp indicating when the connector was created. + LastUpdatedAt: + $ref: "#/components/schemas/Timestamp" + description: The ISO 8601 UTC timestamp indicating when the connector was last updated. + Health: + $ref: "#/components/schemas/CspmHealthCheck" + description: The health status of the connector, including connectivity status and last check time. + ProviderDetail: + $ref: "#/components/schemas/CspmProviderDetail" + description: The cloud provider configuration details for the connector. + CreatedBy: + $ref: "#/components/schemas/NonEmptyString" + description: The service principal that created the connector. + EnablementStatus: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status of the connector. + required: + - ConnectorId + - Name + - CreatedAt + - LastUpdatedAt + - Health + - ProviderDetail + CspmHealthCheck: + description: Information about the operational status and health of a CSPM connector. + type: object + properties: + ConnectorStatus: + $ref: "#/components/schemas/CspmConnectorStatus" + description: The connectivity status of the connector. + Message: + $ref: "#/components/schemas/NonEmptyString" + description: A message describing the reason for the current connector status. + LastCheckedAt: + $ref: "#/components/schemas/Timestamp" + description: The ISO 8601 UTC timestamp indicating when the health status was last checked. + Issues: + $ref: "#/components/schemas/HealthIssueList" + description: A list of health issues associated with the connector. + required: + - ConnectorStatus + - LastCheckedAt + HealthIssueList: + type: array + items: + $ref: "#/components/schemas/HealthIssue" + HealthIssue: + description: Represents a specific health issue detected for a connector. + type: object + properties: + Code: + $ref: "#/components/schemas/HealthIssueCode" + description: The error code that identifies the type of health issue. + Message: + $ref: "#/components/schemas/NonEmptyString" + description: A human-readable message that describes the health issue. + required: + - Code + - Message + HealthIssueCode: + description: The error code for a connector health issue. + type: string + enum: + - AUTHENTICATION_FAILURE + - STREAM_AUTHORIZATION_FAILURE + - DISCOVERY_FAILURE + - STREAM_LIMIT_EXCEEDED + - STREAM_DISCONNECTED + - RECORDING_FAILURE + - NO_HEALTH_DATA + CspmProviderDetail: + description: The detailed cloud provider configuration for a connector. This is a union type that currently supports Azure. + type: object + properties: + Azure: + $ref: "#/components/schemas/AzureDetail" + description: The Azure provider detail. + AzureDetail: + description: The detailed Azure configuration for a connector. + type: object + properties: + AWSConfigConnectorArn: + $ref: "#/components/schemas/NonEmptyString" + description: The ARN of the multi-cloud configuration connector used to establish the connection to Azure. + ScopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfiguration" + description: The scope configuration that defines which Azure resources are monitored. + AzureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The list of Azure regions being monitored. + required: + - AWSConfigConnectorArn + - ScopeConfiguration + - AzureRegions GetConnectorV2Response: type: object properties: @@ -17117,6 +17663,12 @@ components: ProviderDetail: $ref: "#/components/schemas/ProviderDetail" description: The third-party provider detail for a service configuration. + EnablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector. + EnablementStatusReason: + $ref: "#/components/schemas/NonEmptyString" + description: The reason for the current enablement status. Provides additional context when the connector is in a failed state. required: - ConnectorId - Name @@ -17137,6 +17689,9 @@ components: LastCheckedAt: $ref: "#/components/schemas/Timestamp" description: ISO 8601 UTC timestamp for the time check the health status of the connectorV2. + Issues: + $ref: "#/components/schemas/HealthIssueList" + description: A list of health issues associated with the connector, including error codes and messages. required: - ConnectorStatus - LastCheckedAt @@ -17150,6 +17705,9 @@ components: ServiceNow: $ref: "#/components/schemas/ServiceNowDetail" description: Details about a ServiceNow ITSM integration. + Azure: + $ref: "#/components/schemas/AzureDetail" + description: Details about a Microsoft Azure CSPM integration. JiraCloudDetail: description: Information about the configuration and status of a Jira Cloud integration. type: object @@ -17312,6 +17870,13 @@ components: - metadata.product.name - metadata.product.uid - resources.type + - resources.cloud_partition + - resources.name + - resources.owner.account.uid + - resources.owner.org.uid + - resources.owner.account.name + - resources.provider + - resources.region - resources.uid - severity - status @@ -17454,7 +18019,7 @@ components: properties: FieldName: $ref: "#/components/schemas/FindingsTrendsStringField" - description: The name of the findings field to filter on. + description: The name of the findings field to filter on. You can specify one of the following fields. account_id – The Amazon Web Services account ID associated with the finding. region – The Amazon Web Services Region associated with the finding. finding_types – The finding types associated with the finding. finding_status – The status of the finding. finding_cve_ids – The Common Vulnerabilities and Exposures (CVE) identifiers associated with the finding. finding_compliance_status – The compliance status of the finding. finding_control_id – The identifier of the security control associated with the finding. finding_class_name – The finding class, such as Compliance Finding. finding_provider – The name of the product that generated the finding. finding_activity_name – The activity name associated with the finding. resource_cloud_providers – The cloud providers of the resources that the finding is associated with. Valid values are AWS and Azure. resource_regions – The Regions of the associated resources. For an Amazon Web Services resource, this is the Amazon Web Services Region. For an Azure resource, this is the Azure Region, such as eastus. resource_owner_ids – The identifiers of the accounts that own the associated resources. For an Amazon Web Services resource, this is the Amazon Web Services account ID. For an Azure resource, this is the Azure subscription ID. resource_owner_organization_ids – The identifiers of the organizations that own the associated resources. For an Amazon Web Services resource, this is the Amazon Web Services organization ID. For an Azure resource, this is the Azure tenant ID. Filter: $ref: "#/components/schemas/StringFilter" FindingsTrendsStringField: @@ -17470,6 +18035,10 @@ components: - finding_class_name - finding_provider - finding_activity_name + - resource_cloud_providers + - resource_regions + - resource_owner_ids + - resource_owner_organization_ids GetFindingsTrendsV2Response: type: object properties: @@ -17790,11 +18359,21 @@ components: type: string enum: - AccountId + - AccountName - Region + - ResourceProvider + - ResourceOwnerAccountId + - ResourceOwnerOrgId + - ResourceCloudPartition + - ResourceRegion - ResourceCategory - ResourceType - ResourceName - FindingsSummary.FindingType + - ResourceSubCategory + - DiscoveryType + - ResourceInfo.AIDetails.HostResourceType + - ResourceInfo.AIDetails.CanonicalId ResourcesFilters: description: Enables filtering of Amazon Web Services resources based on data. type: object @@ -17850,12 +18429,23 @@ components: - ResourceGuid - ResourceId - AccountId + - AccountName - Region + - ResourceProvider + - ResourceOwnerAccountId + - ResourceOwnerOrgId + - ResourceCloudPartition + - ResourceRegion - ResourceCategory - ResourceType - ResourceName - FindingsSummary.FindingType - FindingsSummary.ProductName + - ResourceSubCategory + - DiscoveryType + - ResourceInfo.AIDetails.HostResourceGuid + - ResourceInfo.AIDetails.HostResourceType + - ResourceInfo.AIDetails.CanonicalId ResourcesDateFilterList: type: array items: @@ -17899,6 +18489,14 @@ components: - FindingsSummary.Severities.Low - FindingsSummary.Severities.Informational - FindingsSummary.Severities.Unknown + - ResourceInfo.AIDetails.SelfHostedAIModelResourceCount + - ResourceInfo.AIDetails.SelfHostedAIAgentResourceCount + - ResourceInfo.AIDetails.SelfHostedAIModelServingResourceCount + - ResourceInfo.AIDetails.SelfHostedAIExternalEndpointResourceCount + - ResourceInfo.AIDetails.SelfHostedAIDevelopmentResourceCount + - ResourceInfo.AIDetails.SelfHostedAIAgentFrameworkResourceCount + - ResourceInfo.AIDetails.SelfHostedAIAgentToolsAndIdentityResourceCount + - ResourceInfo.AIDetails.SelfHostedTotalAIResourceCount ResourcesMapFilterList: type: array items: @@ -17968,7 +18566,7 @@ components: properties: FieldName: $ref: "#/components/schemas/ResourcesTrendsStringField" - description: The name of the resources field to filter on, such as resourceType, accountId, or region. + description: The name of the resources field to filter on. You can specify one of the following fields. account_id – The Amazon Web Services account ID that owns the resource. region – The Amazon Web Services Region of the resource. resource_type – The type of the resource. resource_category – The category of the resource. resource_cloud_provider – The cloud provider of the resource. Valid values are AWS and Azure. resource_region – The Region of the resource. For an Amazon Web Services resource, this is the Amazon Web Services Region. For an Azure resource, this is the Azure Region, such as eastus. resource_owner_id – The identifier of the account that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services account ID. For an Azure resource, this is the Azure subscription ID. resource_owner_organization_id – The identifier of the organization that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services organization ID. For an Azure resource, this is the Azure tenant ID. Filter: $ref: "#/components/schemas/StringFilter" ResourcesTrendsStringField: @@ -17978,6 +18576,10 @@ components: - region - resource_type - resource_category + - resource_cloud_provider + - resource_region + - resource_owner_id + - resource_owner_organization_id GetResourcesTrendsV2Response: type: object properties: @@ -18055,10 +18657,28 @@ components: description: The unique identifier for a resource. AccountId: $ref: "#/components/schemas/NonEmptyString" - description: The Amazon Web Services account that owns the resource. + description: The Amazon Web Services account that recorded the resource data in Security Hub. + AccountName: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the Amazon Web Services account that's associated with the resource. Region: $ref: "#/components/schemas/NonEmptyString" - description: The Amazon Web Services Region where the resource is located. + description: The Amazon Web Services Region that recorded the resource data in Security Hub. + ResourceProvider: + $ref: "#/components/schemas/NonEmptyString" + description: The cloud provider where the resource exists. Valid values are AWS and Azure. This field is always included. + ResourceOwnerAccountId: + $ref: "#/components/schemas/NonEmptyString" + description: The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID. + ResourceOwnerOrgId: + $ref: "#/components/schemas/NonEmptyString" + description: The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID. + ResourceCloudPartition: + $ref: "#/components/schemas/NonEmptyString" + description: The cloud partition where the resource exists. For Amazon Web Services, valid values include aws, aws-cn, and aws-us-gov. This field isn't returned for cloud providers that don't use partitions. + ResourceRegion: + $ref: "#/components/schemas/NonEmptyString" + description: The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included. ResourceCategory: $ref: "#/components/schemas/ResourceCategory" description: The grouping where the resource belongs. @@ -18083,10 +18703,20 @@ components: ResourceConfig: $ref: "#/components/schemas/ResourceConfig" description: The configuration details of a resource. + ResourceSubCategory: + $ref: "#/components/schemas/ResourceSubCategory" + description: The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML. + DiscoveryType: + $ref: "#/components/schemas/DiscoveryType" + description: Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image. + ResourceInfo: + $ref: "#/components/schemas/ResourceInfo" + description: Additional resource-type-specific details. For self-hosted AI resources and their host resources, contains an AIDetails structure. required: - ResourceId - AccountId - Region + - ResourceType - ResourceDetailCaptureTimeDt - ResourceConfig ResourceCategory: @@ -18099,6 +18729,7 @@ components: - AI/ML - Identity - Network + - Messaging - Other ResourceFindingsSummaryList: type: array @@ -18171,6 +18802,69 @@ components: - Value ResourceConfig: type: object + ResourceSubCategory: + type: string + enum: + - Model + - ModelServing + - Agent + - AgentFramework + - AgentToolsAndIdentity + - SafetyAndGuardrail + - KnowledgeAndData + - OrchestrationAndPipeline + - ExternalEndpoint + - Development + - Other + DiscoveryType: + type: string + enum: + - Managed + - SelfHosted + ResourceInfo: + description: Additional details about a resource that are specific to its category. For AI/ML resources and their host resources, this structure contains AIDetails. + type: object + properties: + AIDetails: + $ref: "#/components/schemas/AIDetails" + description: Details that are specific to self-hosted AI resources and their host resources. + AIDetails: + description: "Contains information about self-hosted AI resources and their host resources. The fields that are present depend on the role of the resource. On a self-hosted AI resource (a resource with a SelfHosted::AI:: resource type, such as SelfHosted::AI::Model or SelfHosted::AI::Agent), the HostResourceGuid and HostResourceType fields link the resource to its host. The CanonicalId field identifies what the resource is, enabling aggregation of identical resources across multiple hosts. On a host resource (such as an Amazon EC2 instance), the SelfHostedAI*ResourceCount fields contain the count for each ResourceSubCategory and the total count of self-hosted AI resources detected on the host." + type: object + properties: + HostResourceGuid: + $ref: "#/components/schemas/NonEmptyString" + description: The identifier of the host resource that hosts the self-hosted AI resource. Present only on self-hosted AI resources. + HostResourceType: + $ref: "#/components/schemas/NonEmptyString" + description: The ResourceType of the host resource that hosts the self-hosted AI resource, such as AWS::EC2::Instance. Present only on self-hosted AI resources. + CanonicalId: + $ref: "#/components/schemas/NonEmptyString" + description: The canonical identifier for the AI resource, independent of where it is deployed. Multiple occurrences of the same resource on different hosts share the same CanonicalId. For model resources, the value follows the format model/``, such as model/pkg:huggingface/meta-llama/llama-3-8b. Present only on self-hosted AI resources. + SelfHostedAIModelResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory Model detected on the host resource. Present only on host resources. + SelfHostedAIAgentResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory Agent detected on the host resource. Present only on host resources. + SelfHostedAIModelServingResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory ModelServing detected on the host resource. Present only on host resources. + SelfHostedAIExternalEndpointResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory ExternalEndpoint detected on the host resource. Present only on host resources. + SelfHostedAIDevelopmentResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory Development detected on the host resource. Present only on host resources. + SelfHostedAIAgentFrameworkResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory AgentFramework detected on the host resource. Present only on host resources. + SelfHostedAIAgentToolsAndIdentityResourceCount: + $ref: "#/components/schemas/Integer" + description: The number of self-hosted AI resources of ResourceSubCategory AgentToolsAndIdentity detected on the host resource. Present only on host resources. + SelfHostedTotalAIResourceCount: + $ref: "#/components/schemas/Integer" + description: The total number of all self-hosted AI resources detected on the host resource. Present only on host resources. GetSecurityControlDefinitionResponse: type: object properties: @@ -18207,6 +18901,9 @@ components: type: object properties: {} description: An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters. + Provider: + $ref: "#/components/schemas/SecurityControlsProvider" + description: The cloud provider whose resources the security control evaluates. For example, AWS or Azure. required: - SecurityControlId - Title @@ -18413,11 +19110,73 @@ components: type: array items: $ref: "#/components/schemas/ConfigurationPolicyAssociationSummary" + CspmConnectorProviderName: + description: The name of the cloud provider for a CSPM connector. + type: string + enum: + - AZURE + ListConnectorsResponse: + type: object + properties: + NextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use to request the next page of results. If there are no additional results, this value is null. + Connectors: + $ref: "#/components/schemas/CspmConnectorSummaryList" + description: An array of connector summaries. + required: + - Connectors + CspmConnectorSummaryList: + type: array + items: + $ref: "#/components/schemas/CspmConnectorSummary" + CspmConnectorSummary: + description: A summary of a CSPM connector. + type: object + properties: + ConnectorArn: + $ref: "#/components/schemas/NonEmptyString" + description: The Amazon Resource Name (ARN) of the connector. + ConnectorId: + $ref: "#/components/schemas/NonEmptyString" + description: The unique identifier of the connector. + Name: + $ref: "#/components/schemas/NonEmptyString" + description: The name of the connector. + Description: + $ref: "#/components/schemas/NonEmptyString" + description: The description of the connector. + ProviderSummary: + $ref: "#/components/schemas/CspmProviderSummary" + description: A summary of the cloud provider configuration for the connector. + CreatedAt: + $ref: "#/components/schemas/Timestamp" + description: The ISO 8601 UTC timestamp indicating when the connector was created. + CreatedBy: + $ref: "#/components/schemas/NonEmptyString" + description: The service principal that created the connector. + EnablementStatus: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status of the connector. + CspmProviderSummary: + description: A summary of the cloud provider configuration for a connector. + type: object + properties: + ProviderName: + $ref: "#/components/schemas/CspmConnectorProviderName" + description: The name of the cloud provider. + ConnectorStatus: + $ref: "#/components/schemas/CspmConnectorStatus" + description: The connectivity status of the connector. + ProviderConfiguration: + $ref: "#/components/schemas/CspmProviderDetail" + description: The provider configuration details. ConnectorProviderName: type: string enum: - JIRA_CLOUD - SERVICENOW + - AZURE ListConnectorsV2Response: type: object properties: @@ -18455,6 +19214,12 @@ components: CreatedAt: $ref: "#/components/schemas/Timestamp" description: ISO 8601 UTC timestamp for the time create the connectorV2. + EnablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector. + EnablementStatusReason: + $ref: "#/components/schemas/NonEmptyString" + description: The reason for the current enablement status. Provides additional context when the connector is in a failed state. required: - ConnectorId - Name @@ -18470,6 +19235,8 @@ components: ConnectorStatus: $ref: "#/components/schemas/ConnectorStatus" description: The status for the connectorV2. + ProviderConfiguration: + $ref: "#/components/schemas/ProviderDetail" ListEnabledProductsForImportRowDisplay: type: object properties: @@ -18503,6 +19270,84 @@ components: FindingAggregatorArn: $ref: "#/components/schemas/NonEmptyString" description: The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator. + FreeTrialAccountIdList: + type: array + items: + $ref: "#/components/schemas/FreeTrialAccountId" + FreeTrialAccountId: + type: string + pattern: ^[0-9]{12}$ + FreeTrialStatusValueList: + type: array + items: + $ref: "#/components/schemas/FreeTrialStatusValue" + FreeTrialStatusValue: + type: string + enum: + - ACTIVE + - INACTIVE + ListFreeTrialStatusesV2Response: + type: object + properties: + AccountFreeTrialStatuses: + $ref: "#/components/schemas/AccountFreeTrialStatusList" + description: An array of free trial statuses, one for each account in scope. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token to use to request the next page of results. If there are no additional results, this value is null. + required: + - AccountFreeTrialStatuses + AccountFreeTrialStatusList: + type: array + items: + $ref: "#/components/schemas/AccountFreeTrialStatus" + AccountFreeTrialStatus: + description: The free trial status of each Security Hub feature for an account. + type: object + properties: + AccountId: + $ref: "#/components/schemas/FreeTrialAccountId" + description: The Amazon Web Services account identifier that the free trial statuses apply to. + EvaluatedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time at which Security Hub evaluated the free trial statuses for this account. Every status in FreeTrialStatuses reflects this point in time. + FreeTrialStatuses: + $ref: "#/components/schemas/FreeTrialStatusList" + description: An array of free trial statuses, one for each feature that has a free trial period for the account. The array is empty if the account has no free trial to report. + required: + - AccountId + - EvaluatedAt + - FreeTrialStatuses + FreeTrialStatusList: + type: array + items: + $ref: "#/components/schemas/FreeTrialStatus" + FreeTrialStatus: + description: The free trial period for a Security Hub feature, and whether the trial is currently active. + type: object + properties: + FeatureType: + $ref: "#/components/schemas/FreeTrialType" + description: "The feature that the free trial period applies to. Valid values: SECURITY_HUB_V2 specifies Security Hub. SECURITY_HUB_V2_MULTI_CLOUD_AZURE specifies Security Hub coverage for Microsoft Azure resources." + Status: + $ref: "#/components/schemas/FreeTrialStatusValue" + description: "Whether the free trial period is currently active. Valid values: ACTIVE specifies that the free trial period is ongoing. INACTIVE specifies that the free trial period has ended, or that it never started. To determine whether a trial has expired, compare ExpiresAt to the current time." + StartedAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time at which the free trial period began. + ExpiresAt: + $ref: "#/components/schemas/Timestamp" + description: The date and time at which the free trial period ends. + required: + - FeatureType + - Status + - StartedAt + - ExpiresAt + FreeTrialType: + type: string + enum: + - SECURITY_HUB_V2 + - SECURITY_HUB_V2_MULTI_CLOUD_AZURE CrossAccountMaxResults: type: integer minimum: 1 @@ -18564,6 +19409,10 @@ components: enum: - ENABLED - DISABLE_IN_PROGRESS + SecurityControlsProviders: + type: array + items: + $ref: "#/components/schemas/SecurityControlsProvider" ListSecurityControlDefinitionsResponse: type: object properties: @@ -18733,6 +19582,35 @@ components: ConfigurationPolicy: $ref: "#/components/schemas/Policy" description: An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls). + CspmProviderUpdateConfiguration: + description: The cloud provider configuration for updating a connector. This is a union type that currently supports Azure. + type: object + properties: + Azure: + $ref: "#/components/schemas/AzureUpdateConfiguration" + description: The Azure update configuration. + AzureUpdateConfiguration: + description: The configuration for updating an Azure connector's scope and regions. + type: object + properties: + ScopeConfiguration: + $ref: "#/components/schemas/AzureScopeConfiguration" + description: The updated scope configuration. + AzureRegions: + $ref: "#/components/schemas/AzureRegionList" + description: The updated list of Azure regions to monitor. + required: + - ScopeConfiguration + - AzureRegions + UpdateConnectorResponse: + type: object + properties: + ConnectorStatus: + $ref: "#/components/schemas/CspmConnectorStatus" + description: The connectivity status of the connector after the update. + EnablementStatus: + $ref: "#/components/schemas/CspmEnablementStatus" + description: The enablement status of the connector after the update. ProviderUpdateConfiguration: description: The parameters required to update the configuration of an integration provider. type: object @@ -18743,6 +19621,9 @@ components: ServiceNow: $ref: "#/components/schemas/ServiceNowUpdateConfiguration" description: The parameters required to update the configuration for a ServiceNow integration. + Azure: + $ref: "#/components/schemas/AzureUpdateConfiguration" + description: The parameters required to update the configuration for a Microsoft Azure CSPM integration. JiraCloudUpdateConfiguration: description: The parameters used to modify an existing Jira Cloud integration. type: object @@ -18759,6 +19640,13 @@ components: description: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials. UpdateConnectorV2Response: type: object + properties: + ConnectorStatus: + $ref: "#/components/schemas/ConnectorStatus" + description: The status of the connector after the update. + EnablementStatus: + $ref: "#/components/schemas/EnablementStatus" + description: The enablement status of the connector after the update. UpdateFindingAggregatorResponse: type: object properties: @@ -19476,6 +20364,63 @@ components: - $ref: "#/components/x-stackQL-resources/configuration_policies/methods/update_configuration_policy" delete: - $ref: "#/components/x-stackQL-resources/configuration_policies/methods/delete_configuration_policy" + connectors: + id: aws.securityhub.connectors + name: connectors + title: connectors + methods: + create_connector: + operation: + $ref: "#/paths/~1connectors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_connectors: + operation: + $ref: "#/paths/~1connectors/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + delete_connector: + operation: + $ref: "#/paths/~1connectors~1{connector_id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_connector: + operation: + $ref: "#/paths/~1connectors~1{connector_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_connector: + operation: + $ref: "#/paths/~1connectors~1{connector_id}/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/connectors/methods/get_connector" + - $ref: "#/components/x-stackQL-resources/connectors/methods/list_connectors" + insert: + - $ref: "#/components/x-stackQL-resources/connectors/methods/create_connector" + update: + - $ref: "#/components/x-stackQL-resources/connectors/methods/update_connector" + delete: + - $ref: "#/components/x-stackQL-resources/connectors/methods/delete_connector" connector_v2s: id: aws.securityhub.connector_v2s name: connector_v2s @@ -20386,6 +21331,36 @@ components: insert: [] update: [] delete: [] + free_trial_statuses_v2s: + id: aws.securityhub.free_trial_statuses_v2s + name: free_trial_statuses_v2s + title: free_trial_statuses_v2s + methods: + list_free_trial_statuses_v2: + operation: + $ref: "#/paths/~1freetrial~1statusv2~1list/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.AccountFreeTrialStatuses + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/free_trial_statuses_v2s/methods/list_free_trial_statuses_v2" + insert: [] + update: [] + delete: [] organization_admin_accounts: id: aws.securityhub.organization_admin_accounts name: organization_admin_accounts diff --git a/providers/src/aws/v00.00.00000/services/sesv2.yaml b/providers/src/aws/v00.00.00000/services/sesv2.yaml index f94ca9a0..64adc11c 100644 --- a/providers/src/aws/v00.00.00000/services/sesv2.yaml +++ b/providers/src/aws/v00.00.00000/services/sesv2.yaml @@ -649,7 +649,7 @@ paths: /v2/email/multi-region-endpoints: post: operationId: CreateMultiRegionEndpoint - description: Creates a multi-region endpoint (global-endpoint). The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed. + description: Creates a multi-region endpoint (global-endpoint). The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic is divided between the two. The primary region is the region where the resource has been created and where it can be managed. parameters: [] requestBody: required: true @@ -700,7 +700,7 @@ paths: /v2/email/tenants: post: operationId: CreateTenant - description: Create a tenant. Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account. + description: Create a tenant. Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account. You can optionally specify SuppressionAttributes to configure tenant-level suppression at creation time. When tenant-level suppression is enabled, Amazon SES maintains a separate suppression list for the tenant instead of using the account-level suppression list. parameters: [] requestBody: required: true @@ -713,6 +713,8 @@ paths: $ref: "#/components/schemas/TenantName" Tags: $ref: "#/components/schemas/TagList" + SuppressionAttributes: + $ref: "#/components/schemas/TenantSuppressionAttributes" required: - TenantName responses: @@ -1152,7 +1154,7 @@ paths: $ref: "#/components/schemas/DeleteEmailTemplateResponse" get: operationId: GetEmailTemplate - description: Displays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. + description: Displays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than 50 times per second. parameters: - name: template_name in: path @@ -1233,14 +1235,20 @@ paths: /v2/email/suppression/addresses/{email_address}: delete: operationId: DeleteSuppressedDestination - description: Removes an email address from the suppression list for your account. + description: Removes an email address from the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is removed from the account-level suppression list. parameters: - name: email_address in: path required: true schema: $ref: "#/components/schemas/EmailAddress" - description: The suppressed email destination to remove from the account suppression list. + description: The suppressed email destination to remove from the suppression list for your account or for the specified tenant. + - name: TenantName + in: query + required: false + schema: + $ref: "#/components/schemas/TenantName" + description: The name of the tenant whose suppression list you want to remove the address from. If you omit this parameter, the address is removed from the account-level suppression list. responses: "200": description: Success @@ -1250,14 +1258,20 @@ paths: $ref: "#/components/schemas/DeleteSuppressedDestinationResponse" get: operationId: GetSuppressedDestination - description: Retrieves information about a specific email address that's on the suppression list for your account. + description: Retrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list. parameters: - name: email_address in: path required: true schema: $ref: "#/components/schemas/EmailAddress" - description: The email address that's on the account suppression list. + description: The email address that's on the suppression list for your account or for the specified tenant. + - name: TenantName + in: query + required: false + schema: + $ref: "#/components/schemas/TenantName" + description: The name of the tenant whose suppression list you want to query. If you omit this parameter, the operation targets the account-level suppression list. responses: "200": description: Success @@ -1616,7 +1630,7 @@ paths: /v2/email/tenants/get: post: operationId: GetTenant - description: Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status. + description: Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, sending status, and suppression attributes. parameters: [] requestBody: required: true @@ -1865,14 +1879,20 @@ paths: /v2/email/suppression/addresses: get: operationId: ListSuppressedDestinations - description: Retrieves a list of email addresses that are on the suppression list for your account. + description: Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list. parameters: + - name: TenantName + in: query + required: false + schema: + $ref: "#/components/schemas/TenantName" + description: The name of the tenant whose suppression list you want to retrieve. If you omit this parameter, the operation targets the account-level suppression list. - name: Reason in: query required: false schema: $ref: "#/components/schemas/SuppressionListReasons" - description: The factors that caused the email address to be added to . + description: The factors that caused the email address to be added to the suppression list for your account or for a specific tenant. - name: StartDate in: query required: false @@ -1906,7 +1926,7 @@ paths: $ref: "#/components/schemas/ListSuppressedDestinationsResponse" put: operationId: PutSuppressedDestination - description: Adds an email address to the suppression list for your account. + description: Adds an email address to the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is added to the account-level suppression list. parameters: [] requestBody: required: true @@ -1919,6 +1939,8 @@ paths: $ref: "#/components/schemas/EmailAddress" Reason: $ref: "#/components/schemas/SuppressionListReason" + TenantName: + $ref: "#/components/schemas/TenantName" required: - EmailAddress - Reason @@ -2101,6 +2123,29 @@ paths: application/json: schema: $ref: "#/components/schemas/PutAccountDetailsResponse" + /v2/email/account/pricing-attributes: + put: + operationId: PutAccountPricingAttributes + description: Set the pricing plan for your Amazon SES account. Use this operation to choose a billing plan that packages multiple Amazon SES features at a single rate. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + Plan: + $ref: "#/components/schemas/PricingPlan" + required: + - Plan + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutAccountPricingAttributesResponse" /v2/email/account/sending: put: operationId: PutAccountSendingAttributes @@ -2283,7 +2328,7 @@ paths: /v2/email/configuration-sets/{configuration_set_name}/suppression-options: put: operationId: PutConfigurationSetSuppressionOptions - description: Specify the account suppression list preferences for a configuration set. + description: Specify the suppression list preferences for a configuration set. You can also use this operation to specify a SuppressionScope to override the suppression scope of the tenant or account for emails sent using this configuration set. parameters: - name: configuration_set_name in: path @@ -2298,6 +2343,8 @@ paths: schema: type: object properties: + SuppressionScope: + $ref: "#/components/schemas/SuppressionListScope" SuppressedReasons: $ref: "#/components/schemas/SuppressionListReasons" ValidationOptions: @@ -2592,6 +2639,33 @@ paths: application/json: schema: $ref: "#/components/schemas/PutEmailIdentityMailFromAttributesResponse" + /v2/email/tenant/suppression: + post: + operationId: PutTenantSuppressionAttributes + description: Configure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons for a tenant. When you set the suppression scope to TENANT, Amazon SES maintains a separate suppression list for the tenant. When you set the scope to ACCOUNT, the tenant uses the account-level suppression list. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TenantName: + $ref: "#/components/schemas/TenantName" + SuppressedReasons: + $ref: "#/components/schemas/SuppressionListReasons" + SuppressionScope: + $ref: "#/components/schemas/SuppressionListScope" + required: + - TenantName + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutTenantSuppressionAttributesResponse" /v2/email/outbound-bulk-emails: post: operationId: SendBulkEmail @@ -3077,12 +3151,15 @@ components: TagValue: type: string SuppressionOptions: - description: An object that contains information about the suppression list preferences for your account. + description: An object that contains information about the suppression list preferences for your account or for a specific tenant. type: object properties: SuppressedReasons: $ref: "#/components/schemas/SuppressionListReasons" - description: "A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce." + description: "A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a hard bounce." + SuppressionScope: + $ref: "#/components/schemas/SuppressionListScope" + description: "The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following: TENANT – Use the tenant's suppression list. ACCOUNT – Use the account-level suppression list." ValidationOptions: $ref: "#/components/schemas/SuppressionValidationOptions" SuppressionListReasons: @@ -3090,11 +3167,17 @@ components: items: $ref: "#/components/schemas/SuppressionListReason" SuppressionListReason: - description: "The reason that the address was added to the suppression list for your account. The value can be one of the following: COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint. BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce." + description: "The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following: COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a complaint. BOUNCE – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a hard bounce." type: string enum: - BOUNCE - COMPLAINT + SuppressionListScope: + description: "The suppression scope that determines which suppression list Amazon SES uses. Can be one of the following: TENANT – Use the tenant's own suppression list. ACCOUNT – Use the account-level suppression list." + type: string + enum: + - ACCOUNT + - TENANT SuppressionValidationOptions: description: Contains validation options for email address suppression. type: object @@ -3257,19 +3340,19 @@ components: properties: DimensionName: $ref: "#/components/schemas/DimensionName" - description: "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." + description: "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 255 characters." DimensionValueSource: $ref: "#/components/schemas/DimensionValueSource" description: The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags. DefaultDimensionValue: $ref: "#/components/schemas/DefaultDimensionValue" - description: "The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.). It can contain no more than 256 characters." + description: "The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.). It can contain no more than 255 characters." required: - DimensionName - DimensionValueSource - DefaultDimensionValue DimensionName: - description: "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). It can contain no more than 256 characters." + description: "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). It can contain no more than 255 characters." type: string DimensionValueSource: description: The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags. @@ -3279,7 +3362,7 @@ components: - EMAIL_HEADER - LINK_TAG DefaultDimensionValue: - description: "The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." + description: "The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 255 characters." type: string SnsDestination: description: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur. @@ -3649,7 +3732,7 @@ components: description: "[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day." DomainSigningAttributesOrigin: $ref: "#/components/schemas/DkimSigningAttributesOrigin" - description: "The attribute to use for configuring DKIM for the identity depends on the operation: For PutEmailIdentityDkimSigningAttributes: None of the values are allowed - use the SigningAttributesOrigin parameter instead For CreateEmailIdentity when replicating a parent identity's DKIM configuration: Allowed values: All values except AWS_SES and EXTERNAL AWS_SES – Configure DKIM for the identity by using Easy DKIM. EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM). AWS_SES_AF_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_NORTH_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_3 – Configure DKIM for the identity by replicating from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_2 – Configure DKIM for the identity by replicating from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_3 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). AWS_SES_IL_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). AWS_SES_SA_EAST_1 – Configure DKIM for the identity by replicating from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in Canada (Calgary) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_3 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_5 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Malaysia) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_2 – Configure DKIM for the identity by replicating from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_1 – Configure DKIM for the identity by replicating from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_2 – Configure DKIM for the identity by replicating from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_2 – Configure DKIM for the identity by replicating from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED)." + description: "The attribute to use for configuring DKIM for the identity depends on the operation: For PutEmailIdentityDkimSigningAttributes: None of the values are allowed - use the SigningAttributesOrigin parameter instead For CreateEmailIdentity when replicating a parent identity's DKIM configuration: Allowed values: All values except AWS_SES and EXTERNAL AWS_SES – Configure DKIM for the identity by using Easy DKIM. EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM). AWS_SES_AF_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_NORTH_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_3 – Configure DKIM for the identity by replicating from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_2 – Configure DKIM for the identity by replicating from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_3 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_SOUTH_1 – Configure DKIM for the identity by replicating from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). AWS_SES_IL_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). AWS_SES_SA_EAST_1 – Configure DKIM for the identity by replicating from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in Canada (Calgary) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_1 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_2 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_3 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_5 – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Malaysia) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_1 – Configure DKIM for the identity by replicating from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_2 – Configure DKIM for the identity by replicating from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_1 – Configure DKIM for the identity by replicating from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_2 – Configure DKIM for the identity by replicating from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_2 – Configure DKIM for the identity by replicating from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_GOV_EAST_1 – Configure DKIM for the identity by replicating from a parent identity in AWS GovCloud (US-East) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_GOV_WEST_1 – Configure DKIM for the identity by replicating from a parent identity in AWS GovCloud (US-West) region using Deterministic Easy-DKIM (DEED)." Selector: type: string minLength: 1 @@ -3697,6 +3780,8 @@ components: - AWS_SES_EU_CENTRAL_2 - AWS_SES_AP_SOUTHEAST_5 - AWS_SES_CA_WEST_1 + - AWS_SES_US_GOV_EAST_1 + - AWS_SES_US_GOV_WEST_1 CreateEmailIdentityResponse: description: If the email identity is a domain, this object contains information about the DKIM verification status for the domain. If the email identity is an email address, this object is empty. type: object @@ -3734,7 +3819,7 @@ components: description: "The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication. When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example: selector1._domainkey.yourdomain.com CNAME selector1.`` selector2._domainkey.yourdomain.com CNAME selector2.`` selector3._domainkey.yourdomain.com CNAME selector3.``" SigningAttributesOrigin: $ref: "#/components/schemas/DkimSigningAttributesOrigin" - description: "A string that indicates how DKIM was configured for the identity. These are the possible values: AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM). AWS_SES_AF_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_NORTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). AWS_SES_IL_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). AWS_SES_SA_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Calgary) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_5 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Malaysia) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED)." + description: "A string that indicates how DKIM was configured for the identity. These are the possible values: AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM). AWS_SES_AF_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_NORTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTH_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). AWS_SES_ME_SOUTH_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_NORTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). AWS_SES_IL_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). AWS_SES_SA_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). AWS_SES_CA_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Calgary) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_3 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). AWS_SES_AP_SOUTHEAST_5 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Malaysia) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). AWS_SES_EU_CENTRAL_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_EAST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_WEST_2 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_GOV_EAST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in AWS GovCloud (US-East) region using Deterministic Easy-DKIM (DEED). AWS_SES_US_GOV_WEST_1 – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in AWS GovCloud (US-West) region using Deterministic Easy-DKIM (DEED)." NextSigningKeyLength: $ref: "#/components/schemas/DkimSigningKeyLength" description: "[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day." @@ -4071,6 +4156,16 @@ components: description: The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only. type: string minLength: 1 + TenantSuppressionAttributes: + description: An object that contains the suppression list preferences for a tenant. + type: object + properties: + SuppressedReasons: + $ref: "#/components/schemas/SuppressionListReasons" + description: "A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list when a message sent to that address results in a hard bounce." + SuppressionScope: + $ref: "#/components/schemas/SuppressionListScope" + description: "The suppression scope for the tenant. Can be one of the following: TENANT – The tenant uses its own suppression list. ACCOUNT – The tenant uses the account-level suppression list. If you don't specify a suppression scope, the tenant defaults to ACCOUNT scope and uses the account-level suppression list." CreateTenantResponse: description: Information about a newly created tenant. type: object @@ -4093,6 +4188,8 @@ components: SendingStatus: $ref: "#/components/schemas/SendingStatus" description: The status of email sending capability for the tenant. + SuppressionAttributes: + $ref: "#/components/schemas/TenantSuppressionAttributes" TenantId: type: string SendingStatus: @@ -4174,6 +4271,9 @@ components: VdmAttributes: $ref: "#/components/schemas/VdmAttributes" description: The VDM attributes that apply to your Amazon SES account. + PricingAttributes: + $ref: "#/components/schemas/PricingAttributes" + description: The pricing attributes that apply to your Amazon SES account, including the currently active pricing plan and any scheduled change. GeneralEnforcementStatus: type: string SendQuota: @@ -4313,6 +4413,24 @@ components: OptimizedSharedDelivery: $ref: "#/components/schemas/FeatureStatus" description: "Specifies the status of your VDM optimized shared delivery. Can be one of the following: ENABLED – Amazon SES enables optimized shared delivery for your account. DISABLED – Amazon SES disables optimized shared delivery for your account." + PricingAttributes: + description: The pricing attributes that apply to your Amazon SES account, including the currently active pricing plan and any scheduled change for the next billing cycle. + type: object + properties: + CurrentPlan: + $ref: "#/components/schemas/PricingPlan" + description: The pricing plan that is currently active on your Amazon SES account. + NextPlan: + $ref: "#/components/schemas/PricingPlan" + description: The pricing plan that will become active at the start of the next billing cycle, if a scheduled change has been requested. This field is empty when no scheduled change is pending. + PricingPlan: + description: Identifies an Amazon SES pricing plan. See PutAccountPricingAttributesRequest$Plan for the list of supported values and their meanings. + type: string + enum: + - NONE + - ESSENTIALS + - PRO + - ENTERPRISE BlacklistItemNames: type: array items: @@ -4354,7 +4472,7 @@ components: description: An array of objects that define the tags (keys and values) that are associated with the configuration set. SuppressionOptions: $ref: "#/components/schemas/SuppressionOptions" - description: An object that contains information about the suppression list preferences for your account. + description: An object that contains information about the suppression list preferences for your account or for a specific tenant. VdmOptions: $ref: "#/components/schemas/VdmOptions" description: An object that contains information about the VDM preferences for your configuration set. @@ -5410,35 +5528,38 @@ components: required: - SuppressedDestination SuppressedDestination: - description: An object that contains information about an email address that is on the suppression list for your account. + description: An object that contains information about an email address that is on the suppression list for your account or for a specific tenant. type: object properties: EmailAddress: $ref: "#/components/schemas/EmailAddress" - description: The email address that is on the suppression list for your account. + description: The email address that is on the suppression list for your account or for a specific tenant. Reason: $ref: "#/components/schemas/SuppressionListReason" - description: The reason that the address was added to the suppression list for your account. + description: The reason that the address was added to the suppression list for your account or for a specific tenant. LastUpdateTime: $ref: "#/components/schemas/Timestamp" description: The date and time when the suppressed destination was last updated, shown in Unix time format. Attributes: $ref: "#/components/schemas/SuppressedDestinationAttributes" - description: An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account. + description: An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account or for a specific tenant. + TenantName: + $ref: "#/components/schemas/TenantName" + description: The name of the tenant that the suppressed destination belongs to. This field is present only when the suppressed destination is on a tenant's suppression list. required: - EmailAddress - Reason - LastUpdateTime SuppressedDestinationAttributes: - description: An object that contains additional attributes that are related an email address that is on the suppression list for your account. + description: An object that contains additional attributes that are related an email address that is on the suppression list for your account or for a specific tenant. type: object properties: MessageId: $ref: "#/components/schemas/OutboundMessageId" - description: The unique identifier of the email message that caused the email address to be added to the suppression list for your account. + description: The unique identifier of the email message that caused the email address to be added to the suppression list for your account or for a specific tenant. FeedbackId: $ref: "#/components/schemas/FeedbackId" - description: A unique identifier that's generated when an email address is added to the suppression list for your account. + description: A unique identifier that's generated when an email address is added to the suppression list for your account or for a specific tenant. FeedbackId: type: string GetTenantResponse: @@ -5470,6 +5591,9 @@ components: SendingStatus: $ref: "#/components/schemas/SendingStatus" description: The status of sending capability for the tenant. + SuppressionAttributes: + $ref: "#/components/schemas/TenantSuppressionAttributes" + description: An object that contains information about the suppression list preferences for the tenant. ListConfigurationSetsRowDisplay: type: object properties: @@ -5937,7 +6061,7 @@ components: description: A list of summaries, each containing a summary for a suppressed email destination. NextToken: $ref: "#/components/schemas/NextToken" - description: A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter. + description: A token that indicates that there are additional email addresses on the suppression list for your account or for the specified tenant. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter. SuppressedDestinationSummaries: type: array items: @@ -5948,10 +6072,10 @@ components: properties: EmailAddress: $ref: "#/components/schemas/EmailAddress" - description: The email address that's on the suppression list for your account. + description: The email address that's on the suppression list for your account or for a specific tenant. Reason: $ref: "#/components/schemas/SuppressionListReason" - description: The reason that the address was added to the suppression list for your account. + description: The reason that the address was added to the suppression list for your account or for a specific tenant. LastUpdateTime: $ref: "#/components/schemas/Timestamp" description: The date and time when the suppressed destination was last updated, shown in Unix time format. @@ -6042,6 +6166,9 @@ components: PutAccountDetailsResponse: description: An HTTP 200 response if the request succeeds, or an error message if the request fails. type: object + PutAccountPricingAttributesResponse: + description: An HTTP 200 response if the request succeeds, or an error response if the request fails. + type: object PutAccountSendingAttributesResponse: description: An HTTP 200 response if the request succeeds, or an error message if the request fails. type: object @@ -6114,6 +6241,9 @@ components: PutSuppressedDestinationResponse: description: An HTTP 200 response if the request succeeds, or an error message if the request fails. type: object + PutTenantSuppressionAttributesResponse: + description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. + type: object EmailAddressList: type: array items: @@ -7168,6 +7298,17 @@ components: location: body requestBodyTranslate: algorithm: naive + put_tenant_suppression_attributes: + operation: + $ref: "#/paths/~1v2~1email~1tenant~1suppression/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive sqlVerbs: select: - $ref: "#/components/x-stackQL-resources/tenants/methods/get_tenant" @@ -7175,6 +7316,8 @@ components: insert: - $ref: "#/components/x-stackQL-resources/tenants/methods/create_tenant" update: [] + replace: + - $ref: "#/components/x-stackQL-resources/tenants/methods/put_tenant_suppression_attributes" delete: - $ref: "#/components/x-stackQL-resources/tenants/methods/delete_tenant" tenant_resources: @@ -7242,6 +7385,8 @@ components: response: openAPIDocKey: "200" mediaType: application/json + request: + nativeCasing: pascal get_suppressed_destination: operation: $ref: "#/paths/~1v2~1email~1suppression~1addresses~1{email_address}/get" @@ -7249,6 +7394,8 @@ components: openAPIDocKey: "200" mediaType: application/json objectKey: $.SuppressedDestination + request: + nativeCasing: pascal list_suppressed_destinations: operation: $ref: "#/paths/~1v2~1email~1suppression~1addresses/get" @@ -7311,6 +7458,17 @@ components: config: requestBodyTranslate: algorithm: naive + put_account_pricing_attributes: + operation: + $ref: "#/paths/~1v2~1email~1account~1pricing-attributes/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive put_account_sending_attributes: operation: $ref: "#/paths/~1v2~1email~1account~1sending/put" @@ -7351,6 +7509,7 @@ components: update: [] replace: - $ref: "#/components/x-stackQL-resources/accounts/methods/put_account_details" + - $ref: "#/components/x-stackQL-resources/accounts/methods/put_account_pricing_attributes" - $ref: "#/components/x-stackQL-resources/accounts/methods/put_account_vdm_attributes" - $ref: "#/components/x-stackQL-resources/accounts/methods/put_account_dedicated_ip_warmup_attributes" delete: [] diff --git a/providers/src/aws/v00.00.00000/services/signin.yaml b/providers/src/aws/v00.00.00000/services/signin.yaml index a993b5a0..224f4b3c 100644 --- a/providers/src/aws/v00.00.00000/services/signin.yaml +++ b/providers/src/aws/v00.00.00000/services/signin.yaml @@ -39,6 +39,238 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateOAuth2TokenResponse" + /v1/token?x-amz-client-auth-method=iam: + post: + operationId: CreateOAuth2TokenWithIAM + description: Grants permission to exchange client credentials for an OAuth 2.0 access token scoped to a resource that can be used to access AWS services from applications + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + grantType: + $ref: "#/components/schemas/ClientCredentialsGrantType" + resource: + $ref: "#/components/schemas/CreateOAuth2TokenWithIAMRequestResourceString" + required: + - grantType + - resource + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateOAuth2TokenWithIAMResponse" + /delete-console-authorization-configuration: + post: + operationId: DeleteConsoleAuthorizationConfiguration + description: Delete console authorization configuration with automatic scope detection + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteConsoleAuthorizationConfigurationOutput" + /delete-resource-permission-statement: + post: + operationId: DeleteResourcePermissionStatement + description: Remove a permission statement from the account's SignIn resource-based policy + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + statementId: + $ref: "#/components/schemas/StatementId" + clientToken: + $ref: "#/components/schemas/ClientToken" + required: + - statementId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteResourcePermissionStatementOutput" + /get-console-authorization-configuration: + post: + operationId: GetConsoleAuthorizationConfiguration + description: Get console authorization configuration with automatic scope detection + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetConsoleAuthorizationConfigurationOutput" + /get-resource-policy: + post: + operationId: GetResourcePolicy + description: Retrieve the account's consolidated SignIn resource-based policy + parameters: [] + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetResourcePolicyOutput" + /v1/introspect?x-amz-client-auth-method=iam: + post: + operationId: IntrospectOAuth2TokenWithIAM + description: 'Grants permission to inspect the metadata and state of an OAuth 2.0 access token or refresh token Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Inspects the metadata of an access_token or refresh_token issued by AWS Sign-In and returns the claims associated with it. Inactive token semantics (RFC 7662 §2.2): when the supplied token is unknown, expired, revoked, malformed, or owned by a different account, the response body is exactly { "active": false } with all other claims omitted.' + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token: + $ref: "#/components/schemas/IntrospectionToken" + tokenTypeHint: + $ref: "#/components/schemas/TokenTypeHint" + required: + - token + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IntrospectOAuth2TokenWithIAMResponse" + /list-resource-permission-statements: + post: + operationId: ListResourcePermissionStatements + description: Retrieve all permission statements in the account's SignIn resource-based policy + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + maxResults: + $ref: "#/components/schemas/ConsolePermissionMaxResults" + nextToken: + $ref: "#/components/schemas/NextToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListResourcePermissionStatementsOutput" + /put-console-authorization-configuration: + post: + operationId: PutConsoleAuthorizationConfiguration + description: Enable console authorization configuration with automatic scope detection + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutConsoleAuthorizationConfigurationOutput" + /put-resource-permission-statement: + post: + operationId: PutResourcePermissionStatement + description: Create a permission statement in the account's SignIn resource-based policy + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + sourceVpc: + $ref: "#/components/schemas/SourceVpc" + signinSourceVpce: + $ref: "#/components/schemas/SourceVpce" + consoleSourceVpce: + $ref: "#/components/schemas/SourceVpce" + vpcSourceIp: + $ref: "#/components/schemas/VpcSourceIp" + sourceIp: + $ref: "#/components/schemas/SourceIp" + requestedRegion: + $ref: "#/components/schemas/RequestedRegion" + excludedPrincipal: + $ref: "#/components/schemas/ExcludedPrincipal" + clientToken: + $ref: "#/components/schemas/ClientToken" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutResourcePermissionStatementOutput" + /v1/revoke?x-amz-client-auth-method=iam: + post: + operationId: RevokeOAuth2TokenWithIAM + description: "Grants permission to revoke an OAuth 2.0 refresh token and its associated refresh tokens Revokes a refresh_token issued by AWS Sign-In, invalidating the entire token chain so that the refresh_token can no longer be used to mint new access_tokens. Idempotency: revoking an already-revoked, expired, or otherwise invalid token still returns 200 OK with an empty body. Only the refresh_token type is accepted." + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token: + $ref: "#/components/schemas/RevocationToken" + required: + - token + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RevokeOAuth2TokenWithIAMResponse" components: parameters: X-Amz-Content-Sha256: @@ -110,7 +342,7 @@ components: - clientId - grantType ClientId: - description: "Client identifier pattern for AWS Sign-In devtools clients The ARN used by client as part of Sign-In onboarding. Expected values: arn:aws:signin:::devtools/cross-device (for cross-device devtools login) arn:aws:signin:::devtools/same-device (for same-device devtools login) This will be finalized after consulting with UX as this is visible to end customer." + description: "Client identifier pattern for AWS Sign-In devtools clients The ARN used by client as part of Sign-In onboarding. Expected values: arn:aws:signin:::devtools/cross-device (for cross-device devtools login) arn:aws:signin:::devtools/same-device (for same-device devtools login)" type: string pattern: arn:aws:signin:::devtools/(cross-device|same-device) GrantType: @@ -172,7 +404,7 @@ components: - expiresIn - refreshToken AccessToken: - description: AWS credentials structure containing temporary access credentials The scoped-down, 15 minute duration AWS credentials. Scoping down will be based on CLI policy (CLI team needs to create it). Similar to cloud shell implementation. + description: AWS credentials structure containing temporary access credentials Scoped, temporary AWS credentials with a 15-minute duration. type: object properties: accessKeyId: @@ -204,6 +436,319 @@ components: type: string minLength: 1 maxLength: 4096 + ClientCredentialsGrantType: + description: OAuth 2.0 grant type for client_credentials flow. + type: string + pattern: client_credentials + CreateOAuth2TokenWithIAMRequestResourceString: + type: string + minLength: 1 + maxLength: 2048 + CreateOAuth2TokenWithIAMResponse: + description: Output structure for CreateOAuth2TokenWithIAM operation Contains the JWT access token, token type, and expiration per RFC 6749 §5.1. + type: object + properties: + accessToken: + $ref: "#/components/schemas/OAuthAccessToken" + description: JWT access token containing principal identity, resource scope, and session metadata + tokenType: + $ref: "#/components/schemas/BearerTokenType" + description: Always "Bearer" per OAuth 2.1 specification + expiresIn: + $ref: "#/components/schemas/TokenExpiresIn" + description: Token lifetime in seconds. Value is the minimum of session validity and 1 hour. + required: + - accessToken + - tokenType + - expiresIn + OAuthAccessToken: + description: OAuth 2.0 access token (JWT) containing principal identity and resource scope. + type: string + minLength: 1 + maxLength: 4096 + BearerTokenType: + description: Token type for access tokens. Always "Bearer" per OAuth 2.1. + type: string + pattern: Bearer + TokenExpiresIn: + description: Token lifetime in seconds. Value is the minimum of session validity and 1 hour (3600 seconds). + type: integer + minimum: 1 + maximum: 3600 + TargetId: + description: Target account identifier for console authorization + type: string + minLength: 12 + maxLength: 32 + pattern: (\d{12}|o-[a-z0-9]{10}|r-[0-9a-z]{4,32}) + DeleteConsoleAuthorizationConfigurationOutput: + description: Output for DeleteConsoleAuthorizationConfiguration operation + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + description: Target account identifier + scope: + $ref: "#/components/schemas/String" + description: Authorization scope + consoleAuthorizationEnabled: + $ref: "#/components/schemas/Boolean" + description: Whether console authorization is enabled + required: + - targetId + - scope + - consoleAuthorizationEnabled + Boolean: + type: boolean + StatementId: + description: Unique identifier for a permission statement + type: string + pattern: "[A-Za-z0-9+/]{64}=?" + ClientToken: + description: Idempotency token + type: string + minLength: 1 + maxLength: 64 + pattern: "[!-~]+" + DeleteResourcePermissionStatementOutput: + description: Output for DeleteResourcePermissionStatement operation + type: object + GetConsoleAuthorizationConfigurationOutput: + description: Output for GetConsoleAuthorizationConfiguration operation + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + description: Target account identifier + scope: + $ref: "#/components/schemas/String" + description: Authorization scope + consoleAuthorizationEnabled: + $ref: "#/components/schemas/Boolean" + description: Whether console authorization is enabled + required: + - targetId + - scope + - consoleAuthorizationEnabled + GetResourcePolicyOutput: + description: Output for GetResourcePolicy operation + type: object + properties: + signinResourceBasedPolicy: + $ref: "#/components/schemas/SigninResourceBasedPolicy" + description: The account's SignIn resource-based policy + required: + - signinResourceBasedPolicy + SigninResourceBasedPolicy: + description: SignIn resource-based policy document + type: object + properties: + version: + $ref: "#/components/schemas/String" + description: Policy version + statement: + $ref: "#/components/schemas/PolicyStatements" + description: Policy statements + PolicyStatements: + type: array + items: + $ref: "#/components/schemas/PolicyStatement" + PolicyStatement: + description: Individual policy statement within a resource-based policy + type: object + properties: + effect: + $ref: "#/components/schemas/String" + description: Effect of the policy statement (Allow/Deny) + principal: + type: object + properties: {} + description: Principal the statement applies to + action: + $ref: "#/components/schemas/PolicyActions" + description: Actions the statement controls + resource: + $ref: "#/components/schemas/String" + description: Resource the statement applies to + condition: + type: object + properties: {} + description: Condition block for the statement + PolicyActions: + description: List of policy actions + type: array + items: + $ref: "#/components/schemas/String" + IntrospectionToken: + description: Token string submitted for introspection. May be an AWS Sign-In access_token (prefix "ASOA") or refresh_token (prefix "ASOR"). + type: string + minLength: 1 + maxLength: 4096 + pattern: ASO[AR][A-Za-z0-9+/=_\-]+ + TokenTypeHint: + description: 'Optional RFC 7662 §2.1 token_type_hint value. One of: "access_token" "refresh_token"' + type: string + pattern: (access_token|refresh_token) + IntrospectOAuth2TokenWithIAMResponse: + description: Output structure for IntrospectOAuth2TokenWithIAM operation RFC 7662 §2.2 introspection response. Only active is required; all other claims are omitted when the token is inactive. + type: object + properties: + active: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the token is currently active. true only when the token is valid, has not expired, has not been revoked, and belongs to the caller's account. + clientId: + $ref: "#/components/schemas/String" + description: Client identifier for the OAuth 2.0 client that requested the token. + userId: + $ref: "#/components/schemas/String" + description: User identifier matching sts:GetCallerIdentity's UserId field for the token's subject principal (e.g. "AIDAEXAMPLE" for an IAM user, or "AROAEXAMPLE:session-name" for an assumed role). + tokenType: + $ref: "#/components/schemas/IntrospectedTokenType" + description: Indicates which kind of token was introspected. One of "access_token" or "refresh_token". + exp: + $ref: "#/components/schemas/Long" + description: Token expiration time as a NumericDate (Unix epoch seconds). + iat: + $ref: "#/components/schemas/Long" + description: Token issuance time as a NumericDate (Unix epoch seconds). + nbf: + $ref: "#/components/schemas/Long" + description: Token "not before" time as a NumericDate (Unix epoch seconds). + sub: + $ref: "#/components/schemas/String" + description: "Subject of the token: the IAM principal ARN. For assumed-role sessions, this is the session ARN (matches sts:GetCallerIdentity's Arn field), e.g. arn:aws:sts::123456789012:assumed-role/MyRole/session-name." + aud: + $ref: "#/components/schemas/String" + description: 'Audience of the token: the OAuth resource the token is scoped to (for example, "aws-mcp.amazonaws.com"). Omitted for refresh tokens.' + iss: + $ref: "#/components/schemas/String" + description: Issuer of the token. Always "signin.amazonaws.com" for AWS Sign-In. + jti: + $ref: "#/components/schemas/String" + description: Unique identifier for the token. + accountId: + $ref: "#/components/schemas/AccountId" + description: 12-digit AWS account ID of the token's subject principal. + signinSession: + $ref: "#/components/schemas/String" + description: AWS Sign-In session ARN bound to the token, of the form arn:aws:signin:{region}:{account}:session/{uuid}. + resource: + $ref: "#/components/schemas/String" + description: The OAuth resource the token is scoped to during Human OAuth flow. Only present for refresh token introspection. + required: + - active + IntrospectedTokenType: + description: Introspection response token_type value. Indicates which kind of token was inspected. + type: string + pattern: (access_token|refresh_token) + Long: + type: integer + format: int64 + AccountId: + description: AWS account identifier + type: string + minLength: 12 + maxLength: 12 + pattern: "[0-9]{12}" + ConsolePermissionMaxResults: + description: Maximum number of results for list operations + type: integer + minimum: 1 + maximum: 100 + NextToken: + description: Pagination token + type: string + minLength: 0 + maxLength: 2048 + pattern: "[-a-zA-Z0-9+=/_]*" + ListResourcePermissionStatementsOutput: + description: Output for ListResourcePermissionStatements operation + type: object + properties: + permissionStatements: + $ref: "#/components/schemas/PermissionStatementSummaries" + description: List of permission statement summaries + nextToken: + $ref: "#/components/schemas/NextToken" + description: Token for next page of results + required: + - permissionStatements + PermissionStatementSummaries: + type: array + items: + $ref: "#/components/schemas/PermissionStatementSummary" + PermissionStatementSummary: + description: Summary of a permission statement + type: object + properties: + sid: + $ref: "#/components/schemas/StatementId" + description: Unique identifier for the permission statement + condition: + type: object + properties: {} + description: Condition block for the permission statement + required: + - sid + PutConsoleAuthorizationConfigurationOutput: + description: Output for PutConsoleAuthorizationConfiguration operation + type: object + properties: + targetId: + $ref: "#/components/schemas/TargetId" + description: Target account identifier + scope: + $ref: "#/components/schemas/String" + description: Authorization scope + consoleAuthorizationEnabled: + $ref: "#/components/schemas/Boolean" + description: Whether console authorization is enabled + required: + - targetId + - scope + - consoleAuthorizationEnabled + SourceVpc: + description: VPC identifier for network-based access control + type: string + pattern: vpc-([0-9a-f]{8}|[0-9a-f]{17}) + SourceVpce: + description: VPC endpoint identifier + type: string + pattern: vpce-[a-z0-9]{8,20} + VpcSourceIp: + description: Source IP address within a VPC + type: string + SourceIp: + description: Source IP address for access control + type: string + RequestedRegion: + description: AWS region identifier for VPC and VPC endpoint pairing + type: string + pattern: "[a-z]{2}(-[a-z]+)+-\\d+" + ExcludedPrincipal: + description: Principal to exclude from permission statements + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws:((iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]{1,64})|(iam::[0-9]{12}:user/[a-zA-Z0-9_+=,.@-]{1,64})|(sts::[0-9]{12}:federated-user/[a-zA-Z0-9_+=,.@-]{2,193})|(iam::[0-9]{12}:root)) + PutResourcePermissionStatementOutput: + description: Output for PutResourcePermissionStatement operation + type: object + properties: + statementId: + $ref: "#/components/schemas/StatementId" + description: Unique identifier for the created permission statement + required: + - statementId + RevocationToken: + description: Refresh token string submitted for revocation. Must be an AWS Sign-In refresh_token (prefix "ASOR"). + type: string + minLength: 1 + maxLength: 4096 + pattern: ASOR[A-Za-z0-9+/=_\-]+ + RevokeOAuth2TokenWithIAMResponse: + description: Output structure for RevokeOAuth2TokenWithIAM operation RFC 7009 §2.2 revocation response. The endpoint returns 200 OK with an empty body on success; there are no response fields. + type: object x-stackQL-resources: o_auth2_tokens: id: aws.signin.o_auth2_tokens @@ -227,3 +772,157 @@ components: - $ref: "#/components/x-stackQL-resources/o_auth2_tokens/methods/create_o_auth2_token" update: [] delete: [] + o_auth2_token_with_iams: + id: aws.signin.o_auth2_token_with_iams + name: o_auth2_token_with_iams + title: o_auth2_token_with_iams + methods: + create_o_auth2_token_with_iam: + operation: + $ref: "#/paths/~1v1~1token?x-amz-client-auth-method=iam/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + revoke_o_auth2_token_with_iam: + operation: + $ref: "#/paths/~1v1~1revoke?x-amz-client-auth-method=iam/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: + - $ref: "#/components/x-stackQL-resources/o_auth2_token_with_iams/methods/create_o_auth2_token_with_iam" + update: + - $ref: "#/components/x-stackQL-resources/o_auth2_token_with_iams/methods/revoke_o_auth2_token_with_iam" + delete: [] + console_authorization_configurations: + id: aws.signin.console_authorization_configurations + name: console_authorization_configurations + title: console_authorization_configurations + methods: + delete_console_authorization_configuration: + operation: + $ref: "#/paths/~1delete-console-authorization-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + get_console_authorization_configuration: + operation: + $ref: "#/paths/~1get-console-authorization-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + put_console_authorization_configuration: + operation: + $ref: "#/paths/~1put-console-authorization-configuration/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/console_authorization_configurations/methods/get_console_authorization_configuration" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/console_authorization_configurations/methods/put_console_authorization_configuration" + delete: + - $ref: "#/components/x-stackQL-resources/console_authorization_configurations/methods/delete_console_authorization_configuration" + resource_permission_statements: + id: aws.signin.resource_permission_statements + name: resource_permission_statements + title: resource_permission_statements + methods: + delete_resource_permission_statement: + operation: + $ref: "#/paths/~1delete-resource-permission-statement/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_resource_permission_statements: + operation: + $ref: "#/paths/~1list-resource-permission-statements/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.permissionStatements + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + put_resource_permission_statement: + operation: + $ref: "#/paths/~1put-resource-permission-statement/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/resource_permission_statements/methods/list_resource_permission_statements" + insert: [] + update: [] + replace: + - $ref: "#/components/x-stackQL-resources/resource_permission_statements/methods/put_resource_permission_statement" + delete: + - $ref: "#/components/x-stackQL-resources/resource_permission_statements/methods/delete_resource_permission_statement" + resource_policies: + id: aws.signin.resource_policies + name: resource_policies + title: resource_policies + methods: + get_resource_policy: + operation: + $ref: "#/paths/~1get-resource-policy/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.signinResourceBasedPolicy + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/resource_policies/methods/get_resource_policy" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml b/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml deleted file mode 100644 index 67af53d6..00000000 --- a/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml +++ /dev/null @@ -1,1059 +0,0 @@ -openapi: 3.0.0 -info: - version: "2022-10-28" - title: AWS SimSpace Weaver - description: AWS SimSpace Weaver - x-serviceName: simspaceweaver - x-serviceAlias: simspaceweaver - x-protocol: rest-json - x-apiVersion: "2022-10-28" - x-endpointPrefix: simspaceweaver - x-jsonVersion: "1.1" -servers: - - url: https://simspaceweaver.{region}.amazonaws.com - variables: - region: - default: us-east-1 - description: AWS region - description: Regional endpoint for simspaceweaver -paths: - /createsnapshot: - post: - operationId: CreateSnapshot - description: "Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide. You specify a Destination when you create a snapshot. The Destination is the name of an Amazon S3 bucket and an optional ObjectKeyPrefix. The ObjectKeyPrefix is usually the name of a folder in the bucket. SimSpace Weaver creates a snapshot folder inside the Destination and places the snapshot file there. The snapshot file is an Amazon S3 object. It has an object key with the form: object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where: YY is the 2-digit year MM is the 2-digit month dd is the 2-digit day of the month HH is the 2-digit hour (24-hour clock) mm is the 2-digit minutes ss is the 2-digit seconds" - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Destination: - $ref: "#/components/schemas/S3Destination" - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - required: - - Destination - - Simulation - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/CreateSnapshotOutput" - /deleteapp: - delete: - operationId: DeleteApp - description: Deletes the instance of the given custom app. - parameters: - - name: app - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the app. - - name: domain - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain of the app. - - name: simulation - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation of the app. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteAppOutput" - /deletesimulation: - delete: - operationId: DeleteSimulation - description: Deletes all SimSpace Weaver resources assigned to the given simulation. Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services. - parameters: - - name: simulation - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteSimulationOutput" - /describeapp: - get: - operationId: DescribeApp - description: Returns the state of the given custom app. - parameters: - - name: app - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverLongResourceName" - description: The name of the app. - - name: domain - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain of the app. - - name: simulation - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation of the app. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeAppOutput" - /describesimulation: - get: - operationId: DescribeSimulation - description: Returns the current state of the given simulation. - parameters: - - name: simulation - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeSimulationOutput" - /listapps: - get: - operationId: ListApps - description: Lists all custom apps or service apps for the given simulation and domain. - parameters: - - name: domain - in: query - required: false - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain that you want to list apps for. - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/PositiveInteger" - description: The maximum number of apps to list. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/OptionalString" - description: If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error. - - name: simulation - in: query - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation that you want to list apps for. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListAppsOutput" - /listsimulations: - get: - operationId: ListSimulations - description: Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call. - parameters: - - name: maxResults - in: query - required: false - schema: - $ref: "#/components/schemas/PositiveInteger" - description: The maximum number of simulations to list. - - name: nextToken - in: query - required: false - schema: - $ref: "#/components/schemas/OptionalString" - description: If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListSimulationsOutput" - /tags/{resource_arn}: - get: - operationId: ListTagsForResource - description: Lists all tags on a SimSpace Weaver resource. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ListTagsForResourceOutput" - post: - operationId: TagResource - description: Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Tags: - $ref: "#/components/schemas/TagMap" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/TagResourceOutput" - delete: - operationId: UntagResource - description: Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. - parameters: - - name: resource_arn - in: path - required: true - schema: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - - name: tagKeys - in: query - required: true - schema: - $ref: "#/components/schemas/TagKeyList" - description: A list of tag keys to remove from the resource. - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UntagResourceOutput" - /startapp: - post: - operationId: StartApp - description: Starts a custom app with the configuration specified in the simulation schema. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ClientToken: - $ref: "#/components/schemas/ClientToken" - Description: - $ref: "#/components/schemas/Description" - Domain: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - LaunchOverrides: - $ref: "#/components/schemas/LaunchOverrides" - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StartAppOutput" - /startclock: - post: - operationId: StartClock - description: Starts the simulation clock. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - required: - - Simulation - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StartClockOutput" - /startsimulation: - post: - operationId: StartSimulation - description: Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the schema reference in the SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ClientToken: - $ref: "#/components/schemas/ClientToken" - Description: - $ref: "#/components/schemas/Description" - MaximumDuration: - $ref: "#/components/schemas/TimeToLiveString" - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - RoleArn: - $ref: "#/components/schemas/RoleArn" - SchemaS3Location: - $ref: "#/components/schemas/S3Location" - SnapshotS3Location: - $ref: "#/components/schemas/S3Location" - Tags: - $ref: "#/components/schemas/TagMap" - required: - - Name - - RoleArn - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StartSimulationOutput" - /stopapp: - post: - operationId: StopApp - description: Stops the given custom app and shuts down all of its allocated compute resources. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - App: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - Domain: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - required: - - App - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StopAppOutput" - /stopclock: - post: - operationId: StopClock - description: Stops the simulation clock. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - required: - - Simulation - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StopClockOutput" - /stopsimulation: - post: - operationId: StopSimulation - description: Stops the given simulation. You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it. - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - required: - - Simulation - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/StopSimulationOutput" -components: - parameters: - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false - schema: - type: string - X-Amz-Security-Token: - in: header - name: X-Amz-Security-Token - required: false - schema: - type: string - X-Amz-Signature: - in: header - name: X-Amz-Signature - required: false - schema: - type: string - X-Amz-SignedHeaders: - in: header - name: X-Amz-SignedHeaders - required: false - schema: - type: string - schemas: - S3Destination: - description: An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file. - type: object - properties: - BucketName: - $ref: "#/components/schemas/BucketName" - description: The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide. - ObjectKeyPrefix: - $ref: "#/components/schemas/ObjectKeyPrefix" - description: A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders in the Amazon Simple Storage Service User Guide. - required: - - BucketName - BucketName: - type: string - minLength: 3 - maxLength: 63 - ObjectKeyPrefix: - type: string - minLength: 0 - maxLength: 1024 - SimSpaceWeaverResourceName: - type: string - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9_.-]+$ - CreateSnapshotOutput: - type: object - DeleteAppOutput: - type: object - DeleteSimulationOutput: - type: object - SimSpaceWeaverLongResourceName: - type: string - minLength: 1 - maxLength: 256 - pattern: ^[a-zA-Z0-9_.-]+$ - DescribeAppOutput: - type: object - properties: - Description: - $ref: "#/components/schemas/Description" - description: The description of the app. - Domain: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain of the app. - EndpointInfo: - $ref: "#/components/schemas/SimulationAppEndpointInfo" - description: Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app. - LaunchOverrides: - $ref: "#/components/schemas/LaunchOverrides" - Name: - $ref: "#/components/schemas/SimSpaceWeaverLongResourceName" - description: The name of the app. - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation of the app. - Status: - $ref: "#/components/schemas/SimulationAppStatus" - description: The current lifecycle state of the custom app. - TargetStatus: - $ref: "#/components/schemas/SimulationAppTargetStatus" - description: The desired lifecycle state of the custom app. - Description: - type: string - minLength: 0 - maxLength: 500 - SimulationAppEndpointInfo: - description: "Information about the network endpoint that you can use to connect to your custom or service app. For more information about SimSpace Weaver apps, see Key concepts: Apps in the SimSpace Weaver User Guide.." - type: object - properties: - Address: - $ref: "#/components/schemas/NonEmptyString" - description: The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts. - IngressPortMappings: - $ref: "#/components/schemas/AppPortMappings" - description: The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint. - NonEmptyString: - type: string - minLength: 1 - maxLength: 1600 - AppPortMappings: - type: array - items: - $ref: "#/components/schemas/SimulationAppPortMapping" - SimulationAppPortMapping: - description: A collection of TCP/UDP ports for a custom or service app. - type: object - properties: - Actual: - $ref: "#/components/schemas/PortNumber" - description: The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app's IP address and the Actual port number. - Declared: - $ref: "#/components/schemas/PortNumber" - description: The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port. - PortNumber: - type: integer - minimum: 0 - maximum: 65535 - LaunchOverrides: - description: Options that apply when the app starts. These options override default behavior. - type: object - properties: - LaunchCommands: - $ref: "#/components/schemas/LaunchCommandList" - description: App launch commands and command line parameters that override the launch command configured in the simulation schema. - LaunchCommandList: - type: array - items: - $ref: "#/components/schemas/NonEmptyString" - SimulationAppStatus: - type: string - enum: - - STARTING - - STARTED - - STOPPING - - STOPPED - - ERROR - - UNKNOWN - SimulationAppTargetStatus: - type: string - enum: - - UNKNOWN - - STARTED - - STOPPED - DescribeSimulationOutput: - type: object - properties: - Arn: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - CreationTime: - $ref: "#/components/schemas/Timestamp" - description: The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). - Description: - $ref: "#/components/schemas/Description" - description: The description of the simulation. - ExecutionId: - $ref: "#/components/schemas/UUID" - description: A universally unique identifier (UUID) for this simulation. - LiveSimulationState: - $ref: "#/components/schemas/LiveSimulationState" - description: A collection of additional state information, such as domain and clock configuration. - LoggingConfiguration: - $ref: "#/components/schemas/LoggingConfiguration" - description: Settings that control how SimSpace Weaver handles your simulation log data. - MaximumDuration: - $ref: "#/components/schemas/TimeToLiveString" - description: The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started. - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation. - RoleArn: - $ref: "#/components/schemas/RoleArn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide. - SchemaError: - $ref: "#/components/schemas/OptionalString" - description: An error message that SimSpace Weaver returns only if there is a problem with the simulation schema. - SchemaS3Location: - $ref: "#/components/schemas/S3Location" - description: The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide . - SnapshotS3Location: - $ref: "#/components/schemas/S3Location" - StartError: - $ref: "#/components/schemas/OptionalString" - description: An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state. - Status: - $ref: "#/components/schemas/SimulationStatus" - description: The current lifecycle state of the simulation. - TargetStatus: - $ref: "#/components/schemas/SimulationTargetStatus" - description: The desired lifecycle state of the simulation. - SimSpaceWeaverArn: - type: string - minLength: 0 - maxLength: 1600 - pattern: ^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:([a-z]+)\/(.+)$ - Timestamp: - type: string - format: date-time - UUID: - type: string - minLength: 36 - pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - LiveSimulationState: - description: A collection of additional state information, such as domain and clock configuration. - type: object - properties: - Clocks: - $ref: "#/components/schemas/SimulationClockList" - description: A list of simulation clocks. At this time, a simulation has only one clock. - Domains: - $ref: "#/components/schemas/DomainList" - description: "A list of domains for the simulation. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide." - SimulationClockList: - type: array - items: - $ref: "#/components/schemas/SimulationClock" - SimulationClock: - description: Status information about the simulation clock. - type: object - properties: - Status: - $ref: "#/components/schemas/ClockStatus" - description: The current status of the simulation clock. - TargetStatus: - $ref: "#/components/schemas/ClockTargetStatus" - description: The desired status of the simulation clock. - ClockStatus: - type: string - enum: - - UNKNOWN - - STARTING - - STARTED - - STOPPING - - STOPPED - ClockTargetStatus: - type: string - enum: - - UNKNOWN - - STARTED - - STOPPED - DomainList: - type: array - items: - $ref: "#/components/schemas/Domain" - Domain: - description: "A collection of app instances that run the same executable app code and have the same launch options and commands. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide." - type: object - properties: - Lifecycle: - $ref: "#/components/schemas/LifecycleManagementStrategy" - description: "The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps). Lifecycle types PerWorker – Managed: SimSpace Weaver starts one app on each worker. BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition. ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps." - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain. - LifecycleManagementStrategy: - type: string - enum: - - Unknown - - PerWorker - - BySpatialSubdivision - - ByRequest - LoggingConfiguration: - description: The logging configuration for a simulation. - type: object - properties: - Destinations: - $ref: "#/components/schemas/LogDestinations" - description: A list of the locations where SimSpace Weaver sends simulation log data. - LogDestinations: - type: array - items: - $ref: "#/components/schemas/LogDestination" - LogDestination: - description: The location where SimSpace Weaver sends simulation log data. - type: object - properties: - CloudWatchLogsLogGroup: - $ref: "#/components/schemas/CloudWatchLogsLogGroup" - description: An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide. - CloudWatchLogsLogGroup: - description: The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide. - type: object - properties: - LogGroupArn: - $ref: "#/components/schemas/LogGroupArn" - description: The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide. - LogGroupArn: - type: string - minLength: 0 - maxLength: 1600 - pattern: ^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:role\/(.+)$ - TimeToLiveString: - type: string - minLength: 2 - maxLength: 6 - pattern: ^\d{1,5}[mhdMHD]$ - RoleArn: - type: string - minLength: 0 - maxLength: 1600 - pattern: ^arn:(?:aws|aws-cn|aws-us-gov):iam::(\d{12})?:role\/(.+)$ - OptionalString: - type: string - S3Location: - description: A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide . - type: object - properties: - BucketName: - $ref: "#/components/schemas/BucketName" - description: The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide. - ObjectKey: - $ref: "#/components/schemas/ObjectKey" - description: The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide. - required: - - BucketName - - ObjectKey - ObjectKey: - type: string - minLength: 1 - maxLength: 1024 - SimulationStatus: - type: string - enum: - - UNKNOWN - - STARTING - - STARTED - - STOPPING - - STOPPED - - FAILED - - DELETING - - DELETED - - SNAPSHOT_IN_PROGRESS - SimulationTargetStatus: - type: string - enum: - - UNKNOWN - - STARTED - - STOPPED - - DELETED - PositiveInteger: - type: integer - minimum: 1 - ListAppsOutput: - type: object - properties: - Apps: - $ref: "#/components/schemas/SimulationAppList" - description: The list of apps for the given simulation and domain. - NextToken: - $ref: "#/components/schemas/OptionalString" - description: If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error. - SimulationAppList: - type: array - items: - $ref: "#/components/schemas/SimulationAppMetadata" - SimulationAppMetadata: - description: A collection of metadata about the app. - type: object - properties: - Domain: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: "The domain of the app. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide." - Name: - $ref: "#/components/schemas/SimSpaceWeaverLongResourceName" - description: The name of the app. - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation of the app. - Status: - $ref: "#/components/schemas/SimulationAppStatus" - description: The current status of the app. - TargetStatus: - $ref: "#/components/schemas/SimulationAppTargetStatus" - description: The desired status of the app. - ListSimulationsOutput: - type: object - properties: - NextToken: - $ref: "#/components/schemas/OptionalString" - description: If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error. - Simulations: - $ref: "#/components/schemas/SimulationList" - description: The list of simulations. - SimulationList: - type: array - items: - $ref: "#/components/schemas/SimulationMetadata" - SimulationMetadata: - description: A collection of data about the simulation. - type: object - properties: - Arn: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - CreationTime: - $ref: "#/components/schemas/Timestamp" - description: The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation. - Status: - $ref: "#/components/schemas/SimulationStatus" - description: The current status of the simulation. - TargetStatus: - $ref: "#/components/schemas/SimulationTargetStatus" - description: The desired status of the simulation. - ListTagsForResourceOutput: - type: object - properties: - Tags: - type: object - properties: {} - description: The list of tags for the resource. - ClientToken: - type: string - minLength: 32 - maxLength: 128 - pattern: ^[a-zA-Z0-9-]+$ - StartAppOutput: - type: object - properties: - Domain: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the domain of the app. - Name: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the app. - Simulation: - $ref: "#/components/schemas/SimSpaceWeaverResourceName" - description: The name of the simulation of the app. - StartClockOutput: - type: object - TagMap: - type: object - properties: {} - StartSimulationOutput: - type: object - properties: - Arn: - $ref: "#/components/schemas/SimSpaceWeaverArn" - description: The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. - CreationTime: - $ref: "#/components/schemas/Timestamp" - description: The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). - ExecutionId: - $ref: "#/components/schemas/UUID" - description: A universally unique identifier (UUID) for this simulation. - StopAppOutput: - type: object - StopClockOutput: - type: object - StopSimulationOutput: - type: object - TagResourceOutput: - type: object - TagKeyList: - type: array - items: - $ref: "#/components/schemas/TagKey" - TagKey: - type: string - minLength: 1 - maxLength: 128 - UntagResourceOutput: - type: object - x-stackQL-resources: - snapshots: - id: aws.simspaceweaver.snapshots - name: snapshots - title: snapshots - methods: - create_snapshot: - operation: - $ref: "#/paths/~1createsnapshot/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - sqlVerbs: - select: [] - insert: - - $ref: "#/components/x-stackQL-resources/snapshots/methods/create_snapshot" - update: [] - delete: [] - apps: - id: aws.simspaceweaver.apps - name: apps - title: apps - methods: - delete_app: - operation: - $ref: "#/paths/~1deleteapp/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_app: - operation: - $ref: "#/paths/~1describeapp/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - list_apps: - operation: - $ref: "#/paths/~1listapps/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/apps/methods/describe_app" - - $ref: "#/components/x-stackQL-resources/apps/methods/list_apps" - insert: [] - update: [] - delete: - - $ref: "#/components/x-stackQL-resources/apps/methods/delete_app" - simulations: - id: aws.simspaceweaver.simulations - name: simulations - title: simulations - methods: - delete_simulation: - operation: - $ref: "#/paths/~1deletesimulation/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - describe_simulation: - operation: - $ref: "#/paths/~1describesimulation/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - list_simulations: - operation: - $ref: "#/paths/~1listsimulations/get" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/simulations/methods/describe_simulation" - - $ref: "#/components/x-stackQL-resources/simulations/methods/list_simulations" - insert: [] - update: [] - delete: - - $ref: "#/components/x-stackQL-resources/simulations/methods/delete_simulation" - tags: - id: aws.simspaceweaver.tags - name: tags - title: tags - methods: - list_tags_for_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/get" - response: - openAPIDocKey: "200" - mediaType: application/json - tag_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/post" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - config: - requestBodyTranslate: - algorithm: naive - untag_resource: - operation: - $ref: "#/paths/~1tags~1{resource_arn}/delete" - response: - openAPIDocKey: "200" - mediaType: application/json - request: - nativeCasing: pascal - sqlVerbs: - select: - - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" - insert: [] - update: - - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" - - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - delete: [] diff --git a/providers/src/aws/v00.00.00000/services/socialmessaging.yaml b/providers/src/aws/v00.00.00000/services/socialmessaging.yaml index 85a7c0e6..6b5bca55 100644 --- a/providers/src/aws/v00.00.00000/services/socialmessaging.yaml +++ b/providers/src/aws/v00.00.00000/services/socialmessaging.yaml @@ -39,6 +39,64 @@ paths: application/json: schema: $ref: "#/components/schemas/AssociateWhatsAppBusinessAccountOutput" + /v1/whatsapp/waba/dataset: + post: + operationId: CreateWhatsAppDataset + description: Creates a Meta Conversions API dataset for a WhatsApp Business Account. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + required: + - id + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateWhatsAppDatasetOutput" + /v1/whatsapp/flow/create: + post: + operationId: CreateWhatsAppFlow + description: Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish is set to true and a valid flowJson is provided, the Flow is published immediately. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + flowName: + $ref: "#/components/schemas/MetaFlowName" + categories: + $ref: "#/components/schemas/MetaFlowCategoryList" + flowJson: + $ref: "#/components/schemas/MetaFlowJsonBlob" + publish: + $ref: "#/components/schemas/Boolean" + cloneFlowId: + $ref: "#/components/schemas/MetaFlowId" + required: + - id + - flowName + - categories + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateWhatsAppFlowOutput" /v1/whatsapp/template/put: post: operationId: CreateWhatsAppMessageTemplate @@ -116,6 +174,53 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateWhatsAppMessageTemplateMediaOutput" + /v1/whatsapp/flow: + delete: + operationId: DeleteWhatsAppFlow + description: Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted. + parameters: + - name: id + in: query + required: true + schema: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + description: The ID of the WhatsApp Business Account associated with this Flow. + - name: flowId + in: query + required: true + schema: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteWhatsAppFlowOutput" + get: + operationId: GetWhatsAppFlow + description: Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status. + parameters: + - name: id + in: query + required: true + schema: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + description: The ID of the WhatsApp Business Account associated with this Flow. + - name: flowId + in: query + required: true + schema: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetWhatsAppFlowOutput" /v1/whatsapp/media: delete: operationId: DeleteWhatsAppMessageMedia @@ -273,6 +378,32 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateWhatsAppMessageTemplateOutput" + /v1/whatsapp/flow/deprecate: + post: + operationId: DeprecateWhatsAppFlow + description: Deprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + flowId: + $ref: "#/components/schemas/MetaFlowId" + required: + - id + - flowId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeprecateWhatsAppFlowOutput" /v1/whatsapp/waba/disassociate: delete: operationId: DisassociateWhatsAppBusinessAccount @@ -327,6 +458,36 @@ paths: application/json: schema: $ref: "#/components/schemas/GetLinkedWhatsAppBusinessAccountPhoneNumberOutput" + /v1/whatsapp/flow/preview: + get: + operationId: GetWhatsAppFlowPreview + description: Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review. + parameters: + - name: id + in: query + required: true + schema: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + description: The ID of the WhatsApp Business Account associated with this Flow. + - name: flowId + in: query + required: true + schema: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow to preview. + - name: invalidate + in: query + required: false + schema: + $ref: "#/components/schemas/Boolean" + description: Set to true to force generation of a new preview URL. Use this if the previous URL has been compromised or you want a fresh expiration period. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetWhatsAppFlowPreviewOutput" /v1/whatsapp/media/get: post: operationId: GetWhatsAppMessageMedia @@ -401,6 +562,72 @@ paths: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceOutput" + /v1/whatsapp/flow/assets: + get: + operationId: ListWhatsAppFlowAssets + description: Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period. + parameters: + - name: id + in: query + required: true + schema: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + description: The ID of the WhatsApp Business Account associated with this Flow. + - name: flowId + in: query + required: true + schema: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow whose assets to list. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return per page. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListWhatsAppFlowAssetsOutput" + /v1/whatsapp/flow/list: + get: + operationId: ListWhatsAppFlows + description: Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories. + parameters: + - name: id + in: query + required: true + schema: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + description: The ID of the WhatsApp Business Account to list Flows for. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return per page. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListWhatsAppFlowsOutput" /v1/whatsapp/template/list: get: operationId: ListWhatsAppMessageTemplates @@ -462,6 +689,32 @@ paths: application/json: schema: $ref: "#/components/schemas/ListWhatsAppTemplateLibraryOutput" + /v1/whatsapp/flow/publish: + post: + operationId: PublishWhatsAppFlow + description: Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + flowId: + $ref: "#/components/schemas/MetaFlowId" + required: + - id + - flowId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PublishWhatsAppFlowOutput" /v1/whatsapp/waba/eventdestinations: put: operationId: PutWhatsAppBusinessAccountEventDestinations @@ -488,6 +741,35 @@ paths: application/json: schema: $ref: "#/components/schemas/PutWhatsAppBusinessAccountEventDestinationsOutput" + /v1/whatsapp/waba/dataset/events: + post: + operationId: SendWhatsAppConversionEvent + description: Sends a conversion event to Meta's Conversions API for the specified WhatsApp Business Account dataset. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + datasetId: + $ref: "#/components/schemas/WhatsAppDatasetId" + eventData: + $ref: "#/components/schemas/WhatsAppConversionEventBlob" + required: + - id + - datasetId + - eventData + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SendWhatsAppConversionEventOutput" /v1/whatsapp/send: post: operationId: SendWhatsAppMessage @@ -569,6 +851,65 @@ paths: application/json: schema: $ref: "#/components/schemas/UntagResourceOutput" + /v1/whatsapp/flow/update: + post: + operationId: UpdateWhatsAppFlow + description: Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + flowId: + $ref: "#/components/schemas/MetaFlowId" + flowName: + $ref: "#/components/schemas/MetaFlowName" + categories: + $ref: "#/components/schemas/MetaFlowCategoryList" + required: + - id + - flowId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateWhatsAppFlowOutput" + /v1/whatsapp/flow/assets/update: + post: + operationId: UpdateWhatsAppFlowAssets + description: Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + $ref: "#/components/schemas/LinkedWhatsAppBusinessAccountId" + flowId: + $ref: "#/components/schemas/MetaFlowId" + flowJson: + $ref: "#/components/schemas/MetaFlowJsonBlob" + required: + - id + - flowId + - flowJson + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateWhatsAppFlowAssetsOutput" components: parameters: X-Amz-Content-Sha256: @@ -786,6 +1127,69 @@ components: description: A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup. Integer: type: integer + CreateWhatsAppDatasetOutput: + type: object + properties: + datasetId: + $ref: "#/components/schemas/WhatsAppDatasetId" + description: The Meta-generated dataset ID, a numeric string of 10 to 20 digits. + required: + - datasetId + WhatsAppDatasetId: + type: string + minLength: 10 + maxLength: 20 + pattern: "[0-9]+" + MetaFlowName: + type: string + minLength: 1 + maxLength: 200 + MetaFlowCategoryList: + type: array + items: + $ref: "#/components/schemas/MetaFlowCategory" + MetaFlowCategory: + description: The category that classifies the business purpose of a WhatsApp Flow. + type: string + enum: + - SIGN_UP + - SIGN_IN + - APPOINTMENT_BOOKING + - LEAD_GENERATION + - SHOPPING + - CONTACT_US + - CUSTOMER_SUPPORT + - SURVEY + - OTHER + MetaFlowJsonBlob: + type: string + format: byte + minLength: 1 + maxLength: 10485760 + Boolean: + type: boolean + MetaFlowId: + type: string + minLength: 1 + maxLength: 100 + pattern: "[0-9]+" + CreateWhatsAppFlowOutput: + type: object + properties: + flowId: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier assigned to the Flow by Meta. + validationErrors: + $ref: "#/components/schemas/ValidationErrorList" + description: A list of validation errors returned by Meta, if any. Validation errors must be resolved before the Flow can be published. + ValidationErrorList: + type: array + items: + $ref: "#/components/schemas/MetaFlowValidationError" + MetaFlowValidationError: + type: string + minLength: 0 + maxLength: 1048576 MetaTemplateDefinition: type: string format: byte @@ -966,6 +1370,8 @@ components: metaHeaderHandle: $ref: "#/components/schemas/String" description: The handle assigned to the uploaded media by Meta, used to reference the media in templates. + DeleteWhatsAppFlowOutput: + type: object WhatsAppMediaId: type: string minLength: 1 @@ -982,12 +1388,12 @@ components: success: $ref: "#/components/schemas/Boolean" description: Success indicator for deleting the media file. - Boolean: - type: boolean DeleteAllLanguages: type: boolean DeleteWhatsAppMessageTemplateOutput: type: object + DeprecateWhatsAppFlowOutput: + type: object DisassociateWhatsAppBusinessAccountOutput: type: object GetLinkedWhatsAppBusinessAccountOutput: @@ -1024,6 +1430,9 @@ components: marketingMessagesOnboardingStatus: $ref: "#/components/schemas/WhatsAppBusinessAccountMarketingMessagesOnboardingStatus" description: The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API. + datasetId: + $ref: "#/components/schemas/WhatsAppDatasetId" + description: The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account. phoneNumbers: $ref: "#/components/schemas/WhatsAppPhoneNumberSummaryList" description: The phone numbers associated with the Linked WhatsApp Business Account. @@ -1158,6 +1567,201 @@ components: - displayPhoneNumberName - displayPhoneNumber - qualityRating + GetWhatsAppFlowOutput: + type: object + properties: + flowId: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow. + flowName: + $ref: "#/components/schemas/MetaFlowName" + description: The name of the Flow. + flowStatus: + $ref: "#/components/schemas/MetaFlowStatus" + description: The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED. + categories: + $ref: "#/components/schemas/MetaFlowCategoryList" + description: The categories that classify the business purpose of the Flow. + validationErrors: + $ref: "#/components/schemas/ValidationErrorList" + description: A list of validation errors from Meta, if any. + jsonVersion: + $ref: "#/components/schemas/MetaFlowJsonVersion" + description: The version of the Flow JSON schema used by this Flow (for example, 7.3). + dataApiVersion: + $ref: "#/components/schemas/MetaFlowDataApiVersion" + description: The data API version for data exchange endpoint Flows. + endpointUri: + $ref: "#/components/schemas/MetaFlowEndpointUri" + description: The endpoint URI for data exchange Flows, if configured. + preview: + $ref: "#/components/schemas/MetaFlowPreviewInfo" + description: The preview URL and its expiration timestamp for testing the Flow. + whatsAppBusinessAccount: + $ref: "#/components/schemas/MetaFlowWhatsAppBusinessAccountInfo" + description: The WhatsApp Business Account information from Meta associated with this Flow. + application: + $ref: "#/components/schemas/MetaFlowApplicationInfo" + description: The Meta application information associated with this Flow. + healthStatus: + $ref: "#/components/schemas/MetaFlowHealthStatus" + description: The health status information for this Flow from Meta. + required: + - flowId + - flowName + - flowStatus + MetaFlowStatus: + type: string + minLength: 1 + maxLength: 20 + MetaFlowJsonVersion: + type: string + minLength: 1 + maxLength: 10 + MetaFlowDataApiVersion: + type: string + minLength: 1 + maxLength: 10 + MetaFlowEndpointUri: + type: string + minLength: 1 + maxLength: 2048 + MetaFlowPreviewInfo: + description: Contains the preview URL for testing a WhatsApp Flow and its expiration timestamp. + type: object + properties: + previewUrl: + $ref: "#/components/schemas/MetaFlowPreviewUrl" + description: The web URL for previewing the Flow. Can be shared with stakeholders for review. + expiresAt: + $ref: "#/components/schemas/MetaFlowTimestamp" + description: The timestamp when the preview URL expires. + required: + - previewUrl + - expiresAt + MetaFlowPreviewUrl: + type: string + minLength: 1 + maxLength: 2048 + MetaFlowTimestamp: + type: string + minLength: 1 + maxLength: 50 + MetaFlowWhatsAppBusinessAccountInfo: + description: Contains WhatsApp Business Account metadata associated with a Flow, as returned by Meta. + type: object + properties: + id: + $ref: "#/components/schemas/WhatsAppBusinessAccountId" + description: The WhatsApp Business Account ID from Meta. + name: + $ref: "#/components/schemas/WhatsAppBusinessAccountName" + description: The name of the WhatsApp Business Account. + currency: + $ref: "#/components/schemas/MetaFlowWabaCurrency" + description: The currency code for the WhatsApp Business Account (for example, USD). + timezoneId: + $ref: "#/components/schemas/MetaFlowWabaTimezoneId" + description: The timezone ID for the WhatsApp Business Account. + messageTemplateNamespace: + $ref: "#/components/schemas/MetaFlowWabaTemplateNamespace" + description: The message template namespace for the WhatsApp Business Account. + required: + - id + - name + MetaFlowWabaCurrency: + type: string + minLength: 1 + maxLength: 10 + MetaFlowWabaTimezoneId: + type: string + minLength: 1 + maxLength: 10 + MetaFlowWabaTemplateNamespace: + type: string + minLength: 1 + maxLength: 200 + MetaFlowApplicationInfo: + description: Contains the Meta application metadata associated with a WhatsApp Flow. + type: object + properties: + link: + $ref: "#/components/schemas/MetaFlowApplicationLink" + description: The URL link for the Meta application. + name: + $ref: "#/components/schemas/MetaFlowApplicationName" + description: The name of the Meta application. + id: + $ref: "#/components/schemas/MetaFlowApplicationId" + description: The unique identifier of the Meta application. + required: + - name + - id + MetaFlowApplicationLink: + type: string + minLength: 1 + maxLength: 2048 + MetaFlowApplicationName: + type: string + minLength: 1 + maxLength: 200 + MetaFlowApplicationId: + type: string + minLength: 1 + maxLength: 100 + MetaFlowHealthStatus: + description: Contains the overall health status and per-entity breakdown for a WhatsApp Flow. + type: object + properties: + canSendMessage: + $ref: "#/components/schemas/MetaFlowHealthStatusAvailability" + description: The overall messaging availability status (for example, AVAILABLE, LIMITED, or BLOCKED). + entities: + $ref: "#/components/schemas/MetaFlowHealthEntityList" + description: A list of health status entities with per-entity availability information. + required: + - canSendMessage + MetaFlowHealthStatusAvailability: + type: string + minLength: 1 + maxLength: 50 + MetaFlowHealthEntityList: + type: array + items: + $ref: "#/components/schemas/MetaFlowHealthEntity" + MetaFlowHealthEntity: + description: Represents a single entity in the health status check for a WhatsApp Flow. + type: object + properties: + entityType: + $ref: "#/components/schemas/MetaFlowHealthEntityType" + description: The type of entity (for example, FLOW, WABA, BUSINESS, or APP). + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the entity. + canSendMessage: + $ref: "#/components/schemas/MetaFlowHealthStatusAvailability" + description: The messaging availability status for this entity (for example, AVAILABLE, LIMITED, or BLOCKED). + required: + - entityType + - id + - canSendMessage + MetaFlowHealthEntityType: + type: string + minLength: 1 + maxLength: 50 + GetWhatsAppFlowPreviewOutput: + type: object + properties: + flowId: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow. + preview: + $ref: "#/components/schemas/MetaFlowPreviewInfo" + description: The preview URL and its expiration timestamp. + required: + - flowId + - preview S3PresignedUrl: description: You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3 User Guide. type: object @@ -1248,6 +1852,9 @@ components: marketingMessagesOnboardingStatus: $ref: "#/components/schemas/WhatsAppBusinessAccountMarketingMessagesOnboardingStatus" description: The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API. + datasetId: + $ref: "#/components/schemas/WhatsAppDatasetId" + description: The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account. required: - arn - id @@ -1270,6 +1877,90 @@ components: tags: $ref: "#/components/schemas/TagList" description: The tags for the resource. + ListWhatsAppFlowAssetsOutput: + type: object + properties: + flowAssets: + $ref: "#/components/schemas/MetaFlowAssetList" + description: A list of Flow assets with download URLs. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token to retrieve the next page of results, if any. + required: + - flowAssets + MetaFlowAssetList: + type: array + items: + $ref: "#/components/schemas/MetaFlowAsset" + MetaFlowAsset: + description: Represents a single asset file associated with a WhatsApp Flow, including a presigned download URL. + type: object + properties: + name: + $ref: "#/components/schemas/MetaFlowAssetName" + description: The filename of the asset (for example, flow.json). + assetType: + $ref: "#/components/schemas/MetaFlowAssetType" + description: The type of asset. Currently the only supported value is FLOW_JSON. + downloadUrl: + $ref: "#/components/schemas/MetaFlowAssetDownloadUrl" + description: A presigned URL from Meta for downloading the asset. The URL expires after a short period. + required: + - name + - assetType + - downloadUrl + MetaFlowAssetName: + type: string + minLength: 1 + maxLength: 100 + MetaFlowAssetType: + type: string + minLength: 1 + maxLength: 50 + MetaFlowAssetDownloadUrl: + type: string + minLength: 1 + maxLength: 2048 + ListWhatsAppFlowsOutput: + type: object + properties: + flows: + $ref: "#/components/schemas/MetaFlowSummaryList" + description: A list of Flow summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token to retrieve the next page of results, if any. + required: + - flows + MetaFlowSummaryList: + type: array + items: + $ref: "#/components/schemas/MetaFlowSummary" + MetaFlowSummary: + description: Contains summary information about a WhatsApp Flow, including its ID, name, status, and categories. + type: object + properties: + flowId: + $ref: "#/components/schemas/MetaFlowId" + description: The unique identifier of the Flow assigned by Meta. + flowName: + $ref: "#/components/schemas/MetaFlowName" + description: The name of the Flow. + flowStatus: + $ref: "#/components/schemas/MetaFlowStatus" + description: The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED). + flowCategories: + $ref: "#/components/schemas/MetaFlowCategoryList" + description: The categories that classify the business purpose of the Flow. + validationErrors: + $ref: "#/components/schemas/ValidationErrorList" + description: A list of validation errors from Meta, if any. + required: + - flowId + - flowName + - flowStatus + - flowCategories + - validationErrors ListWhatsAppMessageTemplatesOutput: type: object properties: @@ -1437,8 +2128,23 @@ components: mediaId: $ref: "#/components/schemas/WhatsAppMediaId" description: The unique identifier of the posted WhatsApp message. + PublishWhatsAppFlowOutput: + type: object PutWhatsAppBusinessAccountEventDestinationsOutput: type: object + WhatsAppConversionEventBlob: + type: string + format: byte + minLength: 1 + maxLength: 1024000 + SendWhatsAppConversionEventOutput: + type: object + properties: + requestId: + $ref: "#/components/schemas/String" + description: The unique identifier for the conversion event request. + required: + - requestId WhatsAppMessageBlob: type: string format: byte @@ -1466,6 +2172,14 @@ components: statusCode: $ref: "#/components/schemas/Integer" description: The status code of the untag resource operation. + UpdateWhatsAppFlowOutput: + type: object + UpdateWhatsAppFlowAssetsOutput: + type: object + properties: + validationErrors: + $ref: "#/components/schemas/ValidationErrorList" + description: A list of validation errors returned by Meta, if any. Validation errors must be resolved before the Flow can be published. MetaParameterFormat: type: string minLength: 1 @@ -1511,6 +2225,98 @@ components: - $ref: "#/components/x-stackQL-resources/whats_app_business_accounts/methods/disassociate_whats_app_business_account" - $ref: "#/components/x-stackQL-resources/whats_app_business_accounts/methods/associate_whats_app_business_account" delete: [] + whats_app_datasets: + id: aws.socialmessaging.whats_app_datasets + name: whats_app_datasets + title: whats_app_datasets + methods: + create_whats_app_dataset: + operation: + $ref: "#/paths/~1v1~1whatsapp~1waba~1dataset/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: [] + insert: + - $ref: "#/components/x-stackQL-resources/whats_app_datasets/methods/create_whats_app_dataset" + update: [] + delete: [] + whats_app_flows: + id: aws.socialmessaging.whats_app_flows + name: whats_app_flows + title: whats_app_flows + methods: + create_whats_app_flow: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1create/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + delete_whats_app_flow: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + get_whats_app_flow: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + list_whats_app_flows: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1list/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.flows + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_whats_app_flow: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1update/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/whats_app_flows/methods/get_whats_app_flow" + - $ref: "#/components/x-stackQL-resources/whats_app_flows/methods/list_whats_app_flows" + insert: + - $ref: "#/components/x-stackQL-resources/whats_app_flows/methods/create_whats_app_flow" + update: + - $ref: "#/components/x-stackQL-resources/whats_app_flows/methods/update_whats_app_flow" + delete: + - $ref: "#/components/x-stackQL-resources/whats_app_flows/methods/delete_whats_app_flow" whats_app_message_templates: id: aws.socialmessaging.whats_app_message_templates name: whats_app_message_templates @@ -1690,6 +2496,25 @@ components: insert: [] update: [] delete: [] + whats_app_flow_previews: + id: aws.socialmessaging.whats_app_flow_previews + name: whats_app_flow_previews + title: whats_app_flow_previews + methods: + get_whats_app_flow_preview: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1preview/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/whats_app_flow_previews/methods/get_whats_app_flow_preview" + insert: [] + update: [] + delete: [] tags: id: aws.socialmessaging.tags name: tags @@ -1733,6 +2558,46 @@ components: - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" delete: [] + whats_app_flow_assets: + id: aws.socialmessaging.whats_app_flow_assets + name: whats_app_flow_assets + title: whats_app_flow_assets + methods: + list_whats_app_flow_assets: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1assets/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.flowAssets + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + update_whats_app_flow_assets: + operation: + $ref: "#/paths/~1v1~1whatsapp~1flow~1assets~1update/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/whats_app_flow_assets/methods/list_whats_app_flow_assets" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/whats_app_flow_assets/methods/update_whats_app_flow_assets" + delete: [] whats_app_template_libraries: id: aws.socialmessaging.whats_app_template_libraries name: whats_app_template_libraries diff --git a/providers/src/aws/v00.00.00000/services/ssm.yaml b/providers/src/aws/v00.00.00000/services/ssm.yaml index bd1843fa..c58613c5 100644 --- a/providers/src/aws/v00.00.00000/services/ssm.yaml +++ b/providers/src/aws/v00.00.00000/services/ssm.yaml @@ -292,7 +292,7 @@ paths: description: The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide. TargetLocations: $ref: "#/components/schemas/TargetLocations" - description: A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts. The IncludeChildOrganizationUnits parameter is not supported by State Manager. + description: A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts. The TargetLocationAlarmConfiguration parameter is not supported by State Manager. ScheduleOffset: $ref: "#/components/schemas/ScheduleOffset" description: "Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide. To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it." @@ -353,6 +353,56 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateAssociationBatchResult" + /CreateCloudConnector: + post: + operationId: CreateCloudConnector + description: Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.CreateCloudConnector + default: AmazonSSM.CreateCloudConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + DisplayName: + $ref: "#/components/schemas/DisplayName" + description: A friendly name for the cloud connector. + RoleArn: + $ref: "#/components/schemas/CloudConnectorIamRoleArn" + description: The Amazon Resource Name (ARN) of the IAM role that the cloud connector uses to communicate with the third-party cloud environment. + Description: + $ref: "#/components/schemas/CloudConnectorDescription" + description: A description for the cloud connector. + Configuration: + $ref: "#/components/schemas/CloudConnectorConfiguration" + description: The configuration details for connecting to the third-party cloud environment. + ConfigConnectorArn: + $ref: "#/components/schemas/ConfigConnectorArn" + description: The ARN of the Amazon Web Services Config connector associated with this cloud connector. + Tags: + $ref: "#/components/schemas/TagList" + description: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. + required: + - DisplayName + - RoleArn + - ConfigConnectorArn + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCloudConnectorResult" /CreateDocument: post: operationId: CreateDocument @@ -776,6 +826,39 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteAssociationResult" + /DeleteCloudConnector: + post: + operationId: DeleteCloudConnector + description: Deletes a cloud connector. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.DeleteCloudConnector + default: AmazonSSM.DeleteCloudConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector to delete. + required: + - CloudConnectorId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteCloudConnectorResult" /DeleteDocument: post: operationId: DeleteDocument @@ -2754,6 +2837,39 @@ paths: application/json: schema: $ref: "#/components/schemas/GetCalendarStateResponse" + /GetCloudConnector: + post: + operationId: GetCloudConnector + description: Returns detailed information about a cloud connector. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.GetCloudConnector + default: AmazonSSM.GetCloudConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector to retrieve information about. + required: + - CloudConnectorId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetCloudConnectorResult" /GetCommandInvocation: post: operationId: GetCommandInvocation @@ -3363,7 +3479,7 @@ paths: /GetParameter: post: operationId: GetParameter - description: Get information about a single parameter by specifying the parameter name. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. To get information about more than one parameter at a time, use the GetParameters operation. + description: "Get information about a single parameter by specifying the parameter name. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. To get information about more than one parameter at a time, use the GetParameters operation. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput." parameters: - name: X-Amz-Target in: header @@ -3437,7 +3553,7 @@ paths: /GetParameters: post: operationId: GetParameters - description: Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. + description: "Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput." parameters: - name: X-Amz-Target in: header @@ -3577,7 +3693,7 @@ paths: description: The name of the patch group whose patch baseline should be retrieved. OperatingSystem: $ref: "#/components/schemas/OperatingSystem" - description: Returns the operating system rule specified for patch groups using the patch baseline. + description: Returns the operating system rule specified for patch groups using the patch baseline. The default value is WINDOWS. required: - PatchGroup responses: @@ -3775,6 +3891,43 @@ paths: application/json: schema: $ref: "#/components/schemas/ListAssociationsResult" + /ListCloudConnectors: + post: + operationId: ListCloudConnectors + description: Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.ListCloudConnectors + default: AmazonSSM.ListCloudConnectors + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + MaxResults: + $ref: "#/components/schemas/CloudConnectorMaxResults" + description: The maximum number of items to return for this call. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of items to return. (You received this token from a previous call.) + Filters: + $ref: "#/components/schemas/CloudConnectorFilterList" + description: One or more filters to limit the cloud connectors returned in the response. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListCloudConnectorsResult" /ListCommandInvocations: post: operationId: ListCommandInvocations @@ -4561,7 +4714,7 @@ paths: /PutParameter: post: operationId: PutParameter - description: Create or update a parameter in Parameter Store. + description: "Create or update a parameter in Parameter Store. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput." parameters: - name: X-Amz-Target in: header @@ -5210,7 +5363,7 @@ paths: $ref: "#/components/schemas/AutomationParameterKey" description: The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets. Targets: - $ref: "#/components/schemas/Targets" + $ref: "#/components/schemas/AutomationTargets" description: A key-value mapping to target resources. Required if you specify TargetParameterName. If both this parameter and the TargetLocation:Targets parameter are supplied, TargetLocation:Targets takes precedence. TargetMaps: $ref: "#/components/schemas/TargetMaps" @@ -5568,7 +5721,7 @@ paths: description: The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide. TargetLocations: $ref: "#/components/schemas/TargetLocations" - description: A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts. The IncludeChildOrganizationUnits parameter is not supported by State Manager. + description: A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts. The TargetLocationAlarmConfiguration parameter is not supported by State Manager. ScheduleOffset: $ref: "#/components/schemas/ScheduleOffset" description: "Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide. To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it." @@ -5632,6 +5785,48 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateAssociationStatusResult" + /UpdateCloudConnector: + post: + operationId: UpdateCloudConnector + description: Updates an existing cloud connector with new configuration details. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.UpdateCloudConnector + default: AmazonSSM.UpdateCloudConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector to update. + DisplayName: + $ref: "#/components/schemas/DisplayName" + description: A new friendly name for the cloud connector. + Configuration: + $ref: "#/components/schemas/CloudConnectorConfiguration" + description: The updated configuration details for connecting to the third-party cloud environment. + Description: + $ref: "#/components/schemas/CloudConnectorDescription" + description: A new description for the cloud connector. + required: + - CloudConnectorId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateCloudConnectorResult" /UpdateDocument: post: operationId: UpdateDocument @@ -6260,6 +6455,45 @@ paths: application/json: schema: $ref: "#/components/schemas/UpdateServiceSettingResult" + /ValidateCloudConnector: + post: + operationId: ValidateCloudConnector + description: Validates the configuration and connectivity of a cloud connector. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonSSM.ValidateCloudConnector + default: AmazonSSM.ValidateCloudConnector + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector to validate. + MaxResults: + $ref: "#/components/schemas/ValidateCloudConnectorMaxResults" + description: The maximum number of validation findings to return. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next set of items to return. (You received this token from a previous call.) + required: + - CloudConnectorId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ValidateCloudConnectorResult" components: parameters: X-Amz-Content-Sha256: @@ -6317,6 +6551,7 @@ components: - OpsMetadata - Automation - Association + - CloudConnector ResourceId: type: string TagList: @@ -6586,12 +6821,12 @@ components: $ref: "#/components/schemas/AlarmConfiguration" IncludeChildOrganizationUnits: $ref: "#/components/schemas/Boolean" - description: Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false. This parameter is not supported by State Manager. + description: Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false. ExcludeAccounts: $ref: "#/components/schemas/ExcludeAccounts" description: Amazon Web Services accounts or organizational units to exclude as expanded targets. Targets: - $ref: "#/components/schemas/Targets" + $ref: "#/components/schemas/AutomationTargets" description: A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName. This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied. TargetsMaxConcurrency: $ref: "#/components/schemas/MaxConcurrency" @@ -6657,6 +6892,10 @@ components: minLength: 6 maxLength: 68 pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32})|(\d{12})$ + AutomationTargets: + type: array + items: + $ref: "#/components/schemas/Target" ScheduleOffset: type: integer minimum: 1 @@ -6965,6 +7204,119 @@ components: - Client - Server - Unknown + DisplayName: + type: string + minLength: 1 + maxLength: 256 + pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$ + CloudConnectorIamRoleArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role\/[\w-\/.@+=,]{1,1017}$ + CloudConnectorDescription: + type: string + minLength: 0 + maxLength: 1024 + pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$ + CloudConnectorConfiguration: + description: The configuration that provides access details and targets for connecting to a third-party cloud environment. + type: object + properties: + AzureConfiguration: + $ref: "#/components/schemas/AzureConfiguration" + description: The access details and targets for connecting to a Microsoft Azure environment. + AzureConfiguration: + description: The access details and targets for connecting to a Microsoft Azure tenant, including the application registration used for authentication and the subscriptions to target. + type: object + properties: + TenantId: + $ref: "#/components/schemas/AzureTenantId" + description: The ID of the Azure tenant. + TenantDisplayName: + $ref: "#/components/schemas/AzureTenantDisplayName" + description: The display name of the Azure tenant. + ApplicationId: + $ref: "#/components/schemas/AzureApplicationId" + description: The ID of the Azure application registration used for authentication. + ApplicationDisplayName: + $ref: "#/components/schemas/AzureApplicationDisplayName" + description: The display name of the Azure application registration. + Targets: + $ref: "#/components/schemas/ConfigurationTargets" + description: The target Azure subscriptions for the cloud connector. + required: + - TenantId + - ApplicationId + AzureTenantId: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + AzureTenantDisplayName: + type: string + minLength: 0 + maxLength: 256 + pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$ + AzureApplicationId: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + AzureApplicationDisplayName: + type: string + minLength: 0 + maxLength: 256 + pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$ + ConfigurationTargets: + description: The target resources in the third-party cloud environment. + type: object + properties: + Subscriptions: + $ref: "#/components/schemas/AzureSubscriptionList" + description: A list of Azure subscriptions to target. + AzureSubscriptionList: + type: array + items: + $ref: "#/components/schemas/AzureSubscription" + AzureSubscription: + description: Information about an Azure subscription targeted by the cloud connector. + type: object + properties: + Id: + $ref: "#/components/schemas/AzureSubscriptionId" + description: The ID of the Azure subscription. + DisplayName: + $ref: "#/components/schemas/AzureSubscriptionDisplayName" + description: The display name of the Azure subscription. + required: + - Id + AzureSubscriptionId: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + AzureSubscriptionDisplayName: + type: string + minLength: 0 + maxLength: 128 + pattern: ^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$ + ConfigConnectorArn: + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:aws(-cn|-us-gov)?:config:([^:]+):\d{12}:connector/.+$ + CreateCloudConnectorResult: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector that was created. + CloudConnectorId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ DocumentContent: type: string minLength: 1 @@ -7538,7 +7890,7 @@ components: description: A compliance severity level for all approved patches in a patch baseline. ApproveAfterDays: $ref: "#/components/schemas/ApproveAfterDays" - description: "The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If the day represented by 7 is 2025-11-16, patches released between 2025-11-16T00:00:00Z and 2025-11-16T23:59:59Z will be included in the approval. This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate. Not supported for Debian Server or Ubuntu Server. Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide." + description: "The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If a patch is released at 2025-11-09T18:00:00Z and ApproveAfterDays is set to 7, the patch will be approved after 2025-11-16T18:00:00Z. This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate. Not supported for Debian Server or Ubuntu Server. Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide." ApproveUntilDate: $ref: "#/components/schemas/PatchStringDateTime" description: "The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Enter dates in the format YYYY-MM-DD. For example, 2025-11-16. Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If you enter the date 2025-11-16, patches released between 2025-11-16T00:00:00Z and 2025-11-16T23:59:59Z will be included in the approval. This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays. Not supported for Debian Server or Ubuntu Server. Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide." @@ -7775,6 +8127,12 @@ components: type: object DeleteAssociationResult: type: object + DeleteCloudConnectorResult: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector that was deleted. DeleteDocumentResult: type: object InventoryItemTypeName: @@ -8309,7 +8667,10 @@ components: description: The action of the step that is currently running. FailureMessage: $ref: "#/components/schemas/String" - description: The list of execution outputs as defined in the Automation runbook. + description: A message that describes a failure that occurred during the automation execution. + WarningMessage: + $ref: "#/components/schemas/String" + description: A message that describes a non-critical issue that occurred during the automation execution. TargetParameterName: $ref: "#/components/schemas/AutomationParameterKey" description: The list of execution outputs as defined in the Automation runbook. @@ -8562,6 +8923,9 @@ components: FailureMessage: $ref: "#/components/schemas/String" description: If a step failed, this message explains why the execution failed. + WarningMessage: + $ref: "#/components/schemas/String" + description: A message that describes a non-critical issue that occurred during the step execution. Present only if the step status includes a warning. FailureDetails: $ref: "#/components/schemas/FailureDetails" description: Information about the Automation failure. @@ -9065,7 +9429,7 @@ components: properties: Key: $ref: "#/components/schemas/InstanceInformationStringFilterKey" - description: 'The filter key name to describe your managed nodes. Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformType | ResourceType | SourceIds | SourceTypes | "tag-key" | "tag:{keyname} Valid values for the AssociationStatus filter key: Success | Pending | Failed Valid values for the PingStatus filter key: Online | ConnectionLost | Inactive (deprecated) Valid values for the PlatformType filter key: Windows | Linux | MacOS Valid values for the ResourceType filter key: EC2Instance | ManagedInstance Valid values for the SourceType filter key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test.' + description: 'The filter key name to describe your managed nodes. Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key" | "tag:{keyname} Valid values for the AssociationStatus filter key: Success | Pending | Failed Valid values for the PingStatus filter key: Online | ConnectionLost | Inactive (deprecated) Valid values for the PlatformTypes filter key: Windows | Linux | MacOS Valid values for the ResourceType filter key: EC2Instance | ManagedInstance Valid values for the SourceType filter key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test.' Values: $ref: "#/components/schemas/InstanceInformationFilterValueSet" description: The filter values. @@ -9158,7 +9522,10 @@ components: description: The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name. SourceType: $ref: "#/components/schemas/SourceType" - description: The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. + description: The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines. + SourceLocation: + $ref: "#/components/schemas/SourceLocation" + description: The location of the source resource in the third-party cloud environment. PingStatus: type: string enum: @@ -9203,6 +9570,12 @@ components: - AWS::EC2::Instance - AWS::IoT::Thing - AWS::SSM::ManagedInstance + - Microsoft.Compute/virtualMachines + SourceLocation: + type: string + minLength: 1 + maxLength: 128 + pattern: ^.{1,128}$ PatchComplianceMaxResults: type: integer minimum: 10 @@ -9625,7 +9998,13 @@ components: description: The ID of the source resource. SourceType: $ref: "#/components/schemas/SourceType" - description: The type of the source resource. + description: "The type of the source resource. Valid values: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines." + SourceLocation: + $ref: "#/components/schemas/SourceLocation" + description: The location of the source resource in the third-party cloud environment. + AvailabilityZone: + $ref: "#/components/schemas/AvailabilityZone" + description: The Availability Zone where the managed node is located. InstanceName: type: string maxLength: 255 @@ -9650,6 +10029,9 @@ components: PlatformVersion: type: string maxLength: 120 + AvailabilityZone: + type: string + maxLength: 120 DescribeInventoryDeletionsResult: type: object properties: @@ -10006,7 +10388,7 @@ components: description: The task ID. TaskArn: $ref: "#/components/schemas/MaintenanceWindowTaskArn" - description: The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN. + description: The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN. Maintenance Window does not validate the TaskArn when you register a task. A successful registration does not guarantee that the TaskArn is valid. Type: $ref: "#/components/schemas/MaintenanceWindowTaskType" description: The type of task. @@ -10861,6 +11243,9 @@ components: FailureMessage: $ref: "#/components/schemas/String" description: A message describing why an execution has failed, if the status is set to Failed. + WarningMessage: + $ref: "#/components/schemas/String" + description: A message that describes a non-critical issue that occurred during the automation execution. Mode: $ref: "#/components/schemas/ExecutionMode" description: The automation execution mode. @@ -10972,6 +11357,38 @@ components: enum: - OPEN - CLOSED + GetCloudConnectorResult: + type: object + properties: + CloudConnectorArn: + $ref: "#/components/schemas/CloudConnectorArn" + description: The ARN of the cloud connector. + DisplayName: + $ref: "#/components/schemas/DisplayName" + description: The friendly name of the cloud connector. + Description: + $ref: "#/components/schemas/CloudConnectorDescription" + description: The description of the cloud connector. + RoleArn: + $ref: "#/components/schemas/CloudConnectorIamRoleArn" + description: The ARN of the IAM role used by the cloud connector. + Configuration: + $ref: "#/components/schemas/CloudConnectorConfiguration" + description: The configuration details for the third-party cloud environment connection. + ConfigConnectorArn: + $ref: "#/components/schemas/ConfigConnectorArn" + description: The ARN of the Amazon Web Services Config connector associated with this cloud connector. + CreatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time the cloud connector was created. + UpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time the cloud connector was last updated. + CloudConnectorArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws(-cn|-us-gov)?:ssm:([^:]+):\d{12}:cloud-connector/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ CommandPluginName: type: string minLength: 4 @@ -12451,6 +12868,7 @@ components: - LastExecutedAfter - AssociationName - ResourceGroupName + - CloudConnectorId AssociationFilterValue: type: string minLength: 1 @@ -12510,6 +12928,72 @@ components: TargetMaps: $ref: "#/components/schemas/TargetMaps" description: A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together. + CloudConnectorMaxResults: + type: integer + minimum: 0 + maximum: 10 + CloudConnectorFilterList: + type: array + items: + $ref: "#/components/schemas/CloudConnectorFilter" + CloudConnectorFilter: + description: A filter for listing cloud connectors. + type: object + properties: + FilterKey: + $ref: "#/components/schemas/CloudConnectorFilterKey" + description: The name of the filter key. + FilterValues: + $ref: "#/components/schemas/CloudConnectorFilterValues" + description: "The filter values. Valid values for each filter key are as follows: SubscriptionId The Azure subscription ID to filter by. To return only tenant-level connectors, specify NONE. TenantId The Azure tenant ID to filter by. Filters the results to connectors that target the specified tenant." + CloudConnectorFilterKey: + type: string + enum: + - SubscriptionId + - TenantId + CloudConnectorFilterValues: + type: array + items: + $ref: "#/components/schemas/CloudConnectorFilterValue" + CloudConnectorFilterValue: + type: string + minLength: 1 + maxLength: 256 + ListCloudConnectorsResult: + type: object + properties: + CloudConnectors: + $ref: "#/components/schemas/CloudConnectorSummaryList" + description: A list of cloud connector summary objects. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token to use when requesting the next set of items. + CloudConnectorSummaryList: + type: array + items: + $ref: "#/components/schemas/CloudConnectorSummary" + CloudConnectorSummary: + description: Summary information about a cloud connector. + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector. + DisplayName: + $ref: "#/components/schemas/DisplayName" + description: The friendly name of the cloud connector. + Description: + $ref: "#/components/schemas/CloudConnectorDescription" + description: The description of the cloud connector. + RoleArn: + $ref: "#/components/schemas/CloudConnectorIamRoleArn" + description: The ARN of the IAM role used by the cloud connector. + CreatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time the cloud connector was created. + UpdatedAt: + $ref: "#/components/schemas/DateTime" + description: The date and time the cloud connector was last updated. CommandMaxResults: type: integer minimum: 1 @@ -13301,6 +13785,11 @@ components: - OrganizationalUnitPath - Region - AccountId + - SourceType + - SourceId + - SourceLocation + - AvailabilityZone + - AvailabilityZoneId NodeFilterValueList: type: array items: @@ -13412,6 +13901,9 @@ components: ManagedStatus: $ref: "#/components/schemas/ManagedStatus" description: Indicates whether the node is managed by Systems Manager. + Name: + $ref: "#/components/schemas/NodeName" + description: The name assigned to the managed node. PlatformType: $ref: "#/components/schemas/PlatformType" description: The operating system platform type of the managed node. @@ -13424,6 +13916,21 @@ components: ResourceType: $ref: "#/components/schemas/ResourceType" description: The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet. + SourceType: + $ref: "#/components/schemas/SourceType" + description: The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. + SourceId: + $ref: "#/components/schemas/SourceId" + description: The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name. + SourceLocation: + $ref: "#/components/schemas/SourceLocation" + description: The location of the source resource in the third-party cloud environment. + AvailabilityZone: + $ref: "#/components/schemas/AvailabilityZone" + description: The Availability Zone where the managed node is located. + AvailabilityZoneId: + $ref: "#/components/schemas/AvailabilityZoneId" + description: The Availability Zone ID where the managed node is located. AgentType: type: string minLength: 1 @@ -13445,6 +13952,14 @@ components: - All - Managed - Unmanaged + NodeName: + type: string + minLength: 0 + maxLength: 256 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + AvailabilityZoneId: + type: string + maxLength: 50 NodeAggregatorList: type: array items: @@ -13486,6 +14001,8 @@ components: - PlatformVersion - Region - ResourceType + - SourceType + - AvailabilityZone ListNodesSummaryRowDisplay: type: object properties: @@ -14112,7 +14629,7 @@ components: $ref: "#/components/schemas/AutomationParameterKey" description: The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets. Targets: - $ref: "#/components/schemas/Targets" + $ref: "#/components/schemas/AutomationTargets" description: Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be specified together. TargetMaps: $ref: "#/components/schemas/TargetMaps" @@ -14178,6 +14695,12 @@ components: AssociationDescription: $ref: "#/components/schemas/AssociationDescription" description: Information about the association. + UpdateCloudConnectorResult: + type: object + properties: + CloudConnectorId: + $ref: "#/components/schemas/CloudConnectorId" + description: The ID of the cloud connector that was updated. UpdateDocumentResult: type: object properties: @@ -14412,6 +14935,75 @@ components: UpdateServiceSettingResult: description: The result body of the UpdateServiceSetting API operation. type: object + ValidateCloudConnectorMaxResults: + type: integer + minimum: 0 + maximum: 75 + ValidateCloudConnectorResult: + type: object + properties: + ValidationFindings: + $ref: "#/components/schemas/ValidationFindingList" + description: A list of validation findings for the cloud connector. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The token to use when requesting the next set of items. + ValidationFindingList: + type: array + items: + $ref: "#/components/schemas/ValidationFinding" + ValidationFinding: + description: A validation finding from a cloud connector validation check. + type: object + properties: + Type: + $ref: "#/components/schemas/ValidationFindingType" + description: The type of the validation finding. + Code: + $ref: "#/components/schemas/ValidationFindingCode" + description: A code that identifies the specific validation finding. + Message: + $ref: "#/components/schemas/String" + description: A message that describes the validation finding. + ProviderMessage: + $ref: "#/components/schemas/String" + description: A message from the third-party cloud provider related to the validation finding. + Scope: + $ref: "#/components/schemas/ValidationFindingScope" + description: The scope of the validation finding, identifying the specific resource affected. + ValidationFindingType: + type: string + enum: + - INFO + - WARN + - ERROR + ValidationFindingCode: + type: string + enum: + - TargetInaccessible + - TargetUnusable + - TargetStateWarning + - AwsRoleAssumptionFailed + - WebIdentityTokenFailed + - OutboundWebIdentityFederationDisabled + - ProviderCredentialCreationFailed + - TenantSummary + - SubscriptionAccessible + ValidationFindingScope: + description: Identifies the specific resource scope of a validation finding. + type: object + properties: + Type: + $ref: "#/components/schemas/ValidationFindingScopeType" + description: The type of the resource scope. + Id: + $ref: "#/components/schemas/String" + description: The ID of the resource within the scope. + ValidationFindingScopeType: + type: string + enum: + - azure:tenant + - azure:subscription x-stackQL-resources: tags: id: aws.ssm.tags @@ -14872,6 +15464,114 @@ components: - $ref: "#/components/x-stackQL-resources/associations/methods/update_association" delete: - $ref: "#/components/x-stackQL-resources/associations/methods/delete_association" + cloud_connectors: + id: aws.ssm.cloud_connectors + name: cloud_connectors + title: cloud_connectors + methods: + create_cloud_connector: + operation: + $ref: "#/paths/~1CreateCloudConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_cloud_connector: + operation: + $ref: "#/paths/~1DeleteCloudConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_cloud_connector: + operation: + $ref: "#/paths/~1GetCloudConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_cloud_connectors: + operation: + $ref: "#/paths/~1ListCloudConnectors/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.CloudConnectors + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + update_cloud_connector: + operation: + $ref: "#/paths/~1UpdateCloudConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + validate_cloud_connector: + operation: + $ref: "#/paths/~1ValidateCloudConnector/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/cloud_connectors/methods/get_cloud_connector" + - $ref: "#/components/x-stackQL-resources/cloud_connectors/methods/list_cloud_connectors" + insert: + - $ref: "#/components/x-stackQL-resources/cloud_connectors/methods/create_cloud_connector" + update: + - $ref: "#/components/x-stackQL-resources/cloud_connectors/methods/update_cloud_connector" + delete: + - $ref: "#/components/x-stackQL-resources/cloud_connectors/methods/delete_cloud_connector" documents: id: aws.ssm.documents name: documents diff --git a/providers/src/aws/v00.00.00000/services/sso_admin.yaml b/providers/src/aws/v00.00.00000/services/sso_admin.yaml index b8e29251..4f2cb38f 100644 --- a/providers/src/aws/v00.00.00000/services/sso_admin.yaml +++ b/providers/src/aws/v00.00.00000/services/sso_admin.yaml @@ -2956,7 +2956,7 @@ paths: /UpdateInstance: post: operationId: UpdateInstance - description: Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account. + description: "Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account. In a single UpdateInstance request, you can perform only one of the following operations: Update the encryption configuration of the instance by specifying EncryptionConfiguration. Enable permission sets for the instance by specifying PermissionSetsEnabled. A request that specifies both EncryptionConfiguration and PermissionSetsEnabled returns a ValidationException. To perform both operations, call UpdateInstance separately for each. The two calls can be made in parallel." parameters: - name: X-Amz-Target in: header @@ -2983,6 +2983,9 @@ paths: EncryptionConfiguration: $ref: "#/components/schemas/EncryptionConfiguration" description: Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or Amazon Web Services owned KMS keys for encrypting your instance data. + PermissionSetsEnabled: + $ref: "#/components/schemas/Boolean" + description: Enables permission sets for this Identity Center instance. The only accepted value is true . After permission sets are enabled, they cannot be disabled. You can't set EncryptionConfiguration and PermissionSetsEnabled in the same request. To configure both, make two separate UpdateInstance calls. These calls can be made in parallel. required: - InstanceArn responses: @@ -3756,6 +3759,9 @@ components: EncryptionConfigurationDetails: $ref: "#/components/schemas/EncryptionConfigurationDetails" description: Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN. + PermissionSetsEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether permission sets are enabled for this Identity Center instance. Id: type: string minLength: 1 @@ -3800,6 +3806,8 @@ components: - UPDATING - ENABLED - UPDATE_FAILED + Boolean: + type: boolean DescribeInstanceAccessControlAttributeConfigurationResponse: type: object properties: @@ -4475,6 +4483,32 @@ components: StatusReason: $ref: "#/components/schemas/Reason" description: Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions. + PrimaryRegion: + $ref: "#/components/schemas/RegionName" + description: The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed. + Regions: + $ref: "#/components/schemas/RegionMetadataList" + description: The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status. + RegionMetadataList: + type: array + items: + $ref: "#/components/schemas/RegionMetadata" + RegionMetadata: + description: Contains information about an enabled Region of an IAM Identity Center instance, including the Region name, status, date added, and whether it is the primary Region. + type: object + properties: + RegionName: + $ref: "#/components/schemas/RegionName" + description: The Amazon Web Services Region name. + Status: + $ref: "#/components/schemas/RegionStatus" + description: The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress). + AddedDate: + $ref: "#/components/schemas/Date" + description: The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the instance creation time. + IsPrimaryRegion: + $ref: "#/components/schemas/IsPrimaryRegion" + description: Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed. ListManagedPoliciesInPermissionSetResponse: type: object properties: @@ -4559,26 +4593,6 @@ components: NextToken: $ref: "#/components/schemas/Token" description: The pagination token to be used in subsequent calls. If the value is null, then there are no more entries. - RegionMetadataList: - type: array - items: - $ref: "#/components/schemas/RegionMetadata" - RegionMetadata: - description: Contains information about an enabled Region of an IAM Identity Center instance, including the Region name, status, date added, and whether it is the primary Region. - type: object - properties: - RegionName: - $ref: "#/components/schemas/RegionName" - description: The Amazon Web Services Region name. - Status: - $ref: "#/components/schemas/RegionStatus" - description: The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress). - AddedDate: - $ref: "#/components/schemas/Date" - description: The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the instance creation time. - IsPrimaryRegion: - $ref: "#/components/schemas/IsPrimaryRegion" - description: Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed. TaggableResourceArn: type: string minLength: 10 diff --git a/providers/src/aws/v00.00.00000/services/supportauthz.yaml b/providers/src/aws/v00.00.00000/services/supportauthz.yaml new file mode 100644 index 00000000..0aafeb3f --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/supportauthz.yaml @@ -0,0 +1,926 @@ +openapi: 3.0.0 +info: + version: "2026-06-30" + title: SupportAuthZ + description: SupportAuthZ + x-serviceName: supportauthz + x-serviceAlias: supportauthz + x-protocol: rest-json + x-apiVersion: "2026-06-30" + x-endpointPrefix: supportauthz +servers: + - url: https://supportauthz.{region}.amazonaws.com + variables: + region: + default: us-east-1 + description: AWS region + description: Regional endpoint for supportauthz +paths: + /support-permits: + post: + operationId: CreateSupportPermit + description: Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + permit: + $ref: "#/components/schemas/Permit" + name: + $ref: "#/components/schemas/Name" + description: + $ref: "#/components/schemas/Description" + signingKeyInfo: + $ref: "#/components/schemas/SigningKeyInfo" + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + clientToken: + $ref: "#/components/schemas/ClientToken" + tags: + $ref: "#/components/schemas/Tags" + required: + - permit + - name + - signingKeyInfo + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateSupportPermitOutput" + get: + operationId: ListSupportPermits + description: Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. Valid range is 1 to 100. + - name: supportPermitStatuses + in: query + required: false + schema: + $ref: "#/components/schemas/SupportPermitStatuses" + description: "Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING." + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSupportPermitsOutput" + /support-permits/{support_permit_identifier}: + delete: + operationId: DeleteSupportPermit + description: Deletes a support permit, revoking the authorization previously granted to the AWS support operator. + parameters: + - name: support_permit_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) or name of the support permit to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteSupportPermitOutput" + get: + operationId: GetSupportPermit + description: Retrieves the details of a support permit by its ARN or name. + parameters: + - name: support_permit_identifier + in: path + required: true + schema: + $ref: "#/components/schemas/SupportPermitIdentifier" + description: The ARN or name of the support permit to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetSupportPermitOutput" + /actions/{action}: + get: + operationId: GetAction + description: Retrieves the description of a specific support action. + parameters: + - name: action + in: path + required: true + schema: + $ref: "#/components/schemas/Action" + description: The name of the support action to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetActionOutput" + /actions: + get: + operationId: ListActions + description: Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. Valid range is 1 to 100. + - name: service + in: query + required: true + schema: + $ref: "#/components/schemas/Service" + description: The name of the AWS service for which to list available support actions. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListActionsOutput" + /support-permit-requests: + get: + operationId: ListSupportPermitRequests + description: Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of results to return in a single call. Valid range is 1 to 100. + - name: supportCaseDisplayId + in: query + required: false + schema: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: Filters the results by support case display identifier. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSupportPermitRequestsOutput" + /tags/{resource_arn}: + get: + operationId: ListTagsForResource + description: Lists the tags associated with a support permit resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the resource to list tags for. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListTagsForResourceOutput" + post: + operationId: TagResource + description: Adds or overwrites one or more tags for a support permit resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the resource to tag. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tags: + $ref: "#/components/schemas/Tags" + required: + - tags + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/TagResourceOutput" + delete: + operationId: UntagResource + description: Removes one or more tags from a support permit resource. + parameters: + - name: resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/Arn" + description: The ARN of the resource to untag. + - name: tagKeys + in: query + required: true + schema: + $ref: "#/components/schemas/TagKeyList" + description: The tag keys to remove from the resource. + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UntagResourceOutput" + /support-permit-requests/{request_arn}/reject: + put: + operationId: RejectSupportPermitRequest + description: Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action. + parameters: + - name: request_arn + in: path + required: true + schema: + $ref: "#/components/schemas/RequestArn" + description: The ARN of the permit request to reject. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RejectSupportPermitRequestOutput" +components: + parameters: + X-Amz-Content-Sha256: + in: header + name: X-Amz-Content-Sha256 + required: false + schema: + type: string + X-Amz-Date: + in: header + name: X-Amz-Date + required: false + schema: + type: string + X-Amz-Algorithm: + in: header + name: X-Amz-Algorithm + required: false + schema: + type: string + X-Amz-Credential: + in: header + name: X-Amz-Credential + required: false + schema: + type: string + X-Amz-Security-Token: + in: header + name: X-Amz-Security-Token + required: false + schema: + type: string + X-Amz-Signature: + in: header + name: X-Amz-Signature + required: false + schema: + type: string + X-Amz-SignedHeaders: + in: header + name: X-Amz-SignedHeaders + required: false + schema: + type: string + schemas: + Permit: + description: The permit definition specifying the authorized actions, resources, and time-window conditions for a support operator. + type: object + properties: + actions: + $ref: "#/components/schemas/ActionSet" + description: The set of actions that the support operator is authorized to perform. + resources: + $ref: "#/components/schemas/ResourceSet" + description: The set of resources that the support operator is authorized to act upon. + conditions: + $ref: "#/components/schemas/Conditions" + description: The time-window conditions that constrain when the permit is valid. Maximum of 2 conditions. + required: + - actions + - resources + ActionSet: + description: The set of actions authorized by a permit. Specify either all actions or a list of specific actions. + type: object + properties: + allActions: + $ref: "#/components/schemas/Unit" + description: Authorizes all available support actions. + actions: + $ref: "#/components/schemas/Actions" + description: A list of specific support actions to authorize. Maximum of 10 actions. + Unit: + type: object + Actions: + type: array + items: + $ref: "#/components/schemas/Action" + Action: + type: string + minLength: 3 + maxLength: 255 + pattern: "[a-z][a-z0-9-]*:[A-Za-z0-9_.-]+" + ResourceSet: + description: The set of resources authorized by a permit. Specify either all resources in the Region or a list of specific resources. + type: object + properties: + allResourcesInRegion: + $ref: "#/components/schemas/Unit" + description: Authorizes the support operator to act on all resources in the Region. + resources: + $ref: "#/components/schemas/Resources" + description: A list of specific resource identifiers that the support operator is authorized to act upon. Maximum of 5 resources. + Resources: + type: array + items: + $ref: "#/components/schemas/Resource" + Resource: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9:/_.-]+" + Conditions: + type: array + items: + $ref: "#/components/schemas/Condition" + Condition: + description: A time-window condition that constrains when a support permit is valid. + type: object + properties: + allowAfter: + $ref: "#/components/schemas/Timestamp" + description: The earliest time at which the permit becomes valid. + allowBefore: + $ref: "#/components/schemas/Timestamp" + description: The latest time at which the permit remains valid. + Timestamp: + type: string + format: date-time + Name: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9]{1,256}" + Description: + type: string + minLength: 1 + maxLength: 1024 + SigningKeyInfo: + description: The signing key used to cryptographically sign a support permit. + type: object + properties: + kmsKey: + $ref: "#/components/schemas/KmsKeyArn" + description: The ARN of the AWS KMS key used to sign the permit. The key must have key spec ECC_NIST_P384 and key usage SIGN_VERIFY. + KmsKeyArn: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9/:_-]{1,512}" + SupportCaseDisplayId: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9:/-]{1,512}" + ClientToken: + type: string + minLength: 1 + maxLength: 128 + pattern: "[!-~]+" + Tags: + type: object + properties: {} + CreateSupportPermitOutput: + type: object + properties: + name: + $ref: "#/components/schemas/Name" + description: The name of the support permit. + arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the support permit. + description: + $ref: "#/components/schemas/Description" + description: The description of the support permit. + permit: + $ref: "#/components/schemas/Permit" + description: The permit definition. + status: + $ref: "#/components/schemas/SupportPermitStatus" + description: The current status of the support permit. + signingKeyInfo: + $ref: "#/components/schemas/SigningKeyInfo" + description: The signing key information for the permit. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the permit was created. + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: The display identifier of the support case associated with the permit. + tags: + type: object + properties: {} + description: The tags associated with the support permit. + required: + - name + - arn + - permit + - status + - signingKeyInfo + - createdAt + Arn: + type: string + minLength: 1 + maxLength: 512 + pattern: arn:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:.+ + SupportPermitStatus: + description: The status of a support permit. + type: string + enum: + - ACTIVE + - INACTIVE + - DELETING + DeleteSupportPermitOutput: + type: object + properties: + name: + $ref: "#/components/schemas/Name" + description: The name of the deleted support permit. + arn: + $ref: "#/components/schemas/Arn" + description: The ARN of the deleted support permit. + description: + $ref: "#/components/schemas/Description" + description: The description of the deleted support permit. + permit: + $ref: "#/components/schemas/Permit" + description: The permit definition of the deleted permit. + status: + $ref: "#/components/schemas/SupportPermitStatus" + description: The status of the support permit. Returns DELETING. + signingKeyInfo: + $ref: "#/components/schemas/SigningKeyInfo" + description: The signing key information for the deleted permit. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the permit was originally created. + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: The display identifier of the support case associated with the deleted permit. + required: + - name + - arn + - permit + - status + - signingKeyInfo + - createdAt + GetActionOutput: + type: object + properties: + action: + $ref: "#/components/schemas/Action" + description: The name of the support action. + service: + $ref: "#/components/schemas/Service" + description: The AWS service associated with the support action. + description: + $ref: "#/components/schemas/ActionDescription" + description: A description of what the support action does. + required: + - action + - service + - description + Service: + type: string + minLength: 1 + maxLength: 256 + pattern: "[a-zA-Z0-9-]+" + ActionDescription: + type: string + minLength: 1 + maxLength: 10240 + SupportPermitIdentifier: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9:/-]{1,512}" + GetSupportPermitOutput: + type: object + properties: + name: + $ref: "#/components/schemas/Name" + description: The name of the support permit. + arn: + $ref: "#/components/schemas/Arn" + description: The ARN of the support permit. + description: + $ref: "#/components/schemas/Description" + description: The description of the support permit. + permit: + $ref: "#/components/schemas/Permit" + description: The permit definition. + status: + $ref: "#/components/schemas/SupportPermitStatus" + description: The current status of the support permit. + signingKeyInfo: + $ref: "#/components/schemas/SigningKeyInfo" + description: The signing key information for the permit. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the permit was created. + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: The display identifier of the support case associated with the permit. + tags: + type: object + properties: {} + description: The tags associated with the support permit. + required: + - name + - arn + - permit + - status + - signingKeyInfo + - createdAt + NextToken: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[a-zA-Z0-9/+=%_-]+" + MaxResults: + type: integer + minimum: 1 + maximum: 100 + ListActionsOutput: + type: object + properties: + actionSummaries: + $ref: "#/components/schemas/ActionSummaries" + description: The list of support actions. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results, or null if there are no more results. + required: + - actionSummaries + ActionSummaries: + type: array + items: + $ref: "#/components/schemas/ActionSummary" + ActionSummary: + description: A summary of a support action. + type: object + properties: + action: + $ref: "#/components/schemas/Action" + description: The name of the support action. + service: + $ref: "#/components/schemas/Service" + description: The AWS service associated with the support action. + description: + $ref: "#/components/schemas/ActionDescription" + description: A description of what the support action does. + required: + - action + - service + - description + ListSupportPermitRequestsOutput: + type: object + properties: + supportPermitRequests: + $ref: "#/components/schemas/SupportPermitRequests" + description: The list of permit requests. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results, or null if there are no more results. + required: + - supportPermitRequests + SupportPermitRequests: + type: array + items: + $ref: "#/components/schemas/SupportPermitRequest" + SupportPermitRequest: + description: A permit request from an AWS support operator. + type: object + properties: + requestArn: + $ref: "#/components/schemas/RequestArn" + description: The ARN of the permit request. + permit: + $ref: "#/components/schemas/Permit" + description: The permit definition requested by the operator. + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: The display identifier of the support case associated with the request. + status: + $ref: "#/components/schemas/SupportPermitRequestStatus" + description: The current status of the permit request. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the request was created. + updatedAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the request was last updated. + required: + - requestArn + - permit + - supportCaseDisplayId + - status + - createdAt + - updatedAt + RequestArn: + type: string + minLength: 1 + maxLength: 512 + pattern: "[a-zA-Z0-9:/-]{1,512}" + SupportPermitRequestStatus: + description: The status of a support permit request. + type: string + enum: + - PENDING + - ACCEPTED + - REJECTED + - CANCELLED + SupportPermitStatuses: + type: array + items: + $ref: "#/components/schemas/SupportPermitStatus" + ListSupportPermitsOutput: + type: object + properties: + supportPermits: + $ref: "#/components/schemas/SupportPermitSummaries" + description: The list of support permits. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The token for the next page of results, or null if there are no more results. + required: + - supportPermits + SupportPermitSummaries: + type: array + items: + $ref: "#/components/schemas/SupportPermitSummary" + SupportPermitSummary: + description: A summary of a support permit. + type: object + properties: + name: + $ref: "#/components/schemas/Name" + description: The name of the support permit. + arn: + $ref: "#/components/schemas/Arn" + description: The ARN of the support permit. + permit: + $ref: "#/components/schemas/Permit" + description: The permit definition. + status: + $ref: "#/components/schemas/SupportPermitStatus" + description: The current status of the support permit. + signingKeyInfo: + $ref: "#/components/schemas/SigningKeyInfo" + description: The signing key information for the permit. + createdAt: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the permit was created. + supportCaseDisplayId: + $ref: "#/components/schemas/SupportCaseDisplayId" + description: The display identifier of the support case associated with the permit. + required: + - name + - arn + - permit + - status + - signingKeyInfo + - createdAt + ListTagsForResourceOutput: + type: object + properties: + tags: + type: object + properties: {} + description: The tags associated with the resource. + RejectSupportPermitRequestOutput: + type: object + properties: + requestArn: + $ref: "#/components/schemas/RequestArn" + description: The ARN of the rejected permit request. + required: + - requestArn + TagResourceOutput: + type: object + TagKeyList: + type: array + items: + $ref: "#/components/schemas/TagKey" + TagKey: + type: string + minLength: 1 + maxLength: 128 + UntagResourceOutput: + type: object + x-stackQL-resources: + support_permits: + id: aws.supportauthz.support_permits + name: support_permits + title: support_permits + methods: + create_support_permit: + operation: + $ref: "#/paths/~1support-permits/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_support_permits: + operation: + $ref: "#/paths/~1support-permits/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.supportPermits + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_support_permit: + operation: + $ref: "#/paths/~1support-permits~1{support_permit_identifier}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_support_permit: + operation: + $ref: "#/paths/~1support-permits~1{support_permit_identifier}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + reject_support_permit_request: + operation: + $ref: "#/paths/~1support-permit-requests~1{request_arn}~1reject/put" + response: + openAPIDocKey: "200" + mediaType: application/json + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/support_permits/methods/get_support_permit" + - $ref: "#/components/x-stackQL-resources/support_permits/methods/list_support_permits" + insert: + - $ref: "#/components/x-stackQL-resources/support_permits/methods/create_support_permit" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/support_permits/methods/delete_support_permit" + actions: + id: aws.supportauthz.actions + name: actions + title: actions + methods: + get_action: + operation: + $ref: "#/paths/~1actions~1{action}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_actions: + operation: + $ref: "#/paths/~1actions/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.actionSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/actions/methods/get_action" + - $ref: "#/components/x-stackQL-resources/actions/methods/list_actions" + insert: [] + update: [] + delete: [] + support_permit_requests: + id: aws.supportauthz.support_permit_requests + name: support_permit_requests + title: support_permit_requests + methods: + list_support_permit_requests: + operation: + $ref: "#/paths/~1support-permit-requests/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.supportPermitRequests + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/support_permit_requests/methods/list_support_permit_requests" + insert: [] + update: [] + delete: [] + tags: + id: aws.supportauthz.tags + name: tags + title: tags + methods: + list_tags_for_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + tag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/post" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + untag_resource: + operation: + $ref: "#/paths/~1tags~1{resource_arn}/delete" + response: + openAPIDocKey: "204" + mediaType: application/json + request: + nativeCasing: pascal + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/tags/methods/list_tags_for_resource" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/tags/methods/tag_resource" + - $ref: "#/components/x-stackQL-resources/tags/methods/untag_resource" + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/sustainability.yaml b/providers/src/aws/v00.00.00000/services/sustainability.yaml index a42cfd77..4edbd9b0 100644 --- a/providers/src/aws/v00.00.00000/services/sustainability.yaml +++ b/providers/src/aws/v00.00.00000/services/sustainability.yaml @@ -83,6 +83,71 @@ paths: application/json: schema: $ref: "#/components/schemas/GetEstimatedCarbonEmissionsDimensionValuesResponse" + /v1/estimated-water-allocation: + post: + operationId: GetEstimatedWaterAllocation + description: Returns estimated water allocation values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TimePeriod: + $ref: "#/components/schemas/TimePeriod" + GroupBy: + $ref: "#/components/schemas/DimensionList" + FilterBy: + $ref: "#/components/schemas/FilterExpression" + AllocationTypes: + $ref: "#/components/schemas/WaterAllocationTypeList" + Granularity: + $ref: "#/components/schemas/TimeGranularity" + MaxResults: + $ref: "#/components/schemas/MaxResults" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - TimePeriod + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEstimatedWaterAllocationResponse" + /v1/estimated-water-allocation-dimension-values: + post: + operationId: GetEstimatedWaterAllocationDimensionValues + description: Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + TimePeriod: + $ref: "#/components/schemas/TimePeriod" + Dimensions: + $ref: "#/components/schemas/DimensionList" + MaxResults: + $ref: "#/components/schemas/MaxResults" + NextToken: + $ref: "#/components/schemas/NextToken" + required: + - TimePeriod + - Dimensions + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetEstimatedWaterAllocationDimensionValuesResponse" components: parameters: X-Amz-Content-Sha256: @@ -149,20 +214,20 @@ components: items: $ref: "#/components/schemas/Dimension" Dimension: - description: Specifies the dimensions available for grouping and filtering emissions data. + description: Specifies the dimensions available for grouping and filtering environmental impact data. type: string enum: - USAGE_ACCOUNT_ID - REGION - SERVICE FilterExpression: - description: Filters emission values by specific dimension values. + description: Filters environmental impact values by specific dimension values. type: object properties: Dimensions: type: object properties: {} - description: Filters emission values by specific dimension values. + description: Filters environmental impact values by specific dimension values. EmissionsTypeList: type: array items: @@ -179,7 +244,7 @@ components: - TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS - TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS TimeGranularity: - description: Specifies the time period over which emissions data is aggregated. + description: Specifies the time period over which environmental impact data is aggregated. type: string enum: - YEARLY_CALENDAR @@ -268,13 +333,73 @@ components: $ref: "#/components/schemas/Dimension" description: The dimension type that categorizes this entry. Value: - $ref: "#/components/schemas/String" + $ref: "#/components/schemas/DimensionValue" description: The value for the specified dimension. Valid values vary based on the dimension type (e.g., us-east-1 for the REGION dimension, AmazonEC2 for the SERVICE dimension). required: - Dimension - Value - String: + DimensionValue: + type: string + minLength: 0 + maxLength: 256 + WaterAllocationTypeList: + type: array + items: + $ref: "#/components/schemas/WaterAllocationType" + WaterAllocationType: + description: Specifies the types of water allocation calculations available. type: string + enum: + - TOTAL_WATER_WITHDRAWALS + GetEstimatedWaterAllocationResponse: + type: object + properties: + Results: + $ref: "#/components/schemas/EstimatedWaterAllocationList" + description: The result of the requested inputs. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. + required: + - Results + EstimatedWaterAllocationList: + type: array + items: + $ref: "#/components/schemas/EstimatedWaterAllocation" + EstimatedWaterAllocation: + description: Contains estimated water allocation data for a specific time period and dimension grouping. + type: object + properties: + TimePeriod: + $ref: "#/components/schemas/TimePeriod" + description: The reporting period for water allocation values. + DimensionsValues: + type: object + properties: {} + description: The dimensions used to group water allocation values. + ModelVersion: + $ref: "#/components/schemas/ModelVersion" + description: The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values. The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different ModelVersion values. + AllocationValues: + type: object + properties: {} + description: The allocation values for the requested water allocation types. + required: + - TimePeriod + - DimensionsValues + - ModelVersion + - AllocationValues + GetEstimatedWaterAllocationDimensionValuesResponse: + type: object + properties: + Results: + $ref: "#/components/schemas/DimensionEntryList" + description: The list of possible dimensions over which the allocation data is aggregated. + NextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. + required: + - Results x-stackQL-resources: estimated_carbon_emissions: id: aws.sustainability.estimated_carbon_emissions @@ -336,3 +461,63 @@ components: insert: [] update: [] delete: [] + estimated_water_allocations: + id: aws.sustainability.estimated_water_allocations + name: estimated_water_allocations + title: estimated_water_allocations + methods: + get_estimated_water_allocation: + operation: + $ref: "#/paths/~1v1~1estimated-water-allocation/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Results + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/estimated_water_allocations/methods/get_estimated_water_allocation" + insert: [] + update: [] + delete: [] + estimated_water_allocation_dimension_values: + id: aws.sustainability.estimated_water_allocation_dimension_values + name: estimated_water_allocation_dimension_values + title: estimated_water_allocation_dimension_values + methods: + get_estimated_water_allocation_dimension_values: + operation: + $ref: "#/paths/~1v1~1estimated-water-allocation-dimension-values/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.Results + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: $.NextToken + location: body + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/estimated_water_allocation_dimension_values/methods/get_estimated_water_allocation_dimension_values" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/synthetics.yaml b/providers/src/aws/v00.00.00000/services/synthetics.yaml index 23ce9a31..465e4924 100644 --- a/providers/src/aws/v00.00.00000/services/synthetics.yaml +++ b/providers/src/aws/v00.00.00000/services/synthetics.yaml @@ -84,10 +84,14 @@ paths: $ref: "#/components/schemas/ProvisionedResourceCleanupSetting" BrowserConfigs: $ref: "#/components/schemas/BrowserConfigs" + AddReplicaLocations: + $ref: "#/components/schemas/AddReplicaLocations" Tags: $ref: "#/components/schemas/TagMap" ArtifactConfig: $ref: "#/components/schemas/ArtifactConfigInput" + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" required: - Code - ArtifactS3Location @@ -220,6 +224,12 @@ paths: $ref: "#/components/schemas/VisualReferences" BrowserConfigs: $ref: "#/components/schemas/BrowserConfigs" + AddReplicaLocations: + $ref: "#/components/schemas/AddReplicaLocations" + RemoveReplicaLocations: + $ref: "#/components/schemas/RemoveReplicaLocations" + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" responses: "200": description: Success @@ -893,6 +903,35 @@ components: enum: - CHROME - FIREFOX + AddReplicaLocations: + type: array + items: + $ref: "#/components/schemas/AddReplicaLocationInput" + AddReplicaLocationInput: + description: A structure that specifies a replica location for a canary, including the Region and optional VPC configuration. + type: object + properties: + Location: + $ref: "#/components/schemas/Location" + description: The Amazon Web Services Region where the canary replica should be created, for example us-east-1. + VpcConfig: + $ref: "#/components/schemas/VpcConfigInput" + description: The VPC configuration to use for the canary replica in this location. If not specified, the replica runs without VPC connectivity. + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary replica's AWS Lambda function environment variables at rest. If you don't specify a value, the service uses an AWS-managed key. + required: + - Location + Location: + type: string + minLength: 1 + maxLength: 20 + pattern: ^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$ + KmsKeyArn: + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\d{1}:\d{12}:key/[\w\-\/]+ TagMap: type: object properties: {} @@ -918,11 +957,6 @@ components: enum: - SSE_S3 - SSE_KMS - KmsKeyArn: - type: string - minLength: 1 - maxLength: 2048 - pattern: arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\d{1}:\d{12}:key/[\w\-\/]+ CreateCanaryResponse: type: object properties: @@ -987,6 +1021,9 @@ components: VisualReferences: $ref: "#/components/schemas/VisualReferencesOutput" description: A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported. Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility. + MultiLocationConfig: + $ref: "#/components/schemas/MultiLocationConfig" + description: If this canary is part of a multi-location configuration, this structure contains information about the canary's location type, primary location, and replicas. Tags: type: object properties: {} @@ -994,6 +1031,9 @@ components: ArtifactConfig: $ref: "#/components/schemas/ArtifactConfigOutput" description: A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. + KmsKeyArn: + $ref: "#/components/schemas/KmsKeyArn" + description: The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary's AWS Lambda function environment variables at rest. If you don't specify a value, the service uses an AWS-managed key. DryRunConfig: $ref: "#/components/schemas/DryRunConfigOutput" description: Returns the dry run configurations for a canary. @@ -1188,6 +1228,69 @@ components: type: array items: $ref: "#/components/schemas/VisualReferenceOutput" + MultiLocationConfig: + description: A structure that contains information about the multi-location configuration of a canary, including whether it is a primary or replica, the primary location, and the list of replicas. + type: object + properties: + LocationType: + $ref: "#/components/schemas/LocationType" + description: Indicates whether this canary is the Primary or a Replica in the multi-location configuration. + PrimaryLocation: + $ref: "#/components/schemas/Location" + description: The Amazon Web Services Region where the primary canary is located. + Replicas: + $ref: "#/components/schemas/Replicas" + description: A list of replicas for this canary. This field is present only for the primary location canary. + ReplicationState: + $ref: "#/components/schemas/ReplicationState" + description: The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent. + LocationType: + type: string + enum: + - Primary + - Replica + Replicas: + type: array + items: + $ref: "#/components/schemas/Replica" + Replica: + description: A structure that contains information about a canary replica in a specific location. + type: object + properties: + Location: + $ref: "#/components/schemas/Location" + description: The Amazon Web Services Region where this replica is located. + ReplicationStatus: + $ref: "#/components/schemas/ReplicationStatus" + description: A structure that contains information about the replication status of this replica. + CanaryState: + $ref: "#/components/schemas/CanaryState" + description: The current state of the canary in this replica location. + LastModified: + $ref: "#/components/schemas/Timestamp" + description: The date and time that the replica was last modified. + VpcConfig: + $ref: "#/components/schemas/VpcConfigOutput" + description: The VPC configuration for the canary replica in this location. + ReplicationStatus: + description: A structure that contains information about the replication status of a canary replica. + type: object + properties: + State: + $ref: "#/components/schemas/ReplicationState" + description: The replication state of the replica. Valid values are InProgress, InSync, and Inconsistent. + StateReason: + $ref: "#/components/schemas/String" + description: A description that provides more detail about the current replication state. + StateReasonCode: + $ref: "#/components/schemas/String" + description: A code that provides more detail about the current replication state. + ReplicationState: + type: string + enum: + - InProgress + - InSync + - Inconsistent ArtifactConfigOutput: description: A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. type: object @@ -1336,6 +1439,9 @@ components: BrowserType: $ref: "#/components/schemas/BrowserType" description: The browser type associated with this canary run. + Location: + $ref: "#/components/schemas/Location" + description: The Amazon Web Services Region where this canary run was executed. RetryAttempt: type: integer minimum: 1 @@ -1565,6 +1671,10 @@ components: pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ UntagResourceResponse: type: object + RemoveReplicaLocations: + type: array + items: + $ref: "#/components/schemas/Location" UpdateCanaryResponse: type: object x-stackQL-resources: diff --git a/providers/src/aws/v00.00.00000/services/taxsettings.yaml b/providers/src/aws/v00.00.00000/services/taxsettings.yaml index d29f67d7..43ee1d02 100644 --- a/providers/src/aws/v00.00.00000/services/taxsettings.yaml +++ b/providers/src/aws/v00.00.00000/services/taxsettings.yaml @@ -8,7 +8,6 @@ info: x-protocol: rest-json x-apiVersion: "2018-05-10" x-endpointPrefix: tax - x-jsonVersion: "1.1" servers: - url: https://tax.{region}.amazonaws.com variables: @@ -66,7 +65,7 @@ paths: /BatchPutTaxRegistration: post: operationId: BatchPutTaxRegistration - description: "Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation. For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address. Georgia The valid personType values are Physical Person and Business. Indonesia PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022. BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak). You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08. For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08. If ppnExceptionDesignationCode is 07, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object. Kenya You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object. If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Malaysia The sector valid values are Business and Individual. RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate. Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller. Taxable service and service tax codes: Consultancy - 9907061674 Training or coaching service - 9907071685 IT service - 9907101676 Digital services and electronic medium - 9907121690 Nepal The sector valid values are Business and Individual. Saudi Arabia For address, you must specify addressLine3. South Korea You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName. You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields. You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion. Spain You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object. If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Turkey You must specify the sector in the taxRegistrationEntry object. If your sector is Business, Individual, or Government: Specify the taxOffice. If your sector is Individual, don't enter this value. (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value. Note: In the Tax Settings page of the Billing console, Government appears as Public institutions If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field. For address, you must specify districtOrCounty. Ukraine The sector valid values are Business and Individual." + description: "Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation. For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address. Georgia The valid personType values are Physical Person and Business. Indonesia PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022. BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak). You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08. For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08. If ppnExceptionDesignationCode is 07 or 08, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object. Kenya You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object. If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Malaysia The sector valid values are Business and Individual. RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate. Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller. Taxable service and service tax codes: Consultancy - 9907061674 Training or coaching service - 9907071685 IT service - 9907101676 Digital services and electronic medium - 9907121690 Mexico You must provide a Constancia de Situación fiscal (CSF) document in the verificationDetails field. You do not need to provide address and legal name. These will be populated based on your tax registration number. Nepal The sector valid values are Business and Individual. Saudi Arabia For address, you must specify addressLine3. South Korea You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName. You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields. You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion. Spain You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object. If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Turkey You must specify the sector in the taxRegistrationEntry object. If your sector is Business, Individual, or Government: Specify the taxOffice. If your sector is Individual, don't enter this value. (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value. Note: In the Tax Settings page of the Billing console, Government appears as Public institutions If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field. For address, you must specify districtOrCounty. Ukraine The sector valid values are Business and Individual. Philippines You can optionally specify the isVatRegistered in the philippinesAdditionalInfo field of the additionalTaxInformation object to indicate your VAT registration status with the Bureau of Internal Revenue (BIR). Belgium You can optionally specify the peppolId in the belgiumAdditionalInfo field of the additionalTaxInformation object. Chile You can optionally specify the documentType and businessActivity in the chileAdditionalInfo field of the additionalTaxInformation object. France You must specify the sirenNumber in the franceAdditionalInfo field of the additionalTaxInformation object. Poland You can optionally specify the taxRegistrationNumberType in the polandAdditionalInfo field of the additionalTaxInformation object. Valid values are EUTaxRegistrationNumber, LocalTaxRegistrationNumber, or LocalRegistrationNumber." parameters: [] requestBody: required: true @@ -311,15 +310,15 @@ paths: $ref: "#/components/schemas/PutTaxExemptionRequestAccountIdsList" authority: $ref: "#/components/schemas/Authority" - exemptionCertificate: - $ref: "#/components/schemas/ExemptionCertificate" exemptionType: $ref: "#/components/schemas/GenericString" + exemptionCertificate: + $ref: "#/components/schemas/ExemptionCertificate" required: - accountIds - authority - - exemptionCertificate - exemptionType + - exemptionCertificate responses: "200": description: Success @@ -351,7 +350,7 @@ paths: /PutTaxRegistration: post: operationId: PutTaxRegistration - description: "Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation. For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address. Georgia The valid personType values are Physical Person and Business. Indonesia PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022. BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak). You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08. For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08. If ppnExceptionDesignationCode is 07, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object. Kenya You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object. If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Malaysia The sector valid values are Business and Individual. RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate. Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller. Taxable service and service tax codes: Consultancy - 9907061674 Training or coaching service - 9907071685 IT service - 9907101676 Digital services and electronic medium - 9907121690 Nepal The sector valid values are Business and Individual. Saudi Arabia For address, you must specify addressLine3. South Korea You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName. You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields. You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion. Spain You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object. If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Turkey You must specify the sector in the taxRegistrationEntry object. If your sector is Business, Individual, or Government: Specify the taxOffice. If your sector is Individual, don't enter this value. (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value. Note: In the Tax Settings page of the Billing console, Government appears as Public institutions If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field. For address, you must specify districtOrCounty. Ukraine The sector valid values are Business and Individual." + description: "Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation. For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address. Georgia The valid personType values are Physical Person and Business. Indonesia PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022. BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you’re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak). You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08. For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08. If ppnExceptionDesignationCode is 07 or 08, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object. Kenya You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object. If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Malaysia The sector valid values are Business and Individual. RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate. Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller. Taxable service and service tax codes: Consultancy - 9907061674 Training or coaching service - 9907071685 IT service - 9907101676 Digital services and electronic medium - 9907121690 Mexico You must provide a Constancia de Situación fiscal (CSF) document in the verificationDetails field. You do not need to provide address and legal name. These will be populated based on your tax registration number. Nepal The sector valid values are Business and Individual. Saudi Arabia For address, you must specify addressLine3. South Korea You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName. You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields. You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion. Spain You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object. If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Turkey You must specify the sector in the taxRegistrationEntry object. If your sector is Business, Individual, or Government: Specify the taxOffice. If your sector is Individual, don't enter this value. (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value. Note: In the Tax Settings page of the Billing console, Government appears as Public institutions If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field. For address, you must specify districtOrCounty. Ukraine The sector valid values are Business and Individual. Philippines You can optionally specify the isVatRegistered in the philippinesAdditionalInfo field of the additionalTaxInformation object to indicate your VAT registration status with the Bureau of Internal Revenue (BIR). Belgium You can optionally specify the peppolId in the belgiumAdditionalInfo field of the additionalTaxInformation object. Chile You can optionally specify the documentType and businessActivity in the chileAdditionalInfo field of the additionalTaxInformation object. France You must specify the sirenNumber in the franceAdditionalInfo field of the additionalTaxInformation object. Poland You can optionally specify the taxRegistrationNumberType in the polandAdditionalInfo field of the additionalTaxInformation object. Valid values are EUTaxRegistrationNumber, LocalTaxRegistrationNumber, or LocalRegistrationNumber." parameters: [] requestBody: required: true @@ -426,7 +425,7 @@ components: type: string minLength: 12 maxLength: 12 - pattern: ^\d+$ + pattern: \d+ BatchDeleteTaxRegistrationResponse: type: object properties: @@ -446,25 +445,25 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: The unique account identifier for the account whose tax registration couldn't be deleted during the BatchDeleteTaxRegistration operation. - code: - $ref: "#/components/schemas/ErrorCode" - description: The error code for an individual failure in BatchDeleteTaxRegistration operation. message: $ref: "#/components/schemas/ErrorMessage" description: The error message for an individual failure in the BatchDeleteTaxRegistration operation. + code: + $ref: "#/components/schemas/ErrorCode" + description: The error code for an individual failure in BatchDeleteTaxRegistration operation. required: - accountId - message - ErrorCode: - type: string - minLength: 0 - maxLength: 50 - pattern: ^[\s\S]*$ ErrorMessage: type: string minLength: 0 maxLength: 1024 - pattern: ^[\s\S]*$ + pattern: "[\\s\\S]*" + ErrorCode: + type: string + minLength: 0 + maxLength: 50 + pattern: "[\\s\\S]*" BatchGetTaxExemptionsRequestAccountIdsList: type: array items: @@ -472,13 +471,13 @@ components: BatchGetTaxExemptionsResponse: type: object properties: - failedAccounts: - $ref: "#/components/schemas/AccountIds" - description: The list of accounts that failed to get tax exemptions. taxExemptionDetailsMap: type: object properties: {} description: The tax exemption details map of accountId and tax exemption details. + failedAccounts: + $ref: "#/components/schemas/AccountIds" + description: The list of accounts that failed to get tax exemptions. AccountIds: type: array items: @@ -491,138 +490,257 @@ components: description: The TRN information you provide when you add a new TRN, or update. type: object properties: - additionalTaxInformation: - $ref: "#/components/schemas/AdditionalInfoRequest" - description: Additional tax information associated with your TRN. You only need to specify this parameter if Amazon Web Services collects any additional information for your country within AdditionalInfoRequest. - certifiedEmailId: - $ref: "#/components/schemas/CertifiedEmailId" - description: The email address to receive VAT invoices. - legalAddress: - $ref: "#/components/schemas/Address" - description: The legal address associated with your TRN. If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the legal address. For TRNs in other countries and for CPF tax types Brazil, you must specify the legal address. - legalName: - $ref: "#/components/schemas/LegalName" - description: The legal name associated with your TRN. If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in other countries, you must specify the legal name. registrationId: $ref: "#/components/schemas/RegistrationId" description: Your tax registration unique identifier. registrationType: $ref: "#/components/schemas/TaxRegistrationType" description: Your tax registration type. This can be either VAT or GST. + legalName: + $ref: "#/components/schemas/LegalName" + description: The legal name associated with your TRN. If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in other countries, you must specify the legal name. + legalAddress: + $ref: "#/components/schemas/Address" + description: The legal address associated with your TRN. If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the legal address. For TRNs in other countries and for CPF tax types Brazil, you must specify the legal address. sector: $ref: "#/components/schemas/Sector" description: The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document. + additionalTaxInformation: + $ref: "#/components/schemas/AdditionalInfoRequest" + description: Additional tax information associated with your TRN. You only need to specify this parameter if Amazon Web Services collects any additional information for your country within AdditionalInfoRequest. verificationDetails: $ref: "#/components/schemas/VerificationDetails" description: Additional details needed to verify your TRN information in Brazil. You only need to specify this parameter when you set a TRN in Brazil that is the CPF tax type. Don't specify this parameter to set a TRN in Brazil of the CNPJ tax type or to set a TRN for another country. + certifiedEmailId: + $ref: "#/components/schemas/CertifiedEmailId" + description: The email address to receive VAT invoices. required: - registrationId - registrationType + RegistrationId: + type: string + minLength: 1 + maxLength: 200 + pattern: (?!\s*$)[\s\S]+ + TaxRegistrationType: + type: string + enum: + - VAT + - GST + - CPF + - CNPJ + - SST + - TIN + - NRIC + - PAN + - NIP + LegalName: + type: string + minLength: 1 + maxLength: 200 + pattern: (?!\s*$)[\s\S]+ + Address: + description: The details of the address associated with the TRN information. + type: object + properties: + addressLine1: + $ref: "#/components/schemas/AddressLine1" + description: The first line of the address. + addressLine2: + $ref: "#/components/schemas/AddressLine2" + description: The second line of the address, if applicable. + addressLine3: + $ref: "#/components/schemas/AddressLine3" + description: The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234. + districtOrCounty: + $ref: "#/components/schemas/District" + description: The district or county the address is located. For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name. + city: + $ref: "#/components/schemas/City" + description: The city that the address is in. + stateOrRegion: + $ref: "#/components/schemas/State" + description: The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries. If this is required for tax settings, use the same name as shown on the Tax Settings page. + postalCode: + $ref: "#/components/schemas/PostalCode" + description: The postal code associated with the address. + countryCode: + $ref: "#/components/schemas/CountryCode" + description: The country code for the country that the address is in. + required: + - postalCode + - countryCode + AddressLine1: + type: string + minLength: 1 + maxLength: 180 + pattern: (?!\s*$)[\s\S]+ + AddressLine2: + type: string + minLength: 1 + maxLength: 60 + pattern: (?!\s*$)[\s\S]+ + AddressLine3: + type: string + minLength: 1 + maxLength: 60 + pattern: (?!\s*$)[\s\S]+ + District: + type: string + minLength: 1 + maxLength: 50 + pattern: (?!\s*$)[\s\S]+ + City: + type: string + minLength: 1 + maxLength: 50 + pattern: (?!\s*$)[\s\S]+ + State: + type: string + minLength: 1 + maxLength: 50 + pattern: (?!\s*$)[\s\S]+ + PostalCode: + type: string + minLength: 1 + maxLength: 20 + pattern: (?!\s*$)[\s\S]+ + CountryCode: + type: string + minLength: 2 + maxLength: 2 + pattern: "[a-zA-Z]+" + Sector: + type: string + enum: + - Business + - Individual + - Government AdditionalInfoRequest: description: Additional tax information associated with your tax registration number (TRN). Depending on the TRN for a specific country, you might need to specify this information when you set your TRN. You can only specify one of the following parameters and the value can't be empty. The parameter that you specify must match the country for the TRN, if available. For example, if you set a TRN in Canada for specific provinces, you must also specify the canadaAdditionalInfo parameter. type: object properties: - canadaAdditionalInfo: - $ref: "#/components/schemas/CanadaAdditionalInfo" - description: Additional tax information associated with your TRN in Canada. - egyptAdditionalInfo: - $ref: "#/components/schemas/EgyptAdditionalInfo" - description: Additional tax information to specify for a TRN in Egypt. - estoniaAdditionalInfo: - $ref: "#/components/schemas/EstoniaAdditionalInfo" - description: Additional tax information to specify for a TRN in Estonia. - georgiaAdditionalInfo: - $ref: "#/components/schemas/GeorgiaAdditionalInfo" - description: Additional tax information to specify for a TRN in Georgia. - greeceAdditionalInfo: - $ref: "#/components/schemas/GreeceAdditionalInfo" - description: Additional tax information to specify for a TRN in Greece. - indonesiaAdditionalInfo: - $ref: "#/components/schemas/IndonesiaAdditionalInfo" + malaysiaAdditionalInfo: + $ref: "#/components/schemas/MalaysiaAdditionalInfo" + description: Additional tax information to specify for a TRN in Malaysia. israelAdditionalInfo: $ref: "#/components/schemas/IsraelAdditionalInfo" description: Additional tax information to specify for a TRN in Israel. - italyAdditionalInfo: - $ref: "#/components/schemas/ItalyAdditionalInfo" - description: Additional tax information to specify for a TRN in Italy. + estoniaAdditionalInfo: + $ref: "#/components/schemas/EstoniaAdditionalInfo" + description: Additional tax information to specify for a TRN in Estonia. + canadaAdditionalInfo: + $ref: "#/components/schemas/CanadaAdditionalInfo" + description: Additional tax information associated with your TRN in Canada. + spainAdditionalInfo: + $ref: "#/components/schemas/SpainAdditionalInfo" + description: Additional tax information to specify for a TRN in Spain. kenyaAdditionalInfo: $ref: "#/components/schemas/KenyaAdditionalInfo" description: Additional tax information to specify for a TRN in Kenya. - malaysiaAdditionalInfo: - $ref: "#/components/schemas/MalaysiaAdditionalInfo" - description: Additional tax information to specify for a TRN in Malaysia. - polandAdditionalInfo: - $ref: "#/components/schemas/PolandAdditionalInfo" - description: Additional tax information associated with your TRN in Poland. - romaniaAdditionalInfo: - $ref: "#/components/schemas/RomaniaAdditionalInfo" - description: Additional tax information to specify for a TRN in Romania. - saudiArabiaAdditionalInfo: - $ref: "#/components/schemas/SaudiArabiaAdditionalInfo" - description: Additional tax information associated with your TRN in Saudi Arabia. southKoreaAdditionalInfo: $ref: "#/components/schemas/SouthKoreaAdditionalInfo" description: Additional tax information to specify for a TRN in South Korea. - spainAdditionalInfo: - $ref: "#/components/schemas/SpainAdditionalInfo" - description: Additional tax information to specify for a TRN in Spain. turkeyAdditionalInfo: $ref: "#/components/schemas/TurkeyAdditionalInfo" description: Additional tax information to specify for a TRN in Turkey. + georgiaAdditionalInfo: + $ref: "#/components/schemas/GeorgiaAdditionalInfo" + description: Additional tax information to specify for a TRN in Georgia. + italyAdditionalInfo: + $ref: "#/components/schemas/ItalyAdditionalInfo" + description: Additional tax information to specify for a TRN in Italy. + romaniaAdditionalInfo: + $ref: "#/components/schemas/RomaniaAdditionalInfo" + description: Additional tax information to specify for a TRN in Romania. ukraineAdditionalInfo: $ref: "#/components/schemas/UkraineAdditionalInfo" description: Additional tax information associated with your TRN in Ukraine. - uzbekistanAdditionalInfo: - $ref: "#/components/schemas/UzbekistanAdditionalInfo" - description: Additional tax information to specify for a TRN in Uzbekistan. + polandAdditionalInfo: + $ref: "#/components/schemas/PolandAdditionalInfo" + description: Additional tax information associated with your TRN in Poland. + saudiArabiaAdditionalInfo: + $ref: "#/components/schemas/SaudiArabiaAdditionalInfo" + description: Additional tax information associated with your TRN in Saudi Arabia. + indonesiaAdditionalInfo: + $ref: "#/components/schemas/IndonesiaAdditionalInfo" vietnamAdditionalInfo: $ref: "#/components/schemas/VietnamAdditionalInfo" description: Additional tax information to specify for a TRN in Vietnam. - CanadaAdditionalInfo: - description: Additional tax information associated with your TRN in Canada . + egyptAdditionalInfo: + $ref: "#/components/schemas/EgyptAdditionalInfo" + description: Additional tax information to specify for a TRN in Egypt. + greeceAdditionalInfo: + $ref: "#/components/schemas/GreeceAdditionalInfo" + description: Additional tax information to specify for a TRN in Greece. + uzbekistanAdditionalInfo: + $ref: "#/components/schemas/UzbekistanAdditionalInfo" + description: Additional tax information to specify for a TRN in Uzbekistan. + philippinesAdditionalInfo: + $ref: "#/components/schemas/PhilippinesAdditionalInfo" + description: Additional tax information to specify for a TRN in the Philippines. + belgiumAdditionalInfo: + $ref: "#/components/schemas/BelgiumAdditionalInfo" + description: Additional tax information to specify for a TRN in Belgium. + chileAdditionalInfo: + $ref: "#/components/schemas/ChileAdditionalInfo" + description: Additional tax information to specify for a TRN in Chile. + franceAdditionalInfo: + $ref: "#/components/schemas/FranceAdditionalInfo" + description: Additional tax information to specify for a TRN in France. + MalaysiaAdditionalInfo: + description: Additional tax information associated with your TRN in Malaysia. type: object properties: - canadaQuebecSalesTaxNumber: - $ref: "#/components/schemas/CanadaQuebecSalesTaxNumberString" - description: The Quebec Sales Tax ID number. Leave blank if you do not have a Quebec Sales Tax ID number. - canadaRetailSalesTaxNumber: - $ref: "#/components/schemas/CanadaRetailSalesTaxNumberString" - description: Manitoba Retail Sales Tax ID number. Customers purchasing Amazon Web Services services for resale in Manitoba must provide a valid Retail Sales Tax ID number for Manitoba. Leave this blank if you do not have a Retail Sales Tax ID number in Manitoba or are not purchasing Amazon Web Services services for resale. - isResellerAccount: - $ref: "#/components/schemas/Boolean" - description: The value for this parameter must be true if the provincialSalesTaxId value is provided for a TRN in British Columbia, Saskatchewan, or Manitoba provinces. To claim a provincial sales tax (PST) and retail sales tax (RST) reseller exemption, you must confirm that purchases from this account were made for resale. Otherwise, remove the PST or RST number from the provincialSalesTaxId parameter from your request. - provincialSalesTaxId: - $ref: "#/components/schemas/CanadaProvincialSalesTaxIdString" - description: "The provincial sales tax ID for your TRN in Canada. This parameter can represent the following: Provincial sales tax ID number for British Columbia and Saskatchewan provinces Manitoba retail sales tax ID number for Manitoba province Quebec sales tax ID number for Quebec province The Tax Setting API only accepts this parameter if the TRN is specified for the previous provinces. For other provinces, the Tax Settings API doesn't accept this parameter." - CanadaQuebecSalesTaxNumberString: + serviceTaxCodes: + $ref: "#/components/schemas/MalaysiaServiceTaxCodesList" + description: List of service tax codes for your TRN in Malaysia. + taxInformationNumber: + $ref: "#/components/schemas/TaxInformationNumber" + description: The tax information number in Malaysia. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. + businessRegistrationNumber: + $ref: "#/components/schemas/BusinessRegistrationNumber" + description: The tax registration number (TRN) in Malaysia. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. + MalaysiaServiceTaxCodesList: + type: array + items: + $ref: "#/components/schemas/MalaysiaServiceTaxCode" + MalaysiaServiceTaxCode: type: string - pattern: ^([0-9]{10})(TQ[0-9]{4})?$ - CanadaRetailSalesTaxNumberString: + enum: + - Consultancy + - Digital Service And Electronic Medium + - IT Services + - Training Or Coaching + TaxInformationNumber: type: string - pattern: ^([0-9]{6}-[0-9]{1})$ - Boolean: - type: boolean - CanadaProvincialSalesTaxIdString: + pattern: (IG|C|CS|P|D|F|FA|PT|TA|TC|TN|TR|TP|J|LE)[0-9]{10,13} + BusinessRegistrationNumber: type: string - minLength: 7 - maxLength: 16 - pattern: ^([0-9A-Z/-]+)$ - EgyptAdditionalInfo: - description: Additional tax information to specify for a TRN in Egypt. + pattern: ([0-9]{12}|LL[0-9]{5}) + IsraelAdditionalInfo: + description: Additional tax information associated with your TRN in Israel. type: object properties: - uniqueIdentificationNumber: - $ref: "#/components/schemas/UniqueIdentificationNumber" - description: The unique identification number provided by the Egypt Tax Authority. - uniqueIdentificationNumberExpirationDate: - $ref: "#/components/schemas/DateString" - description: The expiration date of the unique identification number provided by the Egypt Tax Authority. - UniqueIdentificationNumber: + dealerType: + $ref: "#/components/schemas/IsraelDealerType" + description: Dealer type for your TRN in Israel. If you're not a local authorized dealer with an Israeli VAT ID, specify your tax identification number so that Amazon Web Services can send you a compliant tax invoice. + customerType: + $ref: "#/components/schemas/IsraelCustomerType" + description: Customer type for your TRN in Israel. The value can be Business or Individual. Use Businessfor entities such as not-for-profit and financial institutions. + required: + - dealerType + - customerType + IsraelDealerType: type: string - pattern: ^[a-zA-Z0-9]{39}$ - DateString: + enum: + - Authorized + - Non-authorized + IsraelCustomerType: type: string - pattern: ^(\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1]))$ + enum: + - Business + - Individual EstoniaAdditionalInfo: description: Additional tax information associated with your TRN in Estonia. type: object @@ -636,109 +754,50 @@ components: type: string minLength: 8 maxLength: 8 - pattern: ^\d+$ - GeorgiaAdditionalInfo: - description: Additional tax information associated with your TRN in Georgia. - type: object - properties: - personType: - $ref: "#/components/schemas/PersonType" - description: The legal person or physical person assigned to this TRN in Georgia. - required: - - personType - PersonType: - type: string - enum: - - Legal Person - - Physical Person - - Business - GreeceAdditionalInfo: - description: Additional tax information to specify for a TRN in Greece. - type: object - properties: - contractingAuthorityCode: - $ref: "#/components/schemas/ContractingAuthorityCode" - description: The code of contracting authority for e-invoicing. - ContractingAuthorityCode: - type: string - pattern: ^\d{4}\.[A-Z]\d{5}\.\d{4}$ - IndonesiaAdditionalInfo: - description: Additional tax information associated with your TRN in Indonesia. + pattern: \d+ + CanadaAdditionalInfo: + description: Additional tax information associated with your TRN in Canada . type: object properties: - decisionNumber: - $ref: "#/components/schemas/DecisionNumber" - description: VAT-exempt customers have a Directorate General of Taxation (DGT) exemption letter or certificate (Surat Keterangan Bebas) decision number. Non-collected VAT have a DGT letter or certificate (Surat Keterangan Tidak Dipungut). - ppnExceptionDesignationCode: - $ref: "#/components/schemas/PpnExceptionDesignationCode" - description: Exception code if you are designated by Directorate General of Taxation (DGT) as a VAT collector, non-collected VAT, or VAT-exempt customer. - taxRegistrationNumberType: - $ref: "#/components/schemas/IndonesiaTaxRegistrationNumberType" - description: The tax registration number type. - DecisionNumber: + provincialSalesTaxId: + $ref: "#/components/schemas/CanadaProvincialSalesTaxIdString" + description: "The provincial sales tax ID for your TRN in Canada. This parameter can represent the following: Provincial sales tax ID number for British Columbia and Saskatchewan provinces Manitoba retail sales tax ID number for Manitoba province Quebec sales tax ID number for Quebec province The Tax Setting API only accepts this parameter if the TRN is specified for the previous provinces. For other provinces, the Tax Settings API doesn't accept this parameter." + canadaQuebecSalesTaxNumber: + $ref: "#/components/schemas/CanadaQuebecSalesTaxNumberString" + description: The Quebec Sales Tax ID number. Leave blank if you do not have a Quebec Sales Tax ID number. + canadaRetailSalesTaxNumber: + $ref: "#/components/schemas/CanadaRetailSalesTaxNumberString" + description: Manitoba Retail Sales Tax ID number. Customers purchasing Amazon Web Services services for resale in Manitoba must provide a valid Retail Sales Tax ID number for Manitoba. Leave this blank if you do not have a Retail Sales Tax ID number in Manitoba or are not purchasing Amazon Web Services services for resale. + isResellerAccount: + $ref: "#/components/schemas/Boolean" + description: The value for this parameter must be true if the provincialSalesTaxId value is provided for a TRN in British Columbia, Saskatchewan, or Manitoba provinces. To claim a provincial sales tax (PST) and retail sales tax (RST) reseller exemption, you must confirm that purchases from this account were made for resale. Otherwise, remove the PST or RST number from the provincialSalesTaxId parameter from your request. + CanadaProvincialSalesTaxIdString: type: string - pattern: ^([a-zA-Z0-9/.\-]{0,200})$ - PpnExceptionDesignationCode: + minLength: 7 + maxLength: 16 + pattern: ([0-9A-Z/-]+) + CanadaQuebecSalesTaxNumberString: type: string - pattern: ^(01|02|03|07|08)$ - IndonesiaTaxRegistrationNumberType: + pattern: ([0-9]{10})(TQ[0-9]{4})? + CanadaRetailSalesTaxNumberString: type: string - enum: - - NIK - - PassportNumber - - NPWP - - NITKU - IsraelAdditionalInfo: - description: Additional tax information associated with your TRN in Israel. + pattern: ([0-9]{6}-[0-9]{1}) + Boolean: + type: boolean + SpainAdditionalInfo: + description: Additional tax information associated with your TRN in Spain. type: object properties: - customerType: - $ref: "#/components/schemas/IsraelCustomerType" - description: Customer type for your TRN in Israel. The value can be Business or Individual. Use Businessfor entities such as not-for-profit and financial institutions. - dealerType: - $ref: "#/components/schemas/IsraelDealerType" - description: Dealer type for your TRN in Israel. If you're not a local authorized dealer with an Israeli VAT ID, specify your tax identification number so that Amazon Web Services can send you a compliant tax invoice. + registrationType: + $ref: "#/components/schemas/RegistrationType" + description: The registration type in Spain. required: - - customerType - - dealerType - IsraelCustomerType: - type: string - enum: - - Business - - Individual - IsraelDealerType: + - registrationType + RegistrationType: type: string enum: - - Authorized - - Non-authorized - ItalyAdditionalInfo: - description: Additional tax information associated with your TRN in Italy. - type: object - properties: - cigNumber: - $ref: "#/components/schemas/CigNumber" - description: The tender procedure identification code. - cupNumber: - $ref: "#/components/schemas/CupNumber" - description: Additional tax information to specify for a TRN in Italy. This is managed by the Interministerial Committee for Economic Planning (CIPE) which characterizes every public investment project (Individual Project Code). - sdiAccountId: - $ref: "#/components/schemas/SdiAccountId" - description: Additional tax information to specify for a TRN in Italy. Use CodiceDestinatario to receive your invoices via web service (API) or FTP. - taxCode: - $ref: "#/components/schemas/TaxCode" - description: List of service tax codes for your TRN in Italy. You can use your customer tax code as part of a VAT Group. - CigNumber: - type: string - pattern: ^([0-9A-Z]{1,15})$ - CupNumber: - type: string - pattern: ^([0-9A-Z]{1,15})$ - SdiAccountId: - type: string - pattern: ^[0-9A-Z]{6,7}$ - TaxCode: - type: string - pattern: ^([0-9]{11}|[A-Z]{6}[0-9]{2}[A-Z][0-9]{2}[A-Z][0-9]{3}[A-Z])$ + - Intra-EU + - Local KenyaAdditionalInfo: description: Additional tax information associated with your TRN in Kenya. type: object @@ -748,76 +807,12 @@ components: description: The legal person or physical person assigned to this TRN in Kenya. required: - personType - MalaysiaAdditionalInfo: - description: Additional tax information associated with your TRN in Malaysia. - type: object - properties: - businessRegistrationNumber: - $ref: "#/components/schemas/BusinessRegistrationNumber" - description: The tax registration number (TRN) in Malaysia. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. - serviceTaxCodes: - $ref: "#/components/schemas/MalaysiaServiceTaxCodesList" - description: List of service tax codes for your TRN in Malaysia. - taxInformationNumber: - $ref: "#/components/schemas/TaxInformationNumber" - description: The tax information number in Malaysia. For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number. For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number. For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you’re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number. - BusinessRegistrationNumber: - type: string - pattern: ^[0-9]{12}$ - MalaysiaServiceTaxCodesList: - type: array - items: - $ref: "#/components/schemas/MalaysiaServiceTaxCode" - MalaysiaServiceTaxCode: - type: string - enum: - - Consultancy - - Digital Service And Electronic Medium - - IT Services - - Training Or Coaching - TaxInformationNumber: - type: string - pattern: ^[A-Z]{1,2}[0-9]{1,11}$ - PolandAdditionalInfo: - description: Additional tax information associated with your TRN in Poland. - type: object - properties: - individualRegistrationNumber: - $ref: "#/components/schemas/IndividualRegistrationNumber" - description: The individual tax registration number (NIP). Individual NIP is valid for other taxes excluding VAT purposes. - isGroupVatEnabled: - $ref: "#/components/schemas/Boolean" - description: True if your business is a member of a VAT group with a NIP active for VAT purposes. Otherwise, this is false. - IndividualRegistrationNumber: - type: string - pattern: ^([0-9]{10})$ - RomaniaAdditionalInfo: - description: Additional tax information to specify for a TRN in Romania. - type: object - properties: - taxRegistrationNumberType: - $ref: "#/components/schemas/TaxRegistrationNumberType" - description: The tax registration number type. The value can be TaxRegistrationNumber or LocalRegistrationNumber. - required: - - taxRegistrationNumberType - TaxRegistrationNumberType: - type: string - enum: - - TaxRegistrationNumber - - LocalRegistrationNumber - SaudiArabiaAdditionalInfo: - description: Additional tax information associated with your TRN in Saudi Arabia. - type: object - properties: - taxRegistrationNumberType: - $ref: "#/components/schemas/SaudiArabiaTaxRegistrationNumberType" - description: The tax registration number type. - SaudiArabiaTaxRegistrationNumberType: + PersonType: type: string enum: - - TaxRegistrationNumber - - TaxIdentificationNumber - - CommercialRegistrationNumber + - Legal Person + - Physical Person + - Business SouthKoreaAdditionalInfo: description: Additional tax information associated with your TRN in South Korea. type: object @@ -825,61 +820,56 @@ components: businessRepresentativeName: $ref: "#/components/schemas/BusinessRepresentativeName" description: The business legal name based on the most recently uploaded tax registration certificate. - itemOfBusiness: - $ref: "#/components/schemas/ItemOfBusiness" - description: Item of business based on the most recently uploaded tax registration certificate. lineOfBusiness: $ref: "#/components/schemas/LineOfBusiness" description: Line of business based on the most recently uploaded tax registration certificate. + itemOfBusiness: + $ref: "#/components/schemas/ItemOfBusiness" + description: Item of business based on the most recently uploaded tax registration certificate. required: - businessRepresentativeName - - itemOfBusiness - lineOfBusiness + - itemOfBusiness BusinessRepresentativeName: type: string minLength: 1 maxLength: 200 - pattern: ^[0-9\u3130-\u318F\uAC00-\uD7AF,.( )-\\s]*$ - ItemOfBusiness: + pattern: "[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*" + LineOfBusiness: type: string minLength: 1 maxLength: 100 - pattern: ^[0-9\u3130-\u318F\uAC00-\uD7AF,.( )-\\s]*$ - LineOfBusiness: + pattern: "[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*" + ItemOfBusiness: type: string minLength: 1 maxLength: 100 - pattern: ^[0-9\u3130-\u318F\uAC00-\uD7AF,.( )-\\s]*$ - SpainAdditionalInfo: - description: Additional tax information associated with your TRN in Spain. - type: object - properties: - registrationType: - $ref: "#/components/schemas/RegistrationType" - description: The registration type in Spain. - required: - - registrationType - RegistrationType: - type: string - enum: - - Intra-EU - - Local + pattern: "[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*" TurkeyAdditionalInfo: description: Additional tax information associated with your TRN in Turkey. type: object properties: - industries: - $ref: "#/components/schemas/Industries" - description: The industry information that tells the Tax Settings API if you're subject to additional withholding taxes. This information required for business-to-business (B2B) customers. This information is conditionally mandatory for B2B customers who are subject to KDV tax. + taxOffice: + $ref: "#/components/schemas/TaxOffice" + description: The tax office where you're registered. You can enter this information as a string. The Tax Settings API will add this information to your invoice. This parameter is required for business-to-business (B2B) and business-to-government customers. It's not required for business-to-consumer (B2C) customers. kepEmailId: $ref: "#/components/schemas/KepEmailId" description: The Registered Electronic Mail (REM) that is used to send notarized communication. This parameter is optional for business-to-business (B2B) and business-to-government (B2G) customers. It's not required for business-to-consumer (B2C) customers. secondaryTaxId: $ref: "#/components/schemas/SecondaryTaxId" description: Secondary tax ID (“harcama birimi VKN”si”). If one isn't provided, we will use your VKN as the secondary ID. - taxOffice: - $ref: "#/components/schemas/TaxOffice" - description: The tax office where you're registered. You can enter this information as a string. The Tax Settings API will add this information to your invoice. This parameter is required for business-to-business (B2B) and business-to-government customers. It's not required for business-to-consumer (B2C) customers. + industries: + $ref: "#/components/schemas/Industries" + description: The industry information that tells the Tax Settings API if you're subject to additional withholding taxes. This information required for business-to-business (B2B) customers. This information is conditionally mandatory for B2B customers who are subject to KDV tax. + TaxOffice: + type: string + pattern: "[\\s\\S]*" + KepEmailId: + type: string + pattern: "[\\s\\S]*" + SecondaryTaxId: + type: string + pattern: ([0-9]{10}) Industries: type: string enum: @@ -889,15 +879,65 @@ components: - Insurance - PensionAndBenefitFunds - DevelopmentAgencies - KepEmailId: + GeorgiaAdditionalInfo: + description: Additional tax information associated with your TRN in Georgia. + type: object + properties: + personType: + $ref: "#/components/schemas/PersonType" + description: The legal person or physical person assigned to this TRN in Georgia. + required: + - personType + ItalyAdditionalInfo: + description: Additional tax information associated with your TRN in Italy. + type: object + properties: + sdiAccountId: + $ref: "#/components/schemas/SdiAccountId" + description: Additional tax information to specify for a TRN in Italy. Use CodiceDestinatario to receive your invoices via web service (API) or FTP. + cigNumber: + $ref: "#/components/schemas/CigNumber" + description: The tender procedure identification code. + cupNumber: + $ref: "#/components/schemas/CupNumber" + description: Additional tax information to specify for a TRN in Italy. This is managed by the Interministerial Committee for Economic Planning (CIPE) which characterizes every public investment project (Individual Project Code). + taxCode: + $ref: "#/components/schemas/TaxCode" + description: List of service tax codes for your TRN in Italy. You can use your customer tax code as part of a VAT Group. + customerType: + $ref: "#/components/schemas/CustomerType" + description: The customer type for tax registration in Italy. Valid values are Business or Individual. + SdiAccountId: type: string - pattern: ^[\s\S]*$ - SecondaryTaxId: + pattern: "[0-9A-Z]{6,7}" + CigNumber: type: string - pattern: ^([0-9]{10})$ - TaxOffice: + pattern: ([0-9A-Z]{1,15}) + CupNumber: + type: string + pattern: ([0-9A-Z]{1,15}) + TaxCode: + type: string + pattern: ([0-9]{11}|[A-Z]{6}[0-9]{2}[A-Z][0-9]{2}[A-Z][0-9]{3}[A-Z]) + CustomerType: + type: string + enum: + - Business + - Individual + RomaniaAdditionalInfo: + description: Additional tax information to specify for a TRN in Romania. + type: object + properties: + taxRegistrationNumberType: + $ref: "#/components/schemas/TaxRegistrationNumberType" + description: The tax registration number type. The value can be TaxRegistrationNumber or LocalRegistrationNumber. + required: + - taxRegistrationNumberType + TaxRegistrationNumberType: type: string - pattern: ^[\s\S]*$ + enum: + - TaxRegistrationNumber + - LocalRegistrationNumber UkraineAdditionalInfo: description: Additional tax information associated with your TRN in Ukraine. type: object @@ -912,151 +952,189 @@ components: enum: - Business - Individual - UzbekistanAdditionalInfo: - description: Additional tax information to specify for a TRN in Uzbekistan. + PolandAdditionalInfo: + description: Additional tax information associated with your TRN in Poland. type: object properties: + individualRegistrationNumber: + $ref: "#/components/schemas/IndividualRegistrationNumber" + description: The individual tax registration number (NIP). Individual NIP is valid for other taxes excluding VAT purposes. + isGroupVatEnabled: + $ref: "#/components/schemas/Boolean" + description: True if your business is a member of a VAT group with a NIP active for VAT purposes. Otherwise, this is false. taxRegistrationNumberType: - $ref: "#/components/schemas/UzbekistanTaxRegistrationNumberType" - description: The tax registration number type. The tax registration number type valid values are Business and Individual. - vatRegistrationNumber: - $ref: "#/components/schemas/VatRegistrationNumber" - description: The unique 12-digit number issued to identify VAT-registered identities in Uzbekistan. - UzbekistanTaxRegistrationNumberType: + $ref: "#/components/schemas/PolandTaxRegistrationNumberType" + description: The tax registration number type. Valid values are EUTaxRegistrationNumber, LocalTaxRegistrationNumber, or LocalRegistrationNumber. + IndividualRegistrationNumber: + type: string + pattern: ([0-9]{10}) + PolandTaxRegistrationNumberType: type: string enum: - - Business - - Individual - VatRegistrationNumber: + - EUTaxRegistrationNumber + - LocalTaxRegistrationNumber + - LocalRegistrationNumber + SaudiArabiaAdditionalInfo: + description: Additional tax information associated with your TRN in Saudi Arabia. + type: object + properties: + taxRegistrationNumberType: + $ref: "#/components/schemas/SaudiArabiaTaxRegistrationNumberType" + description: The tax registration number type. + SaudiArabiaTaxRegistrationNumberType: + type: string + enum: + - TaxRegistrationNumber + - TaxIdentificationNumber + - CommercialRegistrationNumber + IndonesiaAdditionalInfo: + description: Additional tax information associated with your TRN in Indonesia. + type: object + properties: + taxRegistrationNumberType: + $ref: "#/components/schemas/IndonesiaTaxRegistrationNumberType" + description: The tax registration number type. + ppnExceptionDesignationCode: + $ref: "#/components/schemas/PpnExceptionDesignationCode" + description: Exception code if you are designated by Directorate General of Taxation (DGT) as a VAT collector, non-collected VAT, or VAT-exempt customer. + decisionNumber: + $ref: "#/components/schemas/DecisionNumber" + description: VAT-exempt customers have a Directorate General of Taxation (DGT) exemption letter or certificate (Surat Keterangan Bebas) decision number. Non-collected VAT have a DGT letter or certificate (Surat Keterangan Tidak Dipungut). + IndonesiaTaxRegistrationNumberType: + type: string + enum: + - NIK + - PassportNumber + - NPWP + - NITKU + PpnExceptionDesignationCode: + type: string + pattern: (01|02|03|07|08) + DecisionNumber: type: string - pattern: ^[0-9]{12}$ + pattern: ([a-zA-Z0-9/.\-]{0,200}) VietnamAdditionalInfo: description: Additional tax information to specify for a TRN in Vietnam. type: object properties: - electronicTransactionCodeNumber: - $ref: "#/components/schemas/ElectronicTransactionCodeNumber" - description: The electronic transaction code number on the tax return document. This field must be provided for successful API operation. enterpriseIdentificationNumber: $ref: "#/components/schemas/EnterpriseIdentificationNumber" description: The enterprise identification number for tax registration. This field must be provided for successful API operation. + electronicTransactionCodeNumber: + $ref: "#/components/schemas/ElectronicTransactionCodeNumber" + description: The electronic transaction code number on the tax return document. This field must be provided for successful API operation. paymentVoucherNumber: $ref: "#/components/schemas/PaymentVoucherNumber" description: The payment voucher number on the tax return payment document. This field must be provided for successful API operation. paymentVoucherNumberDate: $ref: "#/components/schemas/DateString" description: The date on the tax return payment document. This field must be provided for successful API operation. - ElectronicTransactionCodeNumber: - type: string - pattern: ^\d{17}$ EnterpriseIdentificationNumber: type: string - pattern: ^(\d{10}|(\d{10}-\d{3}))$ + pattern: (\d{10}|(\d{10}-\d{3})) + ElectronicTransactionCodeNumber: + type: string + pattern: \d{17} PaymentVoucherNumber: type: string - pattern: ^(\d{17}|[A-Za-z]{3}\d{13})$ - CertifiedEmailId: + pattern: (\d{17}|[A-Za-z]{3}\d{13}|(?=[^A-Za-z]*[A-Za-z][^A-Za-z]*$)[0-9A-Za-z]{17}) + DateString: type: string - pattern: ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,20}$ - Address: - description: The details of the address associated with the TRN information. + pattern: (\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])) + EgyptAdditionalInfo: + description: Additional tax information to specify for a TRN in Egypt. type: object properties: - addressLine1: - $ref: "#/components/schemas/AddressLine1" - description: The first line of the address. - addressLine2: - $ref: "#/components/schemas/AddressLine2" - description: The second line of the address, if applicable. - addressLine3: - $ref: "#/components/schemas/AddressLine3" - description: The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234. - city: - $ref: "#/components/schemas/City" - description: The city that the address is in. - countryCode: - $ref: "#/components/schemas/CountryCode" - description: The country code for the country that the address is in. - districtOrCounty: - $ref: "#/components/schemas/District" - description: The district or county the address is located. For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name. - postalCode: - $ref: "#/components/schemas/PostalCode" - description: The postal code associated with the address. - stateOrRegion: - $ref: "#/components/schemas/State" - description: The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries. If this is required for tax settings, use the same name as shown on the Tax Settings page. - required: - - addressLine1 - - city - - countryCode - - postalCode - AddressLine1: - type: string - minLength: 1 - maxLength: 180 - pattern: ^(?!\s*$)[\s\S]+$ - AddressLine2: - type: string - minLength: 1 - maxLength: 60 - pattern: ^(?!\s*$)[\s\S]+$ - AddressLine3: - type: string - minLength: 1 - maxLength: 60 - pattern: ^(?!\s*$)[\s\S]+$ - City: + uniqueIdentificationNumber: + $ref: "#/components/schemas/UniqueIdentificationNumber" + description: The unique identification number provided by the Egypt Tax Authority. + uniqueIdentificationNumberExpirationDate: + $ref: "#/components/schemas/DateString" + description: The expiration date of the unique identification number provided by the Egypt Tax Authority. + UniqueIdentificationNumber: type: string - minLength: 1 - maxLength: 50 - pattern: ^(?!\s*$)[\s\S]+$ - CountryCode: + pattern: "[a-zA-Z0-9]{39}" + GreeceAdditionalInfo: + description: Additional tax information to specify for a TRN in Greece. + type: object + properties: + contractingAuthorityCode: + $ref: "#/components/schemas/ContractingAuthorityCode" + description: The code of contracting authority for e-invoicing. + ContractingAuthorityCode: type: string - minLength: 2 - maxLength: 2 - pattern: ^[a-zA-Z]+$ - District: + pattern: \d{4}\.[A-Z]\d{5}\.\d{4} + UzbekistanAdditionalInfo: + description: Additional tax information to specify for a TRN in Uzbekistan. + type: object + properties: + taxRegistrationNumberType: + $ref: "#/components/schemas/UzbekistanTaxRegistrationNumberType" + description: The tax registration number type. The tax registration number type valid values are Business and Individual. + vatRegistrationNumber: + $ref: "#/components/schemas/VatRegistrationNumber" + description: The unique 12-digit number issued to identify VAT-registered identities in Uzbekistan. + UzbekistanTaxRegistrationNumberType: type: string - minLength: 1 - maxLength: 50 - pattern: ^(?!\s*$)[\s\S]+$ - PostalCode: + enum: + - Business + - Individual + VatRegistrationNumber: type: string - minLength: 1 - maxLength: 20 - pattern: ^(?!\s*$)[\s\S]+$ - State: + pattern: "[0-9]{12}" + PhilippinesAdditionalInfo: + description: Additional tax information associated with your TRN in the Philippines. + type: object + properties: + isVatRegistered: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the account is VAT-registered with the Philippines Bureau of Internal Revenue (BIR). + BelgiumAdditionalInfo: + description: Additional tax information associated with your TRN in Belgium. + type: object + properties: + peppolId: + $ref: "#/components/schemas/PeppolId" + description: The Peppol ID for electronic invoicing in Belgium. + isMercuriusBoxEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the Mercurius e-invoicing box is enabled for business-to-government (B2G) invoicing in Belgium. + PeppolId: type: string - minLength: 1 - maxLength: 50 - pattern: ^(?!\s*$)[\s\S]+$ - LegalName: + pattern: "[0-9]{10}" + ChileAdditionalInfo: + description: Additional tax information associated with your TRN in Chile. + type: object + properties: + documentType: + $ref: "#/components/schemas/ChileDocumentType" + description: The type of tax document. For Chile, this can be Invoice or Receipt. + businessActivity: + $ref: "#/components/schemas/GenericString" + description: The business activity of the taxpayer in Chile. + ChileDocumentType: + description: The type of tax document for Chile. type: string - minLength: 1 - maxLength: 200 - pattern: ^(?!\s*$)[\s\S]+$ - RegistrationId: + enum: + - Invoice + - Receipt + GenericString: type: string minLength: 1 maxLength: 200 - pattern: ^(?!\s*$)[\s\S]+$ - TaxRegistrationType: - type: string - enum: - - VAT - - GST - - CPF - - CNPJ - - SST - - TIN - - NRIC - Sector: + pattern: "[\\s\\S]*" + FranceAdditionalInfo: + description: Additional tax information associated with your TRN in France. + type: object + properties: + sirenNumber: + $ref: "#/components/schemas/SirenNumber" + description: The SIREN number for the company in France. Must be a 9-digit number. + required: + - sirenNumber + SirenNumber: type: string - enum: - - Business - - Individual - - Government + pattern: "[0-9]{9}" VerificationDetails: description: Required information to verify your TRN. type: object @@ -1071,7 +1149,7 @@ components: type: string minLength: 10 maxLength: 10 - pattern: ^(\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1]))$ + pattern: (\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])) TaxRegistrationDocuments: type: array items: @@ -1080,33 +1158,12 @@ components: description: Tax registration document information. type: object properties: - file: - $ref: "#/components/schemas/TaxRegistrationDocFile" - description: The tax registration document. s3Location: $ref: "#/components/schemas/SourceS3Location" description: The Amazon S3 location where your tax registration document is stored. - TaxRegistrationDocFile: - description: The tax registration document. - type: object - properties: - fileContent: - $ref: "#/components/schemas/FileBlob" - description: The tax registration document content. - fileName: - $ref: "#/components/schemas/TaxDocumentName" - description: The tax registration document name. - required: - - fileContent - - fileName - FileBlob: - type: string - format: byte - minLength: 1 - maxLength: 5242880 - TaxDocumentName: - type: string - pattern: ^[\s\S]*$ + file: + $ref: "#/components/schemas/TaxRegistrationDocFile" + description: The tax registration document. SourceS3Location: description: The Amazon S3 bucket in your account where your tax document is located. type: object @@ -1124,23 +1181,54 @@ components: type: string minLength: 3 maxLength: 63 - pattern: ^(?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$)$ + pattern: (?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$) S3Key: type: string minLength: 1 maxLength: 1024 - pattern: ^.*\S.*$ + pattern: .*\S.* + TaxRegistrationDocFile: + description: The tax registration document. + type: object + properties: + fileName: + $ref: "#/components/schemas/TaxDocumentName" + description: The tax registration document name. + fileContent: + $ref: "#/components/schemas/FileBlob" + description: The tax registration document content. + required: + - fileName + - fileContent + TaxDocumentName: + type: string + pattern: "[\\s\\S]*" + FileBlob: + type: string + format: byte + minLength: 1 + maxLength: 5242880 + CertifiedEmailId: + type: string + pattern: "[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,20}" BatchPutTaxRegistrationResponse: type: object properties: - errors: - $ref: "#/components/schemas/BatchPutTaxRegistrationErrors" - description: List of errors for the accounts the TRN information could not be added or updated to. status: $ref: "#/components/schemas/TaxRegistrationStatus" description: The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending or Rejected. + errors: + $ref: "#/components/schemas/BatchPutTaxRegistrationErrors" + description: List of errors for the accounts the TRN information could not be added or updated to. required: - errors + TaxRegistrationStatus: + type: string + enum: + - Verified + - Pending + - Deleted + - Rejected BatchPutTaxRegistrationErrors: type: array items: @@ -1152,27 +1240,15 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: The unique account identifier for the account that the tax registration couldn't be added, or updated during the BatchPutTaxRegistration operation. - code: - $ref: "#/components/schemas/ErrorCode" - description: The error code for an individual failure in the BatchPutTaxRegistration operation. message: $ref: "#/components/schemas/ErrorMessage" description: The error message for an individual failure in the BatchPutTaxRegistration operation. + code: + $ref: "#/components/schemas/ErrorCode" + description: The error code for an individual failure in the BatchPutTaxRegistration operation. required: - accountId - message - TaxRegistrationStatus: - type: string - enum: - - Verified - - Pending - - Deleted - - Rejected - GenericString: - type: string - minLength: 1 - maxLength: 200 - pattern: ^[\s\S]*$ DeleteSupplementalTaxRegistrationResponse: type: object DeleteTaxRegistrationResponse: @@ -1191,15 +1267,20 @@ components: description: The tax exemption type. type: object properties: - applicableJurisdictions: - $ref: "#/components/schemas/Authorities" - description: The tax exemption's applicable jurisdictions. - description: - $ref: "#/components/schemas/GenericString" - description: The tax exemption's type description. displayName: $ref: "#/components/schemas/DisplayName" description: The tax exemption's type display name. + description: + $ref: "#/components/schemas/GenericString" + description: The tax exemption's type description. + applicableJurisdictions: + $ref: "#/components/schemas/Authorities" + description: The tax exemption's applicable jurisdictions. + DisplayName: + type: string + minLength: 0 + maxLength: 50 + pattern: "[\\s\\S]*" Authorities: type: array items: @@ -1216,11 +1297,6 @@ components: description: The state that the address is located. required: - country - DisplayName: - type: string - minLength: 0 - maxLength: 50 - pattern: ^[\s\S]*$ GetTaxInheritanceResponse: type: object properties: @@ -1242,106 +1318,138 @@ components: description: Your TRN information. type: object properties: - additionalTaxInformation: - $ref: "#/components/schemas/AdditionalInfoResponse" - description: Additional tax information associated with your TRN. - certifiedEmailId: - $ref: "#/components/schemas/CertifiedEmailId" - description: The email address to receive VAT invoices. - legalAddress: - $ref: "#/components/schemas/Address" - description: The legal address associated with your TRN registration. - legalName: - $ref: "#/components/schemas/LegalName" - description: The legal name associated with your TRN registration. registrationId: $ref: "#/components/schemas/RegistrationId" description: Your tax registration unique identifier. registrationType: $ref: "#/components/schemas/TaxRegistrationType" description: Type of your tax registration. - sector: - $ref: "#/components/schemas/Sector" - description: The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government. Note that certain values may not applicable for the request country. Please refer to country specific information in API document. + legalName: + $ref: "#/components/schemas/LegalName" + description: The legal name associated with your TRN registration. status: $ref: "#/components/schemas/TaxRegistrationStatus" description: The status of your TRN. This can be either Verified, Pending, Deleted, or Rejected. + sector: + $ref: "#/components/schemas/Sector" + description: The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government. Note that certain values may not applicable for the request country. Please refer to country specific information in API document. taxDocumentMetadatas: $ref: "#/components/schemas/TaxDocumentMetadatas" description: The metadata for your tax document. + certifiedEmailId: + $ref: "#/components/schemas/CertifiedEmailId" + description: The email address to receive VAT invoices. + additionalTaxInformation: + $ref: "#/components/schemas/AdditionalInfoResponse" + description: Additional tax information associated with your TRN. + legalAddress: + $ref: "#/components/schemas/Address" + description: The legal address associated with your TRN registration. required: - - legalAddress - - legalName - registrationId - registrationType + - legalName - status + - legalAddress + TaxDocumentMetadatas: + type: array + items: + $ref: "#/components/schemas/TaxDocumentMetadata" + TaxDocumentMetadata: + description: The metadata for your tax document. + type: object + properties: + taxDocumentAccessToken: + $ref: "#/components/schemas/TaxDocumentAccessToken" + description: The tax document access token, which contains information that the Tax Settings API uses to locate the tax document. If you update your tax registration, the existing taxDocumentAccessToken won't be valid. To get the latest token, call the GetTaxRegistration or ListTaxRegistrations API operation. This token is valid for 24 hours. + taxDocumentName: + $ref: "#/components/schemas/TaxDocumentName" + description: The name of your tax document. + required: + - taxDocumentAccessToken + - taxDocumentName + TaxDocumentAccessToken: + type: string + pattern: "[\\s\\S]*" AdditionalInfoResponse: description: Additional tax information associated with your TRN. The Tax Settings API returns country-specific information in the response when any additional information is present with your TRN for the following countries. type: object properties: - brazilAdditionalInfo: - $ref: "#/components/schemas/BrazilAdditionalInfo" - description: Additional tax information associated with your TRN in Brazil. The Tax Settings API returns this information in your response when any additional information is present with your TRN in Brazil. - canadaAdditionalInfo: - $ref: "#/components/schemas/CanadaAdditionalInfo" - description: Additional tax information associated with your TRN in Canada. - egyptAdditionalInfo: - $ref: "#/components/schemas/EgyptAdditionalInfo" - description: Additional tax information to specify for a TRN in Egypt. - estoniaAdditionalInfo: - $ref: "#/components/schemas/EstoniaAdditionalInfo" - description: Additional tax information associated with your TRN in Estonia. - georgiaAdditionalInfo: - $ref: "#/components/schemas/GeorgiaAdditionalInfo" - description: Additional tax information associated with your TRN in Georgia. - greeceAdditionalInfo: - $ref: "#/components/schemas/GreeceAdditionalInfo" - description: Additional tax information to specify for a TRN in Greece. - indiaAdditionalInfo: - $ref: "#/components/schemas/IndiaAdditionalInfo" - description: Additional tax information in India. - indonesiaAdditionalInfo: - $ref: "#/components/schemas/IndonesiaAdditionalInfo" - description: Additional tax information associated with your TRN in Indonesia. - israelAdditionalInfo: - $ref: "#/components/schemas/IsraelAdditionalInfo" - description: Additional tax information associated with your TRN in Israel. - italyAdditionalInfo: - $ref: "#/components/schemas/ItalyAdditionalInfo" - description: Additional tax information associated with your TRN in Italy. - kenyaAdditionalInfo: - $ref: "#/components/schemas/KenyaAdditionalInfo" - description: Additional tax information associated with your TRN in Kenya. malaysiaAdditionalInfo: $ref: "#/components/schemas/MalaysiaAdditionalInfo" description: Additional tax information associated with your TRN in Malaysia. - polandAdditionalInfo: - $ref: "#/components/schemas/PolandAdditionalInfo" - description: Additional tax information associated with your TRN in Poland. - romaniaAdditionalInfo: - $ref: "#/components/schemas/RomaniaAdditionalInfo" - description: Additional tax information to specify for a TRN in Romania. - saudiArabiaAdditionalInfo: - $ref: "#/components/schemas/SaudiArabiaAdditionalInfo" - description: Additional tax information associated with your TRN in Saudi Arabia. - southKoreaAdditionalInfo: - $ref: "#/components/schemas/SouthKoreaAdditionalInfo" - description: Additional tax information associated with your TRN in South Korea. + israelAdditionalInfo: + $ref: "#/components/schemas/IsraelAdditionalInfo" + description: Additional tax information associated with your TRN in Israel. + estoniaAdditionalInfo: + $ref: "#/components/schemas/EstoniaAdditionalInfo" + description: Additional tax information associated with your TRN in Estonia. + canadaAdditionalInfo: + $ref: "#/components/schemas/CanadaAdditionalInfo" + description: Additional tax information associated with your TRN in Canada. + brazilAdditionalInfo: + $ref: "#/components/schemas/BrazilAdditionalInfo" + description: Additional tax information associated with your TRN in Brazil. The Tax Settings API returns this information in your response when any additional information is present with your TRN in Brazil. spainAdditionalInfo: $ref: "#/components/schemas/SpainAdditionalInfo" description: Additional tax information associated with your TRN in Spain. + kenyaAdditionalInfo: + $ref: "#/components/schemas/KenyaAdditionalInfo" + description: Additional tax information associated with your TRN in Kenya. + southKoreaAdditionalInfo: + $ref: "#/components/schemas/SouthKoreaAdditionalInfo" + description: Additional tax information associated with your TRN in South Korea. turkeyAdditionalInfo: $ref: "#/components/schemas/TurkeyAdditionalInfo" description: Additional tax information associated with your TRN in Turkey. + georgiaAdditionalInfo: + $ref: "#/components/schemas/GeorgiaAdditionalInfo" + description: Additional tax information associated with your TRN in Georgia. + italyAdditionalInfo: + $ref: "#/components/schemas/ItalyAdditionalInfo" + description: Additional tax information associated with your TRN in Italy. + romaniaAdditionalInfo: + $ref: "#/components/schemas/RomaniaAdditionalInfo" + description: Additional tax information to specify for a TRN in Romania. ukraineAdditionalInfo: $ref: "#/components/schemas/UkraineAdditionalInfo" description: Additional tax information associated with your TRN in Ukraine. - uzbekistanAdditionalInfo: - $ref: "#/components/schemas/UzbekistanAdditionalInfo" - description: Additional tax information associated with your TRN in Uzbekistan. + polandAdditionalInfo: + $ref: "#/components/schemas/PolandAdditionalInfo" + description: Additional tax information associated with your TRN in Poland. + saudiArabiaAdditionalInfo: + $ref: "#/components/schemas/SaudiArabiaAdditionalInfo" + description: Additional tax information associated with your TRN in Saudi Arabia. + indiaAdditionalInfo: + $ref: "#/components/schemas/IndiaAdditionalInfo" + description: Additional tax information in India. + indonesiaAdditionalInfo: + $ref: "#/components/schemas/IndonesiaAdditionalInfo" + description: Additional tax information associated with your TRN in Indonesia. vietnamAdditionalInfo: $ref: "#/components/schemas/VietnamAdditionalInfo" description: Additional tax information to specify for a TRN in Vietnam. + egyptAdditionalInfo: + $ref: "#/components/schemas/EgyptAdditionalInfo" + description: Additional tax information to specify for a TRN in Egypt. + greeceAdditionalInfo: + $ref: "#/components/schemas/GreeceAdditionalInfo" + description: Additional tax information to specify for a TRN in Greece. + uzbekistanAdditionalInfo: + $ref: "#/components/schemas/UzbekistanAdditionalInfo" + description: Additional tax information associated with your TRN in Uzbekistan. + philippinesAdditionalInfo: + $ref: "#/components/schemas/PhilippinesAdditionalInfo" + description: Additional tax information associated with your TRN in the Philippines. + belgiumAdditionalInfo: + $ref: "#/components/schemas/BelgiumAdditionalInfo" + description: Additional tax information associated with your TRN in Belgium. + chileAdditionalInfo: + $ref: "#/components/schemas/ChileAdditionalInfo" + description: Additional tax information associated with your TRN in Chile. + franceAdditionalInfo: + $ref: "#/components/schemas/FranceAdditionalInfo" + description: Additional tax information associated with your TRN in France. BrazilAdditionalInfo: description: Additional tax information associated with your TRN in Brazil. type: object @@ -1356,12 +1464,12 @@ components: type: string minLength: 0 maxLength: 1024 - pattern: ^\d+$ + pattern: \d+ LegalNatureCode: type: string minLength: 0 maxLength: 1024 - pattern: ^\d+$ + pattern: \d+ IndiaAdditionalInfo: description: Additional tax information in India. type: object @@ -1371,27 +1479,7 @@ components: description: India pan information associated with the account. Pan: type: string - pattern: ^[A-Z]{5}[0-9]{4}[A-Z]{1}$ - TaxDocumentMetadatas: - type: array - items: - $ref: "#/components/schemas/TaxDocumentMetadata" - TaxDocumentMetadata: - description: The metadata for your tax document. - type: object - properties: - taxDocumentAccessToken: - $ref: "#/components/schemas/TaxDocumentAccessToken" - description: The tax document access token, which contains information that the Tax Settings API uses to locate the tax document. If you update your tax registration, the existing taxDocumentAccessToken won't be valid. To get the latest token, call the GetTaxRegistration or ListTaxRegistrations API operation. This token is valid for 24 hours. - taxDocumentName: - $ref: "#/components/schemas/TaxDocumentName" - description: The name of your tax document. - required: - - taxDocumentAccessToken - - taxDocumentName - TaxDocumentAccessToken: - type: string - pattern: ^[\s\S]*$ + pattern: "[A-Z]{5}[0-9]{4}[A-Z]{1}" DestinationS3Location: description: The location of the Amazon S3 bucket that you specify to download your tax documents to. type: object @@ -1408,7 +1496,7 @@ components: type: string minLength: 0 maxLength: 512 - pattern: ^.*\S.*$ + pattern: .*\S.* GetTaxRegistrationDocumentResponse: type: object properties: @@ -1420,12 +1508,12 @@ components: description: The Amazon S3 presigned URL of the tax registration document. DestinationFilePath: type: string - pattern: ^[\s\S]*$ + pattern: "[\\s\\S]*" Url: type: string minLength: 1 maxLength: 200 - pattern: ^https.*\S.*$ + pattern: https.*\S.* MaxResults: type: integer minimum: 1 @@ -1434,16 +1522,16 @@ components: type: string minLength: 1 maxLength: 2000 - pattern: ^[-A-Za-z0-9_+\=\/]+$ + pattern: "[-A-Za-z0-9_+\\=\\/]+" ListSupplementalTaxRegistrationsResponse: type: object properties: - nextToken: - $ref: "#/components/schemas/PaginationTokenString" - description: The token to retrieve the next set of results. taxRegistrations: $ref: "#/components/schemas/SupplementalTaxRegistrationList" description: The list of supplemental tax registrations. + nextToken: + $ref: "#/components/schemas/PaginationTokenString" + description: The token to retrieve the next set of results. required: - taxRegistrations SupplementalTaxRegistrationList: @@ -1454,29 +1542,29 @@ components: description: Supplemental TRN details. type: object properties: - address: - $ref: "#/components/schemas/Address" - authorityId: - $ref: "#/components/schemas/GenericString" - description: Unique authority ID for the supplemental TRN. - legalName: - $ref: "#/components/schemas/LegalName" - description: The legal name associated with your TRN registration. registrationId: $ref: "#/components/schemas/RegistrationId" description: The supplemental TRN unique identifier. registrationType: $ref: "#/components/schemas/SupplementalTaxRegistrationType" description: Type of supplemental TRN. Currently, this can only be VAT. + legalName: + $ref: "#/components/schemas/LegalName" + description: The legal name associated with your TRN registration. + address: + $ref: "#/components/schemas/Address" + authorityId: + $ref: "#/components/schemas/GenericString" + description: Unique authority ID for the supplemental TRN. status: $ref: "#/components/schemas/TaxRegistrationStatus" description: The status of your TRN. required: - - address - - authorityId - - legalName - registrationId - registrationType + - legalName + - address + - authorityId - status SupplementalTaxRegistrationType: type: string @@ -1514,128 +1602,128 @@ components: accountId: $ref: "#/components/schemas/AccountId" description: List of unique account identifiers. - accountMetaData: - $ref: "#/components/schemas/AccountMetaData" - description: The meta data information associated with the account. - taxInheritanceDetails: - $ref: "#/components/schemas/TaxInheritanceDetails" - description: Tax inheritance information associated with the account. taxRegistration: $ref: "#/components/schemas/TaxRegistrationWithJurisdiction" description: Your TRN information. Instead of having full legal address, here TRN information will have jurisdiction details (for example, country code and state/region/province if applicable). - AccountMetaData: - description: The meta data information associated with the account. - type: object - properties: - accountName: - $ref: "#/components/schemas/AccountName" - description: The Amazon Web Services accounts name. - address: - $ref: "#/components/schemas/Address" - addressRoleMap: - type: object - properties: {} - description: Address roles associated with the account containing country code information. - addressType: - $ref: "#/components/schemas/AddressRoleType" - description: The type of address associated with the legal profile. - seller: - $ref: "#/components/schemas/Seller" - description: Seller information associated with the account. - AccountName: - type: string - pattern: ^[\s\S]*$ - AddressRoleType: - type: string - enum: - - TaxAddress - - BillingAddress - - ContactAddress - Seller: - type: string - pattern: ^[\s\S]*$ - TaxInheritanceDetails: - description: Tax inheritance information associated with the account. - type: object - properties: - inheritanceObtainedReason: - $ref: "#/components/schemas/InheritanceObtainedReason" - description: Tax inheritance reason information associated with the account. - parentEntityId: - $ref: "#/components/schemas/AccountId" - description: Tax inheritance parent account information associated with the account. - InheritanceObtainedReason: - type: string - pattern: ^[\s\S]*$ + taxInheritanceDetails: + $ref: "#/components/schemas/TaxInheritanceDetails" + description: Tax inheritance information associated with the account. + accountMetaData: + $ref: "#/components/schemas/AccountMetaData" + description: The meta data information associated with the account. TaxRegistrationWithJurisdiction: description: Your TRN information with jurisdiction details. This doesn't contain the full legal address associated with the TRN information. type: object properties: - additionalTaxInformation: - $ref: "#/components/schemas/AdditionalInfoResponse" - description: Additional tax information associated with your TRN. - certifiedEmailId: - $ref: "#/components/schemas/CertifiedEmailId" - description: The email address to receive VAT invoices. - jurisdiction: - $ref: "#/components/schemas/Jurisdiction" - description: The jurisdiction associated with your TRN information. - legalName: - $ref: "#/components/schemas/LegalName" - description: The legal name associated with your TRN information. registrationId: $ref: "#/components/schemas/RegistrationId" description: Your tax registration unique identifier. registrationType: $ref: "#/components/schemas/TaxRegistrationType" description: The type of your tax registration. This can be either VAT or GST. - sector: - $ref: "#/components/schemas/Sector" - description: The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document. + legalName: + $ref: "#/components/schemas/LegalName" + description: The legal name associated with your TRN information. status: $ref: "#/components/schemas/TaxRegistrationStatus" description: The status of your TRN. This can be either Verified, Pending, Deleted, or Rejected. + sector: + $ref: "#/components/schemas/Sector" + description: The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document. taxDocumentMetadatas: $ref: "#/components/schemas/TaxDocumentMetadatas" description: The metadata for your tax document. + certifiedEmailId: + $ref: "#/components/schemas/CertifiedEmailId" + description: The email address to receive VAT invoices. + additionalTaxInformation: + $ref: "#/components/schemas/AdditionalInfoResponse" + description: Additional tax information associated with your TRN. + jurisdiction: + $ref: "#/components/schemas/Jurisdiction" + description: The jurisdiction associated with your TRN information. required: - - jurisdiction - - legalName - registrationId - registrationType + - legalName - status + - jurisdiction Jurisdiction: description: The jurisdiction details of the TRN information of the customers. This doesn't contain full legal address, and contains only country code and state/region/province. type: object properties: - countryCode: - $ref: "#/components/schemas/CountryCode" - description: The country code of the jurisdiction. stateOrRegion: $ref: "#/components/schemas/State" description: The state, region, or province associated with the country of the jurisdiction, if applicable. + countryCode: + $ref: "#/components/schemas/CountryCode" + description: The country code of the jurisdiction. required: - countryCode - SupplementalTaxRegistrationEntry: - description: The supplemental TRN information to provide when adding or updating a supplemental TRN. + TaxInheritanceDetails: + description: Tax inheritance information associated with the account. + type: object + properties: + parentEntityId: + $ref: "#/components/schemas/AccountId" + description: Tax inheritance parent account information associated with the account. + inheritanceObtainedReason: + $ref: "#/components/schemas/InheritanceObtainedReason" + description: Tax inheritance reason information associated with the account. + InheritanceObtainedReason: + type: string + pattern: "[\\s\\S]*" + AccountMetaData: + description: The meta data information associated with the account. type: object properties: + accountName: + $ref: "#/components/schemas/AccountName" + description: The Amazon Web Services accounts name. + seller: + $ref: "#/components/schemas/Seller" + description: Seller information associated with the account. address: $ref: "#/components/schemas/Address" - legalName: - $ref: "#/components/schemas/LegalName" - description: The legal name associated with your TRN registration. + addressType: + $ref: "#/components/schemas/AddressRoleType" + description: The type of address associated with the legal profile. + addressRoleMap: + type: object + properties: {} + description: Address roles associated with the account containing country code information. + AccountName: + type: string + pattern: "[\\s\\S]*" + Seller: + type: string + pattern: "[\\s\\S]*" + AddressRoleType: + type: string + enum: + - TaxAddress + - BillingAddress + - ContactAddress + SupplementalTaxRegistrationEntry: + description: The supplemental TRN information to provide when adding or updating a supplemental TRN. + type: object + properties: registrationId: $ref: "#/components/schemas/RegistrationId" description: The supplemental TRN unique identifier. registrationType: $ref: "#/components/schemas/SupplementalTaxRegistrationType" description: Type of supplemental TRN. Currently, this can only be VAT. + legalName: + $ref: "#/components/schemas/LegalName" + description: The legal name associated with your TRN registration. + address: + $ref: "#/components/schemas/Address" required: - - address - - legalName - registrationId - registrationType + - legalName + - address PutSupplementalTaxRegistrationResponse: type: object properties: @@ -1656,25 +1744,25 @@ components: description: The exemption certificate. type: object properties: - documentFile: - $ref: "#/components/schemas/ExemptionFileBlob" - description: The exemption certificate file content. documentName: $ref: "#/components/schemas/ExemptionDocumentName" description: The exemption certificate file name. + documentFile: + $ref: "#/components/schemas/ExemptionFileBlob" + description: The exemption certificate file content. required: - - documentFile - documentName + - documentFile + ExemptionDocumentName: + type: string + minLength: 0 + maxLength: 128 + pattern: ([A-Za-z0-9_.-]+)\.([pP][dD][fF]|[jJ][pP][gG]|[pP][nN][gG]) ExemptionFileBlob: type: string format: byte minLength: 1 maxLength: 4194304 - ExemptionDocumentName: - type: string - minLength: 0 - maxLength: 128 - pattern: ^([A-Za-z0-9-_.]+).(pdf|jpg|png)$ PutTaxExemptionResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/textract.yaml b/providers/src/aws/v00.00.00000/services/textract.yaml index e4233060..c0237bfd 100644 --- a/providers/src/aws/v00.00.00000/services/textract.yaml +++ b/providers/src/aws/v00.00.00000/services/textract.yaml @@ -47,7 +47,7 @@ paths: description: A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes). HumanLoopConfig: $ref: "#/components/schemas/HumanLoopConfig" - description: Sets the configuration for the human in the loop workflow for analyzing documents. + description: Sets the configuration for the human in the loop workflow for analyzing documents. Amazon Textract uses Amazon Augmented AI (A2I) to run the human review workflows that you specify in HumanLoopConfig. A2I entered maintenance mode in July 2026 and no longer accepts new customers. If your account is not an existing A2I customer, requests fail with an InvalidParameterException. For more information, see AWS service availability. If you're an existing A2I customer but receive this error, contact AWS Support and request assistance from the A2I team. QueriesConfig: $ref: "#/components/schemas/QueriesConfig" description: Contains Queries and the alias for those Queries, as determined by the input. @@ -1119,7 +1119,7 @@ components: - SIGNATURES - LAYOUT HumanLoopConfig: - description: Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review. + description: Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review. Amazon Textract uses Amazon Augmented AI (A2I) to run the human review workflows that you specify in HumanLoopConfig. A2I entered maintenance mode in July 2026 and no longer accepts new customers. If your account is not an existing A2I customer, requests fail with an InvalidParameterException. For more information, see AWS service availability. If you're an existing A2I customer but receive this error, contact AWS Support and request assistance from the A2I team. type: object properties: HumanLoopName: @@ -1372,7 +1372,7 @@ components: description: Within the bounding box, a fine-grained polygon around the recognized item. RotationAngle: $ref: "#/components/schemas/Angle" - description: Provides a numerical value corresponding to the rotation of the text. + description: Provides a numerical value corresponding to the rotation of the WORD block. Possible values are 0, 90, 180, and 270. BoundingBox: description: The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200). The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. type: object diff --git a/providers/src/aws/v00.00.00000/services/timestream_influxdb.yaml b/providers/src/aws/v00.00.00000/services/timestream_influxdb.yaml index a2d03877..17a3313f 100644 --- a/providers/src/aws/v00.00.00000/services/timestream_influxdb.yaml +++ b/providers/src/aws/v00.00.00000/services/timestream_influxdb.yaml @@ -18,6 +18,49 @@ servers: description: AWS region description: Regional endpoint for timestream-influxdb paths: + /CreateDbBackup: + post: + operationId: CreateDbBackup + description: Creates a new on-demand backup of a Timestream for InfluxDB resource. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonTimestreamInfluxDB.CreateDbBackup + default: AmazonTimestreamInfluxDB.CreateDbBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/DbBackupName" + description: The name of the backup. Must be unique within the account and region. + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The id of the DB instance or DB cluster to back up. + retentionDays: + $ref: "#/components/schemas/RetentionDays" + description: The number of days to retain the backup. Valid values are 1 to 3650. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: A list of key-value pairs to associate with the backup. + required: + - name + - dbResourceId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDbBackupOutput" /CreateDbCluster: post: operationId: CreateDbCluster @@ -93,6 +136,12 @@ paths: maintenanceSchedule: $ref: "#/components/schemas/MaintenanceSchedule" description: Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationInputList" + description: A list of backup configurations to enable automated backups for the DB cluster. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key identifier to use for encryption of the DB cluster. Can be a key ID, key ARN, alias name, or alias ARN. tags: $ref: "#/components/schemas/RequestTagMap" description: A list of key-value pairs to associate with the DB instance. @@ -183,6 +232,12 @@ paths: networkType: $ref: "#/components/schemas/NetworkType" description: Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationInputList" + description: A list of backup configurations to enable automated backups for the DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key identifier to use for encryption of the DB instance. Can be a key ID, key ARN, alias name, or alias ARN. required: - name - password @@ -239,6 +294,39 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateDbParameterGroupOutput" + /DeleteDbBackup: + post: + operationId: DeleteDbBackup + description: Deletes a Timestream for InfluxDB backup. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonTimestreamInfluxDB.DeleteDbBackup + default: AmazonTimestreamInfluxDB.DeleteDbBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + identifier: + $ref: "#/components/schemas/DbBackupId" + description: The identifier of the backup to delete. + required: + - identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteDbBackupOutput" /DeleteDbCluster: post: operationId: DeleteDbCluster @@ -263,6 +351,9 @@ paths: dbClusterId: $ref: "#/components/schemas/DbClusterId" description: Service-generated unique identifier of the DB cluster. + retainAutomatedBackups: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to retain automated backups after the DB cluster is deleted. If set to true, automated backups are not deleted and can be restored later. required: - dbClusterId responses: @@ -296,6 +387,9 @@ paths: identifier: $ref: "#/components/schemas/DbInstanceIdentifier" description: The id of the DB instance. + retainAutomatedBackups: + $ref: "#/components/schemas/Boolean" + description: Specifies whether to retain automated backups after the DB instance is deleted. If set to true, automated backups are not deleted and can be restored later. required: - identifier responses: @@ -305,6 +399,39 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteDbInstanceOutput" + /GetDbBackup: + post: + operationId: GetDbBackup + description: Returns information about a specific Timestream for InfluxDB backup. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonTimestreamInfluxDB.GetDbBackup + default: AmazonTimestreamInfluxDB.GetDbBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + identifier: + $ref: "#/components/schemas/DbBackupId" + description: The identifier of the backup to retrieve information for. + required: + - identifier + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetDbBackupOutput" /GetDbCluster: post: operationId: GetDbCluster @@ -404,6 +531,43 @@ paths: application/json: schema: $ref: "#/components/schemas/GetDbParameterGroupOutput" + /ListDbBackups: + post: + operationId: ListDbBackups + description: Returns a list of Timestream for InfluxDB backups. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonTimestreamInfluxDB.ListDbBackups + default: AmazonTimestreamInfluxDB.ListDbBackups + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region. + nextToken: + $ref: "#/components/schemas/NextToken" + description: The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. + maxResults: + $ref: "#/components/schemas/MaxResults" + description: The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListDbBackupsOutput" /ListDbClusters: post: operationId: ListDbClusters @@ -647,6 +811,82 @@ paths: application/json: schema: $ref: "#/components/schemas/RebootDbInstanceOutput" + /RestoreFromDbBackup: + post: + operationId: RestoreFromDbBackup + description: Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AmazonTimestreamInfluxDB.RestoreFromDbBackup + default: AmazonTimestreamInfluxDB.RestoreFromDbBackup + requestBody: + required: true + content: + application/x-amz-json-1.0: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/DbResourceName" + description: The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name. + dbBackupId: + $ref: "#/components/schemas/DbBackupId" + description: The identifier of the backup to restore from. + restoreToTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The point in time to restore to, for continuous backups. Must be within the backup's retention window. + restoreMode: + $ref: "#/components/schemas/RestoreMode" + description: Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING. + vpcSubnetIds: + $ref: "#/components/schemas/VpcSubnetIdList" + description: A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup. + vpcSecurityGroupIds: + $ref: "#/components/schemas/VpcSecurityGroupIdList" + description: A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup. + publiclyAccessible: + $ref: "#/components/schemas/Boolean" + description: Specifies whether the restored resource is publicly accessible. + logDeliveryConfiguration: + $ref: "#/components/schemas/LogDeliveryConfiguration" + description: Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource. + maintenanceSchedule: + $ref: "#/components/schemas/MaintenanceSchedule" + description: The maintenance schedule for the restored resource. + tags: + $ref: "#/components/schemas/RequestTagMap" + description: A list of key-value pairs to associate with the restored resource. + port: + $ref: "#/components/schemas/Port" + description: The port number on which the restored InfluxDB resource accepts connections. + networkType: + $ref: "#/components/schemas/NetworkType" + description: Specifies the network type of the restored resource. Valid values are IPV4 and DUAL. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationInputList" + description: A list of backup configurations to apply to the restored resource. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN. + required: + - name + - dbBackupId + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/RestoreFromDbBackupOutput" /TagResource: post: operationId: TagResource @@ -755,6 +995,9 @@ paths: maintenanceSchedule: $ref: "#/components/schemas/MaintenanceSchedule" description: Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationInputList" + description: A list of backup configurations to update for the DB cluster. required: - dbClusterId responses: @@ -812,6 +1055,9 @@ paths: maintenanceSchedule: $ref: "#/components/schemas/MaintenanceSchedule" description: Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationInputList" + description: A list of backup configurations to update for the DB instance. required: - identifier responses: @@ -866,34 +1112,174 @@ components: schema: type: string schemas: - DbClusterName: + DbBackupName: type: string minLength: 3 maxLength: 40 - pattern: "[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" - Username: + pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + DbResourceId: type: string - minLength: 1 + minLength: 3 maxLength: 64 - Password: + pattern: "[a-zA-Z0-9]+" + RetentionDays: + type: integer + minimum: 1 + maximum: 3650 + RequestTagMap: + type: object + properties: {} + CreateDbBackupOutput: + type: object + properties: + id: + $ref: "#/components/schemas/DbBackupId" + description: Service-generated unique identifier of the backup. + name: + $ref: "#/components/schemas/DbBackupName" + description: The customer-provided name of the backup. + arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the backup. + status: + $ref: "#/components/schemas/DbBackupStatus" + description: The current status of the backup. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The time when the backup was created. + expiresAfter: + $ref: "#/components/schemas/Date" + description: The date after which the backup will be automatically deleted. + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the DB resource that the backup was created from. + type_: + $ref: "#/components/schemas/DbBackupType" + description: The type of backup. + engineType: + $ref: "#/components/schemas/EngineType" + description: The engine type of the resource that the backup was created from. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: The deployment type of the resource that the backup was created from. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. + clusterConfiguration: + $ref: "#/components/schemas/ClusterConfiguration" + description: The cluster configuration of the resource at the time of backup. + dbParameterGroupId: + $ref: "#/components/schemas/DbParameterGroupId" + description: The identifier of the DB parameter group associated with the backup. + dbInstanceType: + $ref: "#/components/schemas/DbInstanceType" + description: The DB instance type of the resource at the time of backup. + logDeliveryConfiguration: + $ref: "#/components/schemas/LogDeliveryConfiguration" + description: The log delivery configuration of the resource at the time of backup. + failoverMode: + $ref: "#/components/schemas/FailoverMode" + description: The failover mode of the resource at the time of backup. + dbStorageType: + $ref: "#/components/schemas/DbStorageType" + description: The storage type of the resource at the time of backup. + allocatedStorage: + $ref: "#/components/schemas/AllocatedStorage" + description: The allocated storage of the resource at the time of backup, in GiB. + vpcSubnetIds: + $ref: "#/components/schemas/VpcSubnetIdList" + description: The VPC subnet IDs associated with the resource at the time of backup. + vpcSecurityGroupIds: + $ref: "#/components/schemas/VpcSecurityGroupIdList" + description: The VPC security group IDs associated with the resource at the time of backup. + publiclyAccessible: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the resource was publicly accessible at the time of backup. + port: + $ref: "#/components/schemas/Integer" + description: The port number of the resource at the time of backup. + networkType: + $ref: "#/components/schemas/NetworkType" + description: The network type of the resource at the time of backup. + influxAuthParametersSecretArn: + $ref: "#/components/schemas/String" + description: The ARN of the Secrets Manager secret containing the InfluxDB auth parameters. + maintenanceSchedule: + $ref: "#/components/schemas/MaintenanceSchedule" + description: The maintenance schedule of the resource at the time of backup. + required: + - id + - arn + DbBackupId: type: string - minLength: 8 + minLength: 3 maxLength: 64 pattern: "[a-zA-Z0-9]+" - Organization: + Arn: type: string minLength: 1 - maxLength: 64 - Bucket: + maxLength: 1011 + pattern: arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group|db\-backup)/[a-zA-Z0-9]{3,64} + DbBackupStatus: type: string - minLength: 2 - maxLength: 64 - pattern: '[^_"][^"]*' - Port: + enum: + - IN_PROGRESS + - COMPLETED + - FAILED + - DELETING + - DELETED + SyntheticTimestamp_date_time: + type: string + format: date-time + Date: + description: A calendar date in YYYY-MM-DD format. + type: string + pattern: \d{4}-\d{2}-\d{2} + DbBackupType: + type: string + enum: + - HOURLY + - DAILY + - WEEKLY + - MONTHLY + - CUSTOM_SCHEDULE + - ON_DEMAND + - CONTINUOUS + EngineType: + type: string + enum: + - INFLUXDB_V2 + - INFLUXDB_V3_CORE + - INFLUXDB_V3_ENTERPRISE + ResourceDeploymentType: + type: string + enum: + - SINGLE_AZ + - WITH_MULTIAZ_STANDBY + - MULTI_NODE_READ_REPLICAS + KmsKeyId: + type: string + minLength: 1 + maxLength: 2048 + pattern: "[a-zA-Z0-9:/_\\-]+" + ClusterConfiguration: + description: Configuration for node modes in the DbCluster. + type: object + properties: + ingestQueryInstances: + $ref: "#/components/schemas/Integer" + description: The number of instances in the DbCluster which can both ingest and query. + queryOnlyInstances: + $ref: "#/components/schemas/Integer" + description: The number of instances in the DbCluster which can only query. + dedicatedCompactor: + $ref: "#/components/schemas/Boolean" + description: Indicates if the compactor instance is a standalone instance or not. + Integer: type: integer - minimum: 1024 - maximum: 65535 - DbParameterGroupIdentifier: + Boolean: + type: boolean + DbParameterGroupId: type: string minLength: 3 maxLength: 64 @@ -910,6 +1296,38 @@ components: - db.influx.12xlarge - db.influx.16xlarge - db.influx.24xlarge + LogDeliveryConfiguration: + description: Configuration for sending InfluxDB engine logs to send to specified S3 bucket. + type: object + properties: + s3Configuration: + $ref: "#/components/schemas/S3Configuration" + description: Configuration for S3 bucket log delivery. + required: + - s3Configuration + S3Configuration: + description: Configuration for S3 bucket log delivery. + type: object + properties: + bucketName: + $ref: "#/components/schemas/S3ConfigurationBucketNameString" + description: The name of the S3 bucket to deliver logs to. + enabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether log delivery to the S3 bucket is enabled. + required: + - bucketName + - enabled + S3ConfigurationBucketNameString: + type: string + minLength: 3 + maxLength: 63 + pattern: "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" + FailoverMode: + type: string + enum: + - AUTOMATIC + - NO_FAILOVER DbStorageType: type: string enum: @@ -920,13 +1338,6 @@ components: type: integer minimum: 20 maximum: 15360 - NetworkType: - type: string - enum: - - IPV4 - - DUAL - Boolean: - type: boolean VpcSubnetIdList: type: array items: @@ -945,42 +1356,13 @@ components: minLength: 0 maxLength: 64 pattern: sg-[a-z0-9]+ - ClusterDeploymentType: - type: string - enum: - - MULTI_NODE_READ_REPLICAS - FailoverMode: + NetworkType: type: string enum: - - AUTOMATIC - - NO_FAILOVER - LogDeliveryConfiguration: - description: Configuration for sending InfluxDB engine logs to send to specified S3 bucket. - type: object - properties: - s3Configuration: - $ref: "#/components/schemas/S3Configuration" - description: Configuration for S3 bucket log delivery. - required: - - s3Configuration - S3Configuration: - description: Configuration for S3 bucket log delivery. - type: object - properties: - bucketName: - $ref: "#/components/schemas/S3ConfigurationBucketNameString" - description: The name of the S3 bucket to deliver logs to. - enabled: - $ref: "#/components/schemas/Boolean" - description: Indicates whether log delivery to the S3 bucket is enabled. - required: - - bucketName - - enabled - S3ConfigurationBucketNameString: + - IPV4 + - DUAL + String: type: string - minLength: 3 - maxLength: 63 - pattern: "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" MaintenanceSchedule: description: Specifies the maintenance schedule for a DB instance or cluster, defining when maintenance operations such as patching can be performed. type: object @@ -997,18 +1379,93 @@ components: IanaTimezone: description: "IANA timezone identifier. Format: Region/City or UTC See: https://www.iana.org/time-zones" type: string - minLength: 1 - maxLength: 64 - pattern: (UTC|[A-Za-z_]+/[A-Za-z0-9_]+(/[A-Za-z0-9_]+)?) - MaintenanceWindow: - description: 'Preferred maintenance window in format "ddd:HH:MM-ddd:HH:MM" Format requirements: Day: Mon, Tue, Wed, Thu, Fri, Sat, Sun Hour: 00-23 (24-hour format, 2 digits) Minute: 00-59 (2 digits) Provide empty string to let the system choose a window. Examples: "Sun:02:00-Sun:06:00" (4-hour window Sunday morning) "Sat:23:00-Sun:03:00" (cross-midnight window) "" or (system chooses)' + minLength: 1 + maxLength: 64 + pattern: (UTC|[A-Za-z_]+/[A-Za-z0-9_]+(/[A-Za-z0-9_]+)?) + MaintenanceWindow: + description: 'Preferred maintenance window in format "ddd:HH:MM-ddd:HH:MM" Format requirements: Day: Mon, Tue, Wed, Thu, Fri, Sat, Sun Hour: 00-23 (24-hour format, 2 digits) Minute: 00-59 (2 digits) Provide empty string to let the system choose a window. Examples: "Sun:02:00-Sun:06:00" (4-hour window Sunday morning) "Sat:23:00-Sun:03:00" (cross-midnight window) "" or (system chooses)' + type: string + minLength: 0 + maxLength: 19 + pattern: $|^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d + DbClusterName: + type: string + minLength: 3 + maxLength: 40 + pattern: "[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + Username: + type: string + minLength: 1 + maxLength: 64 + Password: + type: string + minLength: 8 + maxLength: 64 + pattern: "[a-zA-Z0-9]+" + Organization: + type: string + minLength: 1 + maxLength: 64 + Bucket: + type: string + minLength: 2 + maxLength: 64 + pattern: '[^_"][^"]*' + Port: + type: integer + minimum: 1024 + maximum: 65535 + DbParameterGroupIdentifier: + type: string + minLength: 3 + maxLength: 64 + pattern: "[a-zA-Z0-9]+" + ClusterDeploymentType: + type: string + enum: + - MULTI_NODE_READ_REPLICAS + DbBackupConfigurationInputList: + type: array + items: + $ref: "#/components/schemas/DbBackupConfiguration" + DbBackupConfiguration: + description: Specifies the configuration for an automated backup schedule. + type: object + properties: + type_: + $ref: "#/components/schemas/AutomatedDbBackupType" + description: The type of automated backup schedule. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, and CONTINUOUS. + retentionDays: + $ref: "#/components/schemas/AutomatedBackupRetentionDays" + description: The number of days to retain automated backups. Valid values are 1 to 365. + enabled: + $ref: "#/components/schemas/Boolean" + description: Specifies whether this backup configuration is enabled. + customSchedule: + $ref: "#/components/schemas/AwsCronSchedule" + description: A custom cron schedule expression for the backup. Required when type is CUSTOM_SCHEDULE. + required: + - type_ + - retentionDays + - enabled + AutomatedDbBackupType: + type: string + enum: + - HOURLY + - DAILY + - WEEKLY + - MONTHLY + - CUSTOM_SCHEDULE + - CONTINUOUS + AutomatedBackupRetentionDays: + type: integer + minimum: 1 + maximum: 365 + AwsCronSchedule: type: string - minLength: 0 - maxLength: 19 - pattern: $|^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d - RequestTagMap: - type: object - properties: {} + minLength: 9 + maxLength: 256 + pattern: cron\(\S+ \S+ \S+ \S+ \S+ \S+\) CreateDbClusterOutput: type: object properties: @@ -1037,6 +1494,8 @@ components: - REBOOTING - REBOOT_FAILED - PARTIALLY_AVAILABLE + - RESTORING + - RESTORE_FAILED DbInstanceName: type: string minLength: 3 @@ -1125,6 +1584,12 @@ components: nextMaintenanceTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of the next scheduled maintenance operation on the DB instance. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations for the DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the DB instance. required: - id - name @@ -1135,11 +1600,6 @@ components: minLength: 3 maxLength: 64 pattern: "[a-zA-Z0-9]+" - Arn: - type: string - minLength: 1 - maxLength: 1011 - pattern: arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64} Status: type: string enum: @@ -1155,8 +1615,8 @@ components: - MAINTENANCE - REBOOTING - REBOOT_FAILED - String: - type: string + - RESTORING + - RESTORE_FAILED InstanceMode: type: string enum: @@ -1171,9 +1631,33 @@ components: type: array items: $ref: "#/components/schemas/InstanceMode" - SyntheticTimestamp_date_time: - type: string - format: date-time + DbBackupConfigurationOutputList: + type: array + items: + $ref: "#/components/schemas/DbBackupConfigurationOutput" + DbBackupConfigurationOutput: + description: Contains the configuration and status for an automated backup schedule. + type: object + properties: + type_: + $ref: "#/components/schemas/AutomatedDbBackupType" + description: The type of automated backup schedule. + retentionDays: + $ref: "#/components/schemas/AutomatedBackupRetentionDays" + description: The number of days automated backups are retained. + enabled: + $ref: "#/components/schemas/Boolean" + description: Indicates whether this backup configuration is enabled. + customSchedule: + $ref: "#/components/schemas/AwsCronSchedule" + description: The custom cron schedule expression for the backup, if applicable. + nextAutomatedBackupTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The next scheduled time for an automated backup to be taken. + required: + - type_ + - retentionDays + - enabled DbParameterGroupName: type: string minLength: 3 @@ -1250,7 +1734,7 @@ components: description: "Initial bytes of memory allocated for a query. Default: 0" queryMaxMemoryBytes: $ref: "#/components/schemas/InfluxDBv2ParametersQueryMaxMemoryBytesLong" - description: "Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue. Default: 0" + description: "Maximum total bytes of memory allowed for all running queries. When this limit is reached, new queries are rejected. Setting to 0 allows unlimited memory usage. Default: 0" queryMemoryBytes: $ref: "#/components/schemas/InfluxDBv2ParametersQueryMemoryBytesLong" description: "Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes. Default: 0" @@ -1539,6 +2023,12 @@ components: hardDeleteDefaultDuration: $ref: "#/components/schemas/Duration" description: "Sets the default duration for hard deletion of data. Default: 90d" + pluginRepositoryUrl: + $ref: "#/components/schemas/String" + description: Specifies the URL of the repository that InfluxDB downloads plugins from. + pluginRepositorySecretArn: + $ref: "#/components/schemas/PluginRepositorySecretArn" + description: The Amazon Resource Name (ARN) of the Secrets Manager secret that holds your repository access token. InfluxDBv3CoreParametersQueryFileLimitInteger: type: integer minimum: 0 @@ -1645,6 +2135,11 @@ components: type: integer minimum: 1 maximum: 100 + PluginRepositorySecretArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9\-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@\-]+ InfluxDBv3EnterpriseParameters: description: All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB. type: object @@ -1766,6 +2261,12 @@ components: hardDeleteDefaultDuration: $ref: "#/components/schemas/Duration" description: "Sets the default duration for hard deletion of data. Default: 90d" + pluginRepositoryUrl: + $ref: "#/components/schemas/String" + description: Specifies the URL of the repository that InfluxDB downloads plugins from. + pluginRepositorySecretArn: + $ref: "#/components/schemas/PluginRepositorySecretArn" + description: The Amazon Resource Name (ARN) of the Secrets Manager secret that holds your repository access token. ingestQueryInstances: $ref: "#/components/schemas/InfluxDBv3EnterpriseParametersIngestQueryInstancesInteger" description: Specifies number of instances in the DbCluster which can both ingest and query. @@ -1929,11 +2430,87 @@ components: - id - name - arn - DbParameterGroupId: - type: string - minLength: 3 - maxLength: 64 - pattern: "[a-zA-Z0-9]+" + DeleteDbBackupOutput: + type: object + properties: + id: + $ref: "#/components/schemas/DbBackupId" + description: Service-generated unique identifier of the deleted backup. + name: + $ref: "#/components/schemas/DbBackupName" + description: The customer-provided name of the deleted backup. + arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the deleted backup. + status: + $ref: "#/components/schemas/DbBackupStatus" + description: The current status of the backup. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The time when the backup was created. + expiresAfter: + $ref: "#/components/schemas/Date" + description: The date after which the backup was set to be automatically deleted. + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the DB resource that the backup was created from. + type_: + $ref: "#/components/schemas/DbBackupType" + description: The type of backup. + engineType: + $ref: "#/components/schemas/EngineType" + description: The engine type of the resource that the backup was created from. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: The deployment type of the resource that the backup was created from. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. + clusterConfiguration: + $ref: "#/components/schemas/ClusterConfiguration" + description: The cluster configuration of the resource at the time of backup. + dbParameterGroupId: + $ref: "#/components/schemas/DbParameterGroupId" + description: The identifier of the DB parameter group associated with the backup. + dbInstanceType: + $ref: "#/components/schemas/DbInstanceType" + description: The DB instance type of the resource at the time of backup. + logDeliveryConfiguration: + $ref: "#/components/schemas/LogDeliveryConfiguration" + description: The log delivery configuration of the resource at the time of backup. + failoverMode: + $ref: "#/components/schemas/FailoverMode" + description: The failover mode of the resource at the time of backup. + dbStorageType: + $ref: "#/components/schemas/DbStorageType" + description: The storage type of the resource at the time of backup. + allocatedStorage: + $ref: "#/components/schemas/AllocatedStorage" + description: The allocated storage of the resource at the time of backup, in GiB. + vpcSubnetIds: + $ref: "#/components/schemas/VpcSubnetIdList" + description: The VPC subnet IDs associated with the resource at the time of backup. + vpcSecurityGroupIds: + $ref: "#/components/schemas/VpcSecurityGroupIdList" + description: The VPC security group IDs associated with the resource at the time of backup. + publiclyAccessible: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the resource was publicly accessible at the time of backup. + port: + $ref: "#/components/schemas/Integer" + description: The port number of the resource at the time of backup. + networkType: + $ref: "#/components/schemas/NetworkType" + description: The network type of the resource at the time of backup. + influxAuthParametersSecretArn: + $ref: "#/components/schemas/String" + description: The ARN of the Secrets Manager secret containing the InfluxDB auth parameters. + maintenanceSchedule: + $ref: "#/components/schemas/MaintenanceSchedule" + description: The maintenance schedule of the resource at the time of backup. + required: + - id + - arn DeleteDbClusterOutput: type: object properties: @@ -2023,11 +2600,98 @@ components: nextMaintenanceTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of the next scheduled maintenance operation on the DB instance. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations that were associated with the deleted DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN that was used for encryption of the deleted DB instance. required: - id - name - arn - vpcSubnetIds + GetDbBackupOutput: + type: object + properties: + id: + $ref: "#/components/schemas/DbBackupId" + description: Service-generated unique identifier of the backup. + name: + $ref: "#/components/schemas/DbBackupName" + description: The customer-provided name of the backup. + arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the backup. + status: + $ref: "#/components/schemas/DbBackupStatus" + description: The current status of the backup. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The time when the backup was created. + expiresAfter: + $ref: "#/components/schemas/Date" + description: The date after which the backup will be automatically deleted. + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the DB resource that the backup was created from. + type_: + $ref: "#/components/schemas/DbBackupType" + description: The type of backup. + engineType: + $ref: "#/components/schemas/EngineType" + description: The engine type of the resource that the backup was created from. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: The deployment type of the resource that the backup was created from. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. + clusterConfiguration: + $ref: "#/components/schemas/ClusterConfiguration" + description: The cluster configuration of the resource at the time of backup. + dbParameterGroupId: + $ref: "#/components/schemas/DbParameterGroupId" + description: The identifier of the DB parameter group associated with the backup. + dbInstanceType: + $ref: "#/components/schemas/DbInstanceType" + description: The DB instance type of the resource at the time of backup. + logDeliveryConfiguration: + $ref: "#/components/schemas/LogDeliveryConfiguration" + description: The log delivery configuration of the resource at the time of backup. + failoverMode: + $ref: "#/components/schemas/FailoverMode" + description: The failover mode of the resource at the time of backup. + dbStorageType: + $ref: "#/components/schemas/DbStorageType" + description: The storage type of the resource at the time of backup. + allocatedStorage: + $ref: "#/components/schemas/AllocatedStorage" + description: The allocated storage of the resource at the time of backup, in GiB. + vpcSubnetIds: + $ref: "#/components/schemas/VpcSubnetIdList" + description: The VPC subnet IDs associated with the resource at the time of backup. + vpcSecurityGroupIds: + $ref: "#/components/schemas/VpcSecurityGroupIdList" + description: The VPC security group IDs associated with the resource at the time of backup. + publiclyAccessible: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the resource was publicly accessible at the time of backup. + port: + $ref: "#/components/schemas/Integer" + description: The port number of the resource at the time of backup. + networkType: + $ref: "#/components/schemas/NetworkType" + description: The network type of the resource at the time of backup. + influxAuthParametersSecretArn: + $ref: "#/components/schemas/String" + description: The ARN of the Secrets Manager secret containing the InfluxDB auth parameters. + maintenanceSchedule: + $ref: "#/components/schemas/MaintenanceSchedule" + description: The maintenance schedule of the resource at the time of backup. + required: + - id + - arn GetDbClusterOutput: type: object properties: @@ -2103,31 +2767,16 @@ components: clusterConfiguration: $ref: "#/components/schemas/ClusterConfiguration" description: Configuration for node modes in the DbCluster. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations for the DB cluster. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the DB cluster. required: - id - name - arn - EngineType: - type: string - enum: - - INFLUXDB_V2 - - INFLUXDB_V3_CORE - - INFLUXDB_V3_ENTERPRISE - ClusterConfiguration: - description: Configuration for node modes in the DbCluster. - type: object - properties: - ingestQueryInstances: - $ref: "#/components/schemas/Integer" - description: The number of instances in the DbCluster which can both ingest and query. - queryOnlyInstances: - $ref: "#/components/schemas/Integer" - description: The number of instances in the DbCluster which can only query. - dedicatedCompactor: - $ref: "#/components/schemas/Boolean" - description: Indicates if the compactor instance is a standalone instance or not. - Integer: - type: integer GetDbInstanceOutput: type: object properties: @@ -2206,6 +2855,12 @@ components: nextMaintenanceTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of the next scheduled maintenance operation on the DB instance. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations for the DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the DB instance. required: - id - name @@ -2240,6 +2895,61 @@ components: type: integer minimum: 1 maximum: 100 + ListDbBackupsOutput: + type: object + properties: + items_: + $ref: "#/components/schemas/DbBackupSummaryList" + description: A list of Timestream for InfluxDB backup summaries. + nextToken: + $ref: "#/components/schemas/NextToken" + description: Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. + required: + - items_ + DbBackupSummaryList: + type: array + items: + $ref: "#/components/schemas/DbBackupSummary" + DbBackupSummary: + description: Contains a summary of a Timestream for InfluxDB backup. + type: object + properties: + id: + $ref: "#/components/schemas/DbBackupId" + description: Service-generated unique identifier of the backup. + name: + $ref: "#/components/schemas/DbBackupName" + description: The customer-provided name of the backup. + arn: + $ref: "#/components/schemas/Arn" + description: The Amazon Resource Name (ARN) of the backup. + status: + $ref: "#/components/schemas/DbBackupStatus" + description: The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The time when the backup was created. + expiresAfter: + $ref: "#/components/schemas/Date" + description: The date after which the backup will be automatically deleted. + dbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the DB resource that the backup was created from. + type_: + $ref: "#/components/schemas/DbBackupType" + description: The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS. + engineType: + $ref: "#/components/schemas/EngineType" + description: The engine type of the resource that the backup was created from. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: The deployment type of the resource that the backup was created from. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. + required: + - id + - arn ListDbClustersOutput: type: object properties: @@ -2550,11 +3260,54 @@ components: nextMaintenanceTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of the next scheduled maintenance operation on the DB instance. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations for the DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the DB instance. required: - id - name - arn - vpcSubnetIds + DbResourceName: + type: string + minLength: 3 + maxLength: 40 + pattern: "[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + RestoreMode: + type: string + enum: + - NEW_RESOURCE + - REPLACE_EXISTING + RestoreFromDbBackupOutput: + type: object + properties: + restoredDbResourceId: + $ref: "#/components/schemas/DbResourceId" + description: The identifier of the restored DB resource. + restoreStatus: + $ref: "#/components/schemas/RestoreStatus" + description: The status of the restore operation. + resourceType: + $ref: "#/components/schemas/ResourceType" + description: The type of the restored resource. Valid values are DB_INSTANCE and DB_CLUSTER. + engineType: + $ref: "#/components/schemas/EngineType" + description: The engine type of the restored resource. + deploymentType: + $ref: "#/components/schemas/ResourceDeploymentType" + description: The deployment type of the restored resource. + RestoreStatus: + type: string + enum: + - RESTORING + ResourceType: + type: string + enum: + - DB_INSTANCE + - DB_CLUSTER TagKeys: type: array items: @@ -2647,12 +3400,105 @@ components: nextMaintenanceTime: $ref: "#/components/schemas/SyntheticTimestamp_date_time" description: The timestamp of the next scheduled maintenance operation on the DB instance. + dbBackupConfigurations: + $ref: "#/components/schemas/DbBackupConfigurationOutputList" + description: The backup configurations for the DB instance. + kmsKeyId: + $ref: "#/components/schemas/KmsKeyId" + description: The Amazon Web Services KMS key ARN used for encryption of the DB instance. required: - id - name - arn - vpcSubnetIds x-stackQL-resources: + db_backups: + id: aws.timestream_influxdb.db_backups + name: db_backups + title: db_backups + methods: + create_db_backup: + operation: + $ref: "#/paths/~1CreateDbBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + delete_db_backup: + operation: + $ref: "#/paths/~1DeleteDbBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + get_db_backup: + operation: + $ref: "#/paths/~1GetDbBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + list_db_backups: + operation: + $ref: "#/paths/~1ListDbBackups/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + pagination: + requestToken: + key: nextToken + location: body + responseToken: + key: $.nextToken + location: body + requestBodyTranslate: + algorithm: naive + restore_from_db_backup: + operation: + $ref: "#/paths/~1RestoreFromDbBackup/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.0 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/db_backups/methods/get_db_backup" + - $ref: "#/components/x-stackQL-resources/db_backups/methods/list_db_backups" + insert: + - $ref: "#/components/x-stackQL-resources/db_backups/methods/create_db_backup" + update: [] + delete: + - $ref: "#/components/x-stackQL-resources/db_backups/methods/delete_db_backup" db_clusters: id: aws.timestream_influxdb.db_clusters name: db_clusters diff --git a/providers/src/aws/v00.00.00000/services/transcribe.yaml b/providers/src/aws/v00.00.00000/services/transcribe.yaml index c4c7c979..498febc9 100644 --- a/providers/src/aws/v00.00.00000/services/transcribe.yaml +++ b/providers/src/aws/v00.00.00000/services/transcribe.yaml @@ -2093,6 +2093,8 @@ components: - af-ZA - ar-AE - ar-SA + - am-ET + - cy-GB - da-DK - de-CH - de-DE @@ -2104,16 +2106,24 @@ components: - en-US - en-WL - es-ES + - es-MX - es-US + - fa-AF - fa-IR - fr-CA - fr-FR + - ga-IE + - gd-GB - he-IL - hi-IN + - ht-HT - id-ID - it-IT - ja-JP + - jv-ID + - km-KH - ko-KR + - my-MM - ms-MY - nl-NL - pt-BR @@ -2170,6 +2180,7 @@ components: - mr-IN - mt-MT - no-NO + - ne-NP - or-IN - pa-IN - pl-PL @@ -2180,6 +2191,7 @@ components: - sk-SK - sl-SI - so-SO + - sq-AL - sr-RS - su-ID - sw-BI diff --git a/providers/src/aws/v00.00.00000/services/trustedadvisor.yaml b/providers/src/aws/v00.00.00000/services/trustedadvisor.yaml index 7f3cb930..0b08b3d5 100644 --- a/providers/src/aws/v00.00.00000/services/trustedadvisor.yaml +++ b/providers/src/aws/v00.00.00000/services/trustedadvisor.yaml @@ -423,6 +423,60 @@ paths: application/json: schema: $ref: "#/components/schemas/ListRecommendationsResponse" + /v1/recommendations-for-resource/{aws_resource_arn}: + get: + operationId: ListRecommendationsForResource + description: List all Trusted Advisor recommendations for a given AWS resource ARN. + parameters: + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListRecommendationsForResourceRequestNextTokenString" + description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListRecommendationsForResourceRequestMaxResultsInteger" + description: The maximum number of results to return per page + - name: aws_resource_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AwsResourceArn" + description: The ARN of the AWS resource to query recommendations for + - name: pillar + in: query + required: false + schema: + $ref: "#/components/schemas/RecommendationPillar" + description: The pillar that the recommendation belongs to + - name: status + in: query + required: false + schema: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the Recommendation Resource + - name: checkArn + in: query + required: false + schema: + $ref: "#/components/schemas/CheckArn" + description: The AWS Trusted Advisor Check ARN that relates to the Recommendation + - name: language + in: query + required: false + schema: + $ref: "#/components/schemas/RecommendationLanguage" + description: The ISO 639-1 code for the language that you want your recommendations to appear in. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListRecommendationsForResourceResponse" /v1/organization-recommendations/{organization_recommendation_identifier}/lifecycle: put: operationId: UpdateOrganizationRecommendationLifecycle @@ -960,6 +1014,18 @@ components: type: object properties: {} description: The column headings for the metadata returned in the resource + resourceArnQueryable: + $ref: "#/components/schemas/Boolean" + description: Indicates whether this check is supported by the ListRecommendationsForResource API. + awsResourceTypes: + $ref: "#/components/schemas/StringList" + description: The AWS resource types that this check evaluates (for example, AWS::EC2::Instance). + checkGranularity: + $ref: "#/components/schemas/String" + description: "The granularity level at which the check operates: resource, account, or account_region." + recommendationId: + $ref: "#/components/schemas/String" + description: The recommendation identifier associated with the check. required: - id - arn @@ -974,6 +1040,10 @@ components: minLength: 20 maxLength: 2048 pattern: arn:[\w-]+:trustedadvisor:::check\/[\w-]+ + StringList: + type: array + items: + $ref: "#/components/schemas/String" ListOrganizationRecommendationAccountsRequestNextTokenString: type: string minLength: 4 @@ -1363,6 +1433,76 @@ components: - name - resourcesAggregates - arn + ListRecommendationsForResourceRequestNextTokenString: + type: string + minLength: 4 + maxLength: 10000 + ListRecommendationsForResourceRequestMaxResultsInteger: + type: integer + minimum: 1 + maximum: 600 + AwsResourceArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:aws(-\w+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)* + ListRecommendationsForResourceResponse: + type: object + properties: + nextToken: + $ref: "#/components/schemas/ListRecommendationsForResourceResponseNextTokenString" + description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + recommendationForResourceSummaries: + $ref: "#/components/schemas/RecommendationForResourceSummaryList" + description: List of Trusted Advisor recommendations associated with the given AWS resource + required: + - recommendationForResourceSummaries + ListRecommendationsForResourceResponseNextTokenString: + type: string + minLength: 4 + maxLength: 10000 + RecommendationForResourceSummaryList: + type: array + items: + $ref: "#/components/schemas/RecommendationForResourceSummary" + RecommendationForResourceSummary: + description: Summary of a Recommendation for a specific AWS Resource + type: object + properties: + checkArn: + $ref: "#/components/schemas/CheckArn" + description: The Check ARN + recommendationArn: + $ref: "#/components/schemas/AccountRecommendationArn" + description: The Recommendation ARN + awsResourceArn: + $ref: "#/components/schemas/AwsResourceArn" + description: The AWS Resource ARN + status: + $ref: "#/components/schemas/ResourceStatus" + description: The current status of the recommendation + lastUpdatedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: When the recommendation was last updated + exclusionStatus: + $ref: "#/components/schemas/ExclusionStatus" + description: The exclusion status of the recommendation + metadata: + type: object + properties: {} + description: Metadata associated with the recommendation + pillars: + $ref: "#/components/schemas/RecommendationPillarList" + description: The Pillars that the Recommendation is optimizing + required: + - checkArn + - recommendationArn + - awsResourceArn + - status + - lastUpdatedAt + - exclusionStatus + - metadata + - pillars UpdateRecommendationLifecycleStage: type: string enum: @@ -1579,3 +1719,31 @@ components: insert: [] update: [] delete: [] + recommendations_for_resources: + id: aws.trustedadvisor.recommendations_for_resources + name: recommendations_for_resources + title: recommendations_for_resources + methods: + list_recommendations_for_resource: + operation: + $ref: "#/paths/~1v1~1recommendations-for-resource~1{aws_resource_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.recommendationForResourceSummaries + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/recommendations_for_resources/methods/list_recommendations_for_resource" + insert: [] + update: [] + delete: [] diff --git a/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml b/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml index be237631..b949fc68 100644 --- a/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml +++ b/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml @@ -226,7 +226,7 @@ paths: /CreatePolicyStore: post: operationId: CreatePolicyStore - description: Creates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. + description: Creates a policy store. A policy store is a container for policy resources. As of May 2026, Verified Permissions has aligned with Cedar and now supports multiple namespaces. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. parameters: - name: X-Amz-Target in: header @@ -464,7 +464,7 @@ paths: /DeletePolicyStoreAlias: post: operationId: DeletePolicyStoreAlias - description: Deletes the specified policy store alias. This operation is idempotent. If you specify a policy store alias that does not exist, the request response will still return a successful HTTP 200 status code. When a policy store alias is deleted, it enters the PendingDeletion state. When a policy store alias is in the PendingDeletion state, new policy store aliases cannot be created with the same name. If the policy store alias is used in an API that has a policyStoreId field, the operation will fail with a ResourceNotFound exception. + description: Deletes the specified policy store alias. This operation is idempotent. If you specify a policy store alias that does not exist, the request response will still return a successful HTTP 200 status code. By default, when a policy store alias is deleted, it enters the PendingDeletion state. When a policy store alias is in the PendingDeletion state, new policy store aliases cannot be created with the same name. If the policy store alias is used in an API that has a policyStoreId field, the operation will fail with a ResourceNotFound exception. To immediately delete a policy store alias and bypass the PendingDeletion state, set the deletionMode parameter to HardDelete. Verified Permissions is eventually consistent. If you hard delete a policy store alias and then immediately recreate it to be associated with a different policy store, requests that reference this alias may continue to be evaluated against the previously associated policy store for a short period of time. parameters: - name: X-Amz-Target in: header @@ -485,6 +485,9 @@ paths: aliasName: $ref: "#/components/schemas/Alias" description: Specifies the name of the policy store alias that you want to delete. The alias name must always be prefixed with policy-store-alias/. + deletionMode: + $ref: "#/components/schemas/DeletionMode" + description: "Specifies the deletion mode for the policy store alias. The valid values are: SoftDelete – The policy store alias enters the PendingDeletion state. This is the default behavior when no deletionMode is specified. HardDelete – The policy store alias is immediately deleted, bypassing the PendingDeletion state." required: - aliasName responses: @@ -2203,6 +2206,12 @@ components: type: object DeletePolicyStoreOutput: type: object + DeletionMode: + description: "The deletion mode for a resource. The valid values are: SoftDelete – The resource enters the PendingDeletion state. This is the default behavior. HardDelete – The resource is immediately deleted, bypassing the PendingDeletion state." + type: string + enum: + - SoftDelete + - HardDelete DeletePolicyStoreAliasOutput: type: object DeletePolicyTemplateOutput: diff --git a/providers/src/aws/v00.00.00000/services/vpc_lattice.yaml b/providers/src/aws/v00.00.00000/services/vpc_lattice.yaml index fb7d5552..2e5e2207 100644 --- a/providers/src/aws/v00.00.00000/services/vpc_lattice.yaml +++ b/providers/src/aws/v00.00.00000/services/vpc_lattice.yaml @@ -439,6 +439,8 @@ paths: $ref: "#/components/schemas/CertificateArn" authType: $ref: "#/components/schemas/AuthType" + idleTimeoutSeconds: + $ref: "#/components/schemas/IdleTimeoutSeconds" required: - name responses: @@ -678,7 +680,7 @@ paths: clientToken: $ref: "#/components/schemas/ClientToken" serviceNetworkIdentifier: - $ref: "#/components/schemas/ServiceNetworkIdentifier" + $ref: "#/components/schemas/ServiceNetworkIdentifierWithoutRegex" vpcIdentifier: $ref: "#/components/schemas/VpcId" privateDnsEnabled: @@ -1407,6 +1409,8 @@ paths: $ref: "#/components/schemas/CertificateArn" authType: $ref: "#/components/schemas/AuthType" + idleTimeoutSeconds: + $ref: "#/components/schemas/IdleTimeoutSeconds" responses: "200": description: Success @@ -1593,7 +1597,7 @@ paths: $ref: "#/components/schemas/ServiceNetworkVpcAssociationIdentifier" description: The ID or ARN of the association. requestBody: - required: true + required: false content: application/json: schema: @@ -1601,8 +1605,10 @@ paths: properties: securityGroupIds: $ref: "#/components/schemas/UpdateServiceNetworkVpcAssociationRequestSecurityGroupIdsList" - required: - - securityGroupIds + privateDnsEnabled: + $ref: "#/components/schemas/Boolean" + dnsOptions: + $ref: "#/components/schemas/DnsOptions" responses: "200": description: Success @@ -2747,6 +2753,10 @@ components: enum: - NONE - AWS_IAM + IdleTimeoutSeconds: + type: integer + minimum: 60 + maximum: 600 CreateServiceResponse: type: object properties: @@ -2771,6 +2781,9 @@ components: authType: $ref: "#/components/schemas/AuthType" description: The type of IAM policy. + idleTimeoutSeconds: + $ref: "#/components/schemas/IdleTimeoutSeconds" + description: The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it. dnsEntry: $ref: "#/components/schemas/DnsEntry" description: The public DNS name of the service. @@ -3599,10 +3612,10 @@ components: description: The IDs of the VPC subnets for resource gateway. serviceManaged: $ref: "#/components/schemas/Boolean" - description: Indicates whether the resource gateway is managed by an AWS service. + description: Indicates whether the resource gateway is managed by an Amazon Web Services service. managedBy: $ref: "#/components/schemas/String" - description: The AWS service that manages the resource gateway. + description: The Amazon Web Services service that manages the resource gateway. securityGroupIds: $ref: "#/components/schemas/SecurityGroupList" description: The security group IDs associated with the resource gateway. @@ -3695,6 +3708,9 @@ components: authType: $ref: "#/components/schemas/AuthType" description: The type of IAM policy. + idleTimeoutSeconds: + $ref: "#/components/schemas/IdleTimeoutSeconds" + description: The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it. failureCode: $ref: "#/components/schemas/FailureCode" description: The failure code. @@ -4925,6 +4941,9 @@ components: authType: $ref: "#/components/schemas/AuthType" description: The type of IAM policy. + idleTimeoutSeconds: + $ref: "#/components/schemas/IdleTimeoutSeconds" + description: The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it. UpdateServiceNetworkResponse: type: object properties: @@ -4962,6 +4981,12 @@ components: securityGroupIds: $ref: "#/components/schemas/SecurityGroupList" description: The IDs of the security groups. + privateDnsEnabled: + $ref: "#/components/schemas/Boolean" + description: Indicates if private DNS is enabled for the VPC association. + dnsOptions: + $ref: "#/components/schemas/DnsOptions" + description: DNS options for the service network VPC association. UpdateTargetGroupResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/wafv2.yaml b/providers/src/aws/v00.00.00000/services/wafv2.yaml index 24498941..ea05a881 100644 --- a/providers/src/aws/v00.00.00000/services/wafv2.yaml +++ b/providers/src/aws/v00.00.00000/services/wafv2.yaml @@ -44,7 +44,7 @@ paths: description: The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. ResourceArn: $ref: "#/components/schemas/ResourceArn" - description: "The Amazon Resource Name (ARN) of the resource to associate with the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id" + description: "The Amazon Resource Name (ARN) of the resource to associate with the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id For an Amazon Bedrock AgentCore Gateway: arn:partition:bedrock-agentcore:region:account-id:gateway/gateway-id" required: - WebACLArn - ResourceArn @@ -272,6 +272,9 @@ paths: CustomResponseBodies: $ref: "#/components/schemas/CustomResponseBodies" description: A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the rule group. Provide this when any rule in the rule group uses the Monetize action. required: - Name - Scope @@ -287,7 +290,7 @@ paths: /CreateWebACL: post: operationId: CreateWebACL - description: Creates a WebACL per the specifications provided. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. + description: Creates a WebACL per the specifications provided. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, Amazon Web Services Verified Access instance, and Amazon Bedrock AgentCore Gateway. parameters: - name: X-Amz-Target in: header @@ -350,6 +353,9 @@ paths: ApplicationConfig: $ref: "#/components/schemas/ApplicationConfig" description: Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs. + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the web ACL. Provide this when any rule in the web ACL uses the Monetize action. required: - Name - Scope @@ -825,7 +831,7 @@ paths: properties: ResourceArn: $ref: "#/components/schemas/ResourceArn" - description: "The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id" + description: "The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id For an Amazon Bedrock AgentCore Gateway: arn:partition:bedrock-agentcore:region:account-id:gateway/gateway-id" required: - ResourceArn responses: @@ -1189,6 +1195,174 @@ paths: application/json: schema: $ref: "#/components/schemas/GetRegexPatternSetResponse" + /GetRevenueStatistics: + post: + operationId: GetRevenueStatistics + description: "Retrieves ranked monetization statistics. Use the StatisticType parameter to specify the ranking: TOP_SOURCES_BY_REVENUE for top sources by revenue, or TOP_PATHS_BY_REVENUE for top content paths by revenue. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST." + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSWAF_20190729.GetRevenueStatistics + default: AWSWAF_20190729.GetRevenueStatistics + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + StatisticType: + $ref: "#/components/schemas/RankingStatisticType" + description: TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path. + TimeWindow: + $ref: "#/components/schemas/TimeWindow" + description: The time range for the query. Specify start and end timestamps. + Scope: + $ref: "#/components/schemas/Scope" + description: Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL). + Currency: + $ref: "#/components/schemas/Currency" + description: The currency for the revenue amounts in the response. + GroupBy: + $ref: "#/components/schemas/GroupByType" + description: "The dimension to group results by: NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL. Required when StatisticType is TOP_SOURCES_BY_REVENUE. Not required for TOP_PATHS_BY_REVENUE, where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException." + Filters: + $ref: "#/components/schemas/MonetizationFilterList" + description: Optional filters to narrow the results. + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. Use it in a subsequent request to retrieve the next page of results. + Limit: + $ref: "#/components/schemas/PathStatisticsLimit" + description: The maximum number of results to return. + SortBy: + $ref: "#/components/schemas/RankingSortBy" + description: "The field to sort results by: REVENUE, PERCENTAGE, or NAME." + SortOrder: + $ref: "#/components/schemas/SortOrder" + description: "The sort order: ASC for ascending or DESC for descending." + required: + - StatisticType + - TimeWindow + - Scope + - Currency + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRevenueStatisticsResponse" + /GetRevenueStatisticsSummary: + post: + operationId: GetRevenueStatisticsSummary + description: Retrieves a summary of monetization revenue for the specified time window. Returns total revenue, revenue by verification tier, total settlements, and total HTTP 402 responses served. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSWAF_20190729.GetRevenueStatisticsSummary + default: AWSWAF_20190729.GetRevenueStatisticsSummary + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + TimeWindow: + $ref: "#/components/schemas/TimeWindow" + description: The time range for the revenue summary query. Specify start and end timestamps. + Scope: + $ref: "#/components/schemas/Scope" + description: Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL). AI bot monetization is only available for CLOUDFRONT scope. + Currency: + $ref: "#/components/schemas/Currency" + description: The currency for the revenue amounts in the response. Currently only USDC is supported. + Filters: + $ref: "#/components/schemas/MonetizationFilterList" + description: Optional filters to narrow the results. You can filter by source name, category, organization, intent, verified status, content path, web ACL ARN, or currency mode. + required: + - TimeWindow + - Scope + - Currency + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRevenueStatisticsSummaryResponse" + /GetRevenueStatisticsTimeSeries: + post: + operationId: GetRevenueStatisticsTimeSeries + description: Retrieves time series data for monetization revenue. Returns data points aggregated at the specified interval for the given time window. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSWAF_20190729.GetRevenueStatisticsTimeSeries + default: AWSWAF_20190729.GetRevenueStatisticsTimeSeries + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + StatisticType: + $ref: "#/components/schemas/TimeSeriesStatisticType" + description: "The type of time series data to retrieve: DATE_HISTOGRAM for revenue over time, or PAYMENT_TRAFFIC for payment traffic patterns." + TimeWindow: + $ref: "#/components/schemas/TimeWindow" + description: The time range for the query. Specify start and end timestamps. + Scope: + $ref: "#/components/schemas/Scope" + description: Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL). + Interval: + $ref: "#/components/schemas/IntervalType" + description: "The time interval for aggregating data points: MINUTELY, FIVE_MINUTELY, HOURLY, or DAILY." + Currency: + $ref: "#/components/schemas/Currency" + description: The currency for the amounts in the response. + GroupBy: + $ref: "#/components/schemas/GroupByType" + description: The dimension to group results by. + Filters: + $ref: "#/components/schemas/MonetizationFilterList" + description: Optional filters to narrow the results. + Limit: + $ref: "#/components/schemas/MaxDataPoints" + description: "The maximum number of data points to return. Minimum: 1. Maximum: 10000." + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. + required: + - StatisticType + - TimeWindow + - Scope + - Interval + - Currency + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetRevenueStatisticsTimeSeriesResponse" /GetRuleGroup: post: operationId: GetRuleGroup @@ -1405,7 +1579,7 @@ paths: properties: ResourceArn: $ref: "#/components/schemas/ResourceArn" - description: "The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id" + description: "The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve. The ARN must be in one of the following formats: For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id For an Amazon Bedrock AgentCore Gateway: arn:partition:bedrock-agentcore:region:account-id:gateway/gateway-id" required: - ResourceArn responses: @@ -1813,6 +1987,62 @@ paths: application/json: schema: $ref: "#/components/schemas/ListRuleGroupsResponse" + /ListSettlementRecords: + post: + operationId: ListSettlementRecords + description: Retrieves individual settlement transaction records for monetization. Each record represents a single payment transaction between a client and your protected resource. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST. + parameters: + - name: X-Amz-Target + in: header + description: Action Header + required: false + schema: + type: string + enum: + - AWSWAF_20190729.ListSettlementRecords + default: AWSWAF_20190729.ListSettlementRecords + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + type: object + properties: + TimeWindow: + $ref: "#/components/schemas/TimeWindow" + description: The time range for the query. Specify start and end timestamps. + Scope: + $ref: "#/components/schemas/Scope" + description: Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL). + Currency: + $ref: "#/components/schemas/Currency" + description: The currency for the amounts in the response. + Filters: + $ref: "#/components/schemas/MonetizationFilterList" + description: Optional filters to narrow the results. You can filter by payer address, status, source name, network, or other settlement fields. + SortBy: + $ref: "#/components/schemas/SettlementSortBy" + description: "The field to sort settlement records by: TIMESTAMP, AMOUNT, NAME, or STATUS." + SortOrder: + $ref: "#/components/schemas/SortOrder" + description: "The sort order: ASC for ascending or DESC for descending." + Limit: + $ref: "#/components/schemas/SettlementRecordLimit" + description: "The maximum number of settlement records to return. Minimum: 1. Maximum: 100." + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. + required: + - TimeWindow + - Scope + - Currency + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListSettlementRecordsResponse" /ListTagsForResource: post: operationId: ListTagsForResource @@ -2285,6 +2515,9 @@ paths: CustomResponseBodies: $ref: "#/components/schemas/CustomResponseBodies" description: A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the rule group. Provide this when any rule in the rule group uses the Monetize action. required: - Name - Scope @@ -2301,7 +2534,7 @@ paths: /UpdateWebACL: post: operationId: UpdateWebACL - description: "Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify a web ACL, do the following: Retrieve it by calling GetWebACL Update its settings as needed Provide the complete web ACL specification to this call A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. After you change a rule action setting, you might see the old action in some places and the new action in others. After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another." + description: "Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify a web ACL, do the following: Retrieve it by calling GetWebACL Update its settings as needed Provide the complete web ACL specification to this call A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, Amazon Web Services Verified Access instance, and Amazon Bedrock AgentCore Gateway. Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. After you change a rule action setting, you might see the old action in some places and the new action in others. After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another." parameters: - name: X-Amz-Target in: header @@ -2367,6 +2600,9 @@ paths: ApplicationConfig: $ref: "#/components/schemas/ApplicationConfig" description: "Configures the ability for the WAF console to store and retrieve application attributes. Application attributes help WAF give recommendations for protection packs. When using UpdateWebACL, ApplicationConfig follows these rules: If you omit ApplicationConfig from the request, all existing entries in the web ACL are retained. If you include ApplicationConfig, entries must match the existing values exactly. Any attempt to modify existing entries will result in an error." + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the web ACL. Provide this when any rule in the web ACL uses the Monetize action. required: - Name - Scope @@ -2551,6 +2787,9 @@ components: TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. PositionalConstraint: $ref: "#/components/schemas/PositionalConstraint" description: "The area within the portion of the web request that you want WAF to search for SearchString. Valid values include the following: CONTAINS The specified part of the web request must include the value of SearchString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true: SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot. SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of SearchString. STARTS_WITH The value of SearchString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of SearchString must appear at the end of the specified part of the web request." @@ -2871,6 +3110,44 @@ components: - BASE64_DECODE_EXT - URL_DECODE_UNI - UTF8_TO_UNICODE + - REMOVE_WHITESPACE + - TRIM + - TRIM_LEFT + - TRIM_RIGHT + - REMOVE_COMMENTS_CHAR + - UPPERCASE + - CMD_LINE_WIN + - CMD_LINE_UNIX + - JS_DECODE_EXT + - SHA256 + PreParseTextTransformations: + type: array + items: + $ref: "#/components/schemas/PreParseTextTransformation" + PreParseTextTransformation: + description: A pre-parse text transformation that normalizes the raw query string before WAF parses it into individual query arguments. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. + type: object + properties: + Priority: + $ref: "#/components/schemas/PreParseTextTransformationPriority" + description: Sets the relative processing order for the pre-parse text transformations that you define. WAF processes all transformations, from lowest priority value to highest, before inspecting the transformed content. + Type: + $ref: "#/components/schemas/PreParseTextTransformationType" + description: The type of pre-parse text transformation to apply to the raw query string. + required: + - Priority + - Type + PreParseTextTransformationPriority: + type: integer + minimum: 0 + PreParseTextTransformationType: + type: string + enum: + - NONE + - URL_DECODE + - URL_DECODE_UNI + - COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA + - REPLACE_SEMICOLONS_WITH_AMPERSANDS PositionalConstraint: type: string enum: @@ -2889,6 +3166,9 @@ components: TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. SensitivityLevel: $ref: "#/components/schemas/SensitivityLevel" description: "The sensitivity that you want WAF to use to inspect for SQL injection attacks. HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide. LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives. Default: LOW" @@ -2910,6 +3190,9 @@ components: TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. required: - FieldToMatch - TextTransformations @@ -2929,6 +3212,9 @@ components: TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. required: - FieldToMatch - ComparisonOperator @@ -3297,6 +3583,9 @@ components: Challenge: $ref: "#/components/schemas/ChallengeAction" description: Instructs WAF to run a Challenge check against the web request. + Monetize: + $ref: "#/components/schemas/MonetizeAction" + description: Instructs WAF to return an HTTP 402 Payment Required response with a price manifest. The requesting client can complete payment and resubmit the request to gain access. This is a terminating action-requests that do not complete payment are blocked. This action is available only for web ACLs associated with Amazon CloudFront distributions and requires a MonetizationConfig on the web ACL. BlockAction: description: Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction. type: object @@ -3387,6 +3676,18 @@ components: CustomRequestHandling: $ref: "#/components/schemas/CustomRequestHandling" description: Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. + MonetizeAction: + description: Specifies the monetize action settings for a rule. When WAF applies this action, it returns an HTTP 402 Payment Required response containing pricing information that the requesting client uses to complete payment and gain access to the resource. This is a terminating action-if the client does not complete the 402 payment flow, the request is blocked. This action is available only for web ACLs associated with Amazon CloudFront distributions. You must configure a MonetizationConfig on the web ACL or rule group before adding rules that use this action. You cannot use the Monetize action for rate-based rules. + type: object + properties: + PriceMultiplier: + $ref: "#/components/schemas/PriceMultiplier" + description: "An integer multiplier applied to the base price defined in the web ACL's MonetizationConfig. The effective price for the request is the base price multiplied by this value. Specify as a string. Valid values: 1 to 100." + PriceMultiplier: + type: string + minLength: 1 + maxLength: 3 + pattern: ^([1-9][0-9]?|100)$ IPSetReferenceStatement: description: A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it. type: object @@ -3435,6 +3736,9 @@ components: TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. required: - ARN - FieldToMatch @@ -4096,7 +4400,7 @@ components: properties: RegexString: $ref: "#/components/schemas/RegexPatternString" - description: The string representing the regular expression. + description: The string representing the regular expression. WAF enforces a quota on the maximum number of characters in a regex pattern. For the current limit, see WAF quotas in the WAF Developer Guide. RegexPatternString: type: string minLength: 1 @@ -4131,13 +4435,16 @@ components: properties: RegexString: $ref: "#/components/schemas/RegexPatternString" - description: The string representing the regular expression. + description: The string representing the regular expression. WAF enforces a quota on the maximum number of characters in a regex pattern. For the current limit, see WAF quotas in the WAF Developer Guide. FieldToMatch: $ref: "#/components/schemas/FieldToMatch" description: The part of the web request that you want WAF to inspect. TextTransformations: $ref: "#/components/schemas/TextTransformations" description: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents. + PreParseTextTransformations: + $ref: "#/components/schemas/PreParseTextTransformations" + description: Pre-parse text transformations normalize the raw query string before WAF parses it into individual query arguments. They are applied before the standard text transformations. Pre-parse text transformations are only supported when FieldToMatch is SingleQueryArgument or AllQueryArguments. You can specify up to 10 pre-parse text transformations per rule statement. required: - RegexString - FieldToMatch @@ -4387,6 +4694,89 @@ components: CustomResponseBodies: type: object properties: {} + MonetizationConfig: + description: The monetization configuration for a web ACL or rule group. Specifies the cryptocurrency payment networks and currency mode for AI bot monetization. You must provide this configuration when any rule in the web ACL or rule group uses the Monetize action. + type: object + properties: + CryptoConfig: + $ref: "#/components/schemas/CryptoConfig" + description: The cryptocurrency payment configuration, including the blockchain networks and wallet addresses where you receive payments. + CurrencyMode: + $ref: "#/components/schemas/CurrencyMode" + description: Specifies whether the configuration uses real or test currency. Set to REAL to settle payments in USDC on production blockchain networks (Base, Solana). Set to TEST to settle on testnet networks (Base Sepolia, Solana Devnet) with tokens that have no monetary value. If not specified, defaults to REAL. + CryptoConfig: + description: The cryptocurrency payment configuration for AI bot monetization. Contains the list of blockchain payment networks where you receive payments. + type: object + properties: + PaymentNetworks: + $ref: "#/components/schemas/PaymentNetworks" + description: The blockchain payment networks configured to receive payments. You can specify 1 to 2 networks. All networks must be in the same environment-either all production networks (Base, Solana) or all test networks (Base Sepolia, Solana Devnet). + required: + - PaymentNetworks + PaymentNetworks: + type: array + items: + $ref: "#/components/schemas/PaymentNetwork" + PaymentNetwork: + description: A blockchain payment network configuration for receiving AI bot monetization payments. Specifies the blockchain chain, your wallet address on that chain, and the price per request. + type: object + properties: + Chain: + $ref: "#/components/schemas/BlockchainChain" + description: "The blockchain network for receiving payments. Production networks: BASE (Base mainnet), SOLANA (Solana mainnet). Test networks: BASE_SEPOLIA (Base Sepolia testnet), SOLANA_DEVNET (Solana Devnet)." + WalletAddress: + $ref: "#/components/schemas/WalletAddress" + description: Your wallet address on the specified blockchain where payments are sent. For EVM chains (Base, Base Sepolia), provide a valid Ethereum address (42 characters including 0x prefix). For Solana chains, provide a valid Base58-encoded public key (32-44 characters). For EVM addresses, WAF performs EIP-55 checksum validation for typo detection when the address uses a mix of lower and upper case letters. You can bypass this validation by providing the address in all lowercase or all uppercase. + Prices: + $ref: "#/components/schemas/Prices" + description: The price configuration for this payment network. Currently supports a single price entry in USDC. + required: + - Chain + - WalletAddress + - Prices + BlockchainChain: + type: string + enum: + - BASE + - SOLANA + - BASE_SEPOLIA + - SOLANA_DEVNET + WalletAddress: + type: string + minLength: 26 + maxLength: 44 + pattern: .*\S.* + Prices: + type: array + items: + $ref: "#/components/schemas/Price" + Price: + description: The price per request for a payment network, specifying the amount and cryptocurrency. + type: object + properties: + Amount: + $ref: "#/components/schemas/PriceAmount" + description: "The price per request as a decimal string in the specified currency. Minimum: 0.001. Maximum: 999999999.999. Supports up to 3 decimal places." + Currency: + $ref: "#/components/schemas/CryptoCurrency" + description: The cryptocurrency for payment. Currently only USDC is supported. + required: + - Amount + - Currency + PriceAmount: + type: string + minLength: 1 + maxLength: 13 + pattern: ^([1-9][0-9]*(\.[0-9]{1,3})?|0\.([1-9][0-9]{0,2}|0[1-9][0-9]?|00[1-9]))$ + CryptoCurrency: + type: string + enum: + - USDC + CurrencyMode: + type: string + enum: + - REAL + - TEST CreateRuleGroupResponse: type: object properties: @@ -4896,6 +5286,7 @@ components: - COUNT - CAPTCHA - CHALLENGE + - MONETIZE - EXCLUDED_AS_COUNT LabelNameCondition: description: A single label name condition for a Condition in a logging filter. @@ -5026,6 +5417,266 @@ components: RegularExpressionList: $ref: "#/components/schemas/RegularExpressionList" description: The regular expression patterns in the set. + RankingStatisticType: + type: string + enum: + - TOP_SOURCES_BY_REVENUE + - TOP_PATHS_BY_REVENUE + TimeWindow: + description: In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request. + type: object + properties: + StartTime: + $ref: "#/components/schemas/Timestamp" + description: The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + EndTime: + $ref: "#/components/schemas/Timestamp" + description: The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + required: + - StartTime + - EndTime + Currency: + type: string + enum: + - USDC + GroupByType: + type: string + enum: + - NAME + - CATEGORY + - INTENT + - ORGANIZATION + - WEBACL + MonetizationFilterList: + type: array + items: + $ref: "#/components/schemas/MonetizationFilter" + MonetizationFilter: + description: "A filter for narrowing monetization statistics and settlement record results. Specify a filter name and one or more values to match. Filter behavior: Multiple values within one filter: OR (match any) Multiple filters: AND (all must match) No duplicate filter names allowed (rejected with error) Duplicate values within a filter are silently deduplicated If no CurrencyMode filter is specified, defaults to REAL" + type: object + properties: + Name: + $ref: "#/components/schemas/MonetizationFilterName" + description: "The filter name. Format: Key is a string, Value is a list of strings. Enum-restricted (invalid values rejected): CurrencyMode: REAL, TEST ChainName: BASE, SOLANA, BASE_SEPOLIA, SOLANA_DEVNET SettlementStatus: SETTLED, PENDING, FAILED, SERVICE_ERROR, SKIPPED_ORIGIN_ERROR, DUPLICATE HttpSourceName: CF, ALB, APIGW, APPRUNNER, COGNITO, VERIFIED_ACCESS ARN-validated: WebACLArn: valid WAFv2 web ACL ARN Free-text (any string up to 256 chars): SourceName: The name of the bot. Populated from Bot Control verified bot labels. SourceCategory: The category classification of the bot. From Bot Control categorization. Intent: The declared intent of the bot request. Organization: The organization operating the bot. UriPathPrefix: The URI path of the request that was monetized. RequestId: The WAF request ID associated with the transaction. Matches the requestId in WAF logs. Pattern: ^[a-zA-Z0-9:._\\-=+/]+$ TransactionId: The blockchain transaction identifier. Pattern: ^[a-zA-Z0-9:._\\-=+/]+$ TerminatingRuleName: The name of the WAF rule that triggered the Monetize action. PayerAddress: The blockchain wallet address of the paying client. Pattern: ^[a-zA-Z0-9:._\\-=+/]+$ HttpSourceId: The identifier of the Amazon Web Services resource associated with the web ACL (for example, CloudFront distribution ID)." + Values: + $ref: "#/components/schemas/MonetizationFilterValueList" + description: "The values to filter on. Specify as a list of strings. Results match any of the specified values (OR logic). Duplicate values are silently deduplicated. Maximum: 20 values per filter." + required: + - Name + - Values + MonetizationFilterName: + type: string + minLength: 1 + maxLength: 128 + MonetizationFilterValueList: + type: array + items: + $ref: "#/components/schemas/MonetizationFilterValue" + MonetizationFilterValue: + type: string + minLength: 1 + maxLength: 256 + NextMarker: + type: string + minLength: 1 + maxLength: 256 + pattern: .*\S.* + PathStatisticsLimit: + type: integer + minimum: 1 + maximum: 100 + RankingSortBy: + type: string + enum: + - REVENUE + - PERCENTAGE + - NAME + SortOrder: + type: string + enum: + - ASC + - DESC + GetRevenueStatisticsResponse: + type: object + properties: + SourceStatistics: + $ref: "#/components/schemas/SourceStatisticsList" + description: Statistics for top revenue sources (AI bots). Populated when StatisticType is TOP_SOURCES_BY_REVENUE. + RevenuePathStatistics: + $ref: "#/components/schemas/RevenuePathStatisticsList" + description: Statistics for top revenue paths. Populated when StatisticType is TOP_PATHS_BY_REVENUE. + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. + SourceStatisticsList: + type: array + items: + $ref: "#/components/schemas/SourceStatistics" + SourceStatistics: + description: Revenue statistics for a single AI bot source, including the bot name, revenue amount, request count, and verification status. + type: object + properties: + SourceName: + $ref: "#/components/schemas/FilterString" + description: The name of the AI bot. + Percentage: + $ref: "#/components/schemas/PercentageValue" + description: The percentage of total revenue from this source. + Amount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The total revenue amount from this source in the specified currency. + RequestCount: + $ref: "#/components/schemas/RequestCount" + description: The number of monetized requests from this source. + SourceCategory: + $ref: "#/components/schemas/FilterString" + description: The category of this AI bot source. + Intent: + $ref: "#/components/schemas/FilterString" + description: The declared intent of the AI bot (for example, summarize, index, or train). + Organization: + $ref: "#/components/schemas/FilterString" + description: The organization associated with the AI bot. + Verified: + $ref: "#/components/schemas/VerifiedStatus" + description: Indicates whether the AI bot's identity was verified — for example, through a cryptographically signed request (Web Bot Auth) or another published verification method. This value is meaningful only when GroupBy is NAME, where each result represents a single, identifiable bot. For all other GroupBy values (CATEGORY, INTENT, ORGANIZATION, or WEBACL), a result aggregates multiple bots that may have different verification states, so Verified is always returned as false and should be ignored. Type and required-ness are unchanged (Boolean, optional). + GroupByValue: + $ref: "#/components/schemas/FilterString" + description: The value for the group-by dimension, when grouping is applied. + required: + - SourceName + - Percentage + - Amount + - RequestCount + FilterString: + type: string + minLength: 1 + maxLength: 256 + pattern: .*\S.* + PercentageValue: + type: number + format: double + minimum: 0 + maximum: 100 + MonetizationAmountValue: + type: string + RequestCount: + type: integer + format: int64 + minimum: 0 + VerifiedStatus: + type: boolean + RevenuePathStatisticsList: + type: array + items: + $ref: "#/components/schemas/RevenuePathStatistics" + RevenuePathStatistics: + description: Revenue statistics for a single content path, including the path, revenue amount, and request count. + type: object + properties: + Path: + $ref: "#/components/schemas/PathString" + description: The URI path. + Percentage: + $ref: "#/components/schemas/PercentageValue" + description: The percentage of total revenue from this path. + Amount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The total revenue amount from this path in the specified currency. + RequestCount: + $ref: "#/components/schemas/RequestCount" + description: The number of monetized requests to this path. + required: + - Path + - Percentage + - Amount + - RequestCount + PathString: + type: string + minLength: 1 + maxLength: 512 + GetRevenueStatisticsSummaryResponse: + type: object + properties: + RevenueBreakdown: + $ref: "#/components/schemas/RevenueBreakdown" + description: The revenue breakdown summary for the specified time window and filters. + RevenueBreakdown: + description: A summary of AI bot monetization revenue, including total revenue, revenue by verification tier, and request counts. + type: object + properties: + TotalAmount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The total revenue amount in the specified currency. + VerifiedAmount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The revenue amount from verified AI bots. + UnverifiedAmount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The revenue amount from unverified AI bots. + Currency: + $ref: "#/components/schemas/Currency" + description: The currency of the revenue amounts. + TotalSettled: + $ref: "#/components/schemas/RequestCount" + description: The total number of successfully settled payment transactions. + TotalMonetizeServed: + $ref: "#/components/schemas/RequestCount" + description: The total number of HTTP 402 Payment Required responses served to AI agents. + TimeSeriesStatisticType: + type: string + enum: + - DATE_HISTOGRAM + - PAYMENT_TRAFFIC + IntervalType: + type: string + enum: + - MINUTELY + - FIVE_MINUTELY + - HOURLY + - DAILY + MaxDataPoints: + type: integer + minimum: 1 + maximum: 10000 + GetRevenueStatisticsTimeSeriesResponse: + type: object + properties: + DataPoints: + $ref: "#/components/schemas/DataPointsList" + description: The list of time series data points. + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. + DataPointsList: + type: array + items: + $ref: "#/components/schemas/DataPointEntry" + DataPointEntry: + description: A single data point in a revenue time series, representing aggregated monetization metrics for a specific time interval. + type: object + properties: + Date: + $ref: "#/components/schemas/Timestamp" + description: The timestamp for this data point. + MonetizeServedCount: + $ref: "#/components/schemas/RequestCount" + description: The number of HTTP 402 Payment Required responses served during this interval. + SettledCount: + $ref: "#/components/schemas/RequestCount" + description: The number of successfully settled payments during this interval. + TotalAmount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The total revenue amount during this interval in the specified currency. + Category: + $ref: "#/components/schemas/FilterString" + description: The bot category for this data point, when grouped by category. + Intent: + $ref: "#/components/schemas/FilterString" + description: The intent classification for this data point, when grouped by intent. + GroupByValue: + $ref: "#/components/schemas/FilterString" + description: The group-by dimension value for this data point. GetRuleGroupResponse: type: object properties: @@ -5072,25 +5723,15 @@ components: ConsumedLabels: $ref: "#/components/schemas/LabelSummaries" description: The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule. + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the rule group. Required when any rule in the rule group uses the Monetize action. When a rule group with a MonetizationConfig is used in a web ACL, the rule group's configuration applies to rules within that group unless overridden at the web ACL level. required: - Name - Id - Capacity - ARN - VisibilityConfig - TimeWindow: - description: In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request. - type: object - properties: - StartTime: - $ref: "#/components/schemas/Timestamp" - description: The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. - EndTime: - $ref: "#/components/schemas/Timestamp" - description: The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. - required: - - StartTime - - EndTime ListMaxItems: type: integer format: int64 @@ -5254,24 +5895,10 @@ components: minLength: 1 maxLength: 512 pattern: ^\/[^ ]*$ - FilterString: - type: string - minLength: 1 - maxLength: 256 - pattern: .*\S.* - PathStatisticsLimit: - type: integer - minimum: 1 - maximum: 100 NumberOfTopTrafficBotsPerPath: type: integer minimum: 1 maximum: 10 - NextMarker: - type: string - minLength: 1 - maxLength: 256 - pattern: .*\S.* GetTopPathStatisticsByTrafficResponse: type: object properties: @@ -5330,19 +5957,6 @@ components: BotName: $ref: "#/components/schemas/FilterString" description: The bot name that was used to filter the results. For example, gptbot or googlebot. - PathString: - type: string - minLength: 1 - maxLength: 512 - RequestCount: - type: integer - format: int64 - minimum: 0 - PercentageValue: - type: number - format: double - minimum: 0 - maximum: 100 BotStatisticsList: type: array items: @@ -5377,7 +5991,7 @@ components: $ref: "#/components/schemas/OutputUrl" description: The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide. WebACL: - description: A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. + description: A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, Amazon Web Services Verified Access instance, and Amazon Bedrock AgentCore Gateway. type: object properties: Name: @@ -5444,6 +6058,9 @@ components: ApplicationConfig: $ref: "#/components/schemas/ApplicationConfig" description: Returns a list of ApplicationAttributes. + MonetizationConfig: + $ref: "#/components/schemas/MonetizationConfig" + description: The monetization configuration for the web ACL. Required when any rule in the web ACL uses the Monetize action. Specifies the cryptocurrency payment networks and currency mode for AI bot monetization. required: - Name - Id @@ -5698,6 +6315,7 @@ components: - APP_RUNNER_SERVICE - VERIFIED_ACCESS_INSTANCE - AMPLIFY + - AGENTCORE_GATEWAY ListResourcesForWebACLRowDisplay: type: object properties: @@ -5724,6 +6342,107 @@ components: type: array items: $ref: "#/components/schemas/RuleGroupSummary" + SettlementSortBy: + type: string + enum: + - TIMESTAMP + - AMOUNT + - NAME + - STATUS + SettlementRecordLimit: + type: integer + minimum: 1 + maximum: 100 + ListSettlementRecordsResponse: + type: object + properties: + Settlements: + $ref: "#/components/schemas/SettlementRecordList" + description: The list of settlement records. + NextMarker: + $ref: "#/components/schemas/NextMarker" + description: When you get a paginated response, this marker indicates that additional results are available. + SettlementRecordList: + type: array + items: + $ref: "#/components/schemas/SettlementRecord" + SettlementRecord: + description: A single settlement transaction record for AI bot monetization. Contains details about the payment including timestamp, amount, status, and the parties involved. + type: object + properties: + Timestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp when the settlement was recorded. + PayerAddress: + $ref: "#/components/schemas/SettlementFilterString" + description: The blockchain wallet address of the paying AI agent. + WalletAddress: + $ref: "#/components/schemas/SettlementFilterString" + description: Your receiving wallet address. + Status: + $ref: "#/components/schemas/SettlementStatus" + description: "The status of the settlement. Possible values: SETTLED - The payment was successfully settled on the blockchain and the transfer from the payer's wallet to the publisher's wallet is confirmed. The TransactionId field contains the on-chain transaction hash. Content is served to the client. PENDING - The blockchain transaction has been submitted but not yet confirmed on-chain. This is a transient state that automatically resolves to either SETTLED or FAILED. No action is required. While pending, content is not served and the API returns a 402 response. Clients can retry the request. FAILED - The payment settlement was attempted but failed. Possible causes include insufficient funds, an expired payment authorization, or a reverted blockchain transaction. The failureReason field contains a machine-readable error code. Content is not served. SERVICE_ERROR - Settlement could not be completed due to an internal service issue or an issue with the payment network. Content is not served. The client's payment authorization remains valid and the request can be retried. SKIPPED_ORIGIN_ERROR - The origin returned a non-2xx response, so settlement was intentionally skipped. The client is not charged. DUPLICATE - A prior request with the same payment payload has already been settled. This status typically appears when a previous attempt timed out but the payment was ultimately processed. The client is not charged again." + Amount: + $ref: "#/components/schemas/MonetizationAmountValue" + description: The payment amount in the specified currency. + Currency: + $ref: "#/components/schemas/Currency" + description: The currency of the payment amount. + Network: + $ref: "#/components/schemas/SettlementFilterString" + description: The blockchain network on which the settlement occurred. + TransactionId: + $ref: "#/components/schemas/SettlementIdString" + description: The blockchain transaction identifier. You can use this to verify the transaction on a blockchain explorer. + RequestId: + $ref: "#/components/schemas/SettlementFilterString" + description: The WAF request ID associated with this settlement. + SourceName: + $ref: "#/components/schemas/FilterString" + description: The name of the AI bot that made the payment. + Organization: + $ref: "#/components/schemas/FilterString" + description: The organization associated with the AI bot. + SourceCategory: + $ref: "#/components/schemas/FilterString" + description: The category of the AI bot source. + Intent: + $ref: "#/components/schemas/FilterString" + description: The declared intent of the AI bot request. + Verified: + $ref: "#/components/schemas/VerifiedStatus" + description: Whether the AI bot's identity was verified. + ContentPath: + $ref: "#/components/schemas/FilterString" + description: The content path that was accessed. + WebAclArn: + $ref: "#/components/schemas/ResourceArn" + description: The ARN of the web ACL that processed the request. + RequestTimestamp: + $ref: "#/components/schemas/Timestamp" + description: The timestamp of the original web request. + required: + - Timestamp + - Status + - Amount + SettlementFilterString: + type: string + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z0-9:._\-=+/]+$ + SettlementStatus: + type: string + enum: + - SETTLED + - PENDING + - FAILED + - SERVICE_ERROR + - SKIPPED_ORIGIN_ERROR + - DUPLICATE + SettlementIdString: + type: string + minLength: 1 + maxLength: 256 ListTagsForResourceResponse: type: object properties: @@ -6577,6 +7296,79 @@ components: insert: [] update: [] delete: [] + revenue_statistics: + id: aws.wafv2.revenue_statistics + name: revenue_statistics + title: revenue_statistics + methods: + get_revenue_statistics: + operation: + $ref: "#/paths/~1GetRevenueStatistics/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/revenue_statistics/methods/get_revenue_statistics" + insert: [] + update: [] + delete: [] + revenue_statistics_summaries: + id: aws.wafv2.revenue_statistics_summaries + name: revenue_statistics_summaries + title: revenue_statistics_summaries + methods: + get_revenue_statistics_summary: + operation: + $ref: "#/paths/~1GetRevenueStatisticsSummary/post" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.RevenueBreakdown + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/revenue_statistics_summaries/methods/get_revenue_statistics_summary" + insert: [] + update: [] + delete: [] + revenue_statistics_time_series: + id: aws.wafv2.revenue_statistics_time_series + name: revenue_statistics_time_series + title: revenue_statistics_time_series + methods: + get_revenue_statistics_time_series: + operation: + $ref: "#/paths/~1GetRevenueStatisticsTimeSeries/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/revenue_statistics_time_series/methods/get_revenue_statistics_time_series" + insert: [] + update: [] + delete: [] sampled_requests: id: aws.wafv2.sampled_requests name: sampled_requests @@ -6729,6 +7521,30 @@ components: insert: [] update: [] delete: [] + settlement_records: + id: aws.wafv2.settlement_records + name: settlement_records + title: settlement_records + methods: + list_settlement_records: + operation: + $ref: "#/paths/~1ListSettlementRecords/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + mediaType: application/x-amz-json-1.1 + base: "{}" + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/settlement_records/methods/list_settlement_records" + insert: [] + update: [] + delete: [] tags: id: aws.wafv2.tags name: tags diff --git a/providers/src/aws/v00.00.00000/services/wellarchitected.yaml b/providers/src/aws/v00.00.00000/services/wellarchitected.yaml index 7bea68b3..824b8842 100644 --- a/providers/src/aws/v00.00.00000/services/wellarchitected.yaml +++ b/providers/src/aws/v00.00.00000/services/wellarchitected.yaml @@ -8,7 +8,6 @@ info: x-protocol: rest-json x-apiVersion: "2020-03-31" x-endpointPrefix: wellarchitected - x-jsonVersion: "1.1" servers: - url: https://wellarchitected.{region}.amazonaws.com variables: @@ -65,6 +64,202 @@ paths: responses: "200": description: Success + /api/v1/agent-profiles/{profile_arn}/contexts: + post: + operationId: CreateAgentContext + description: Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile to associate the context with. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/CreateAgentContextRequestClientTokenString" + title: + $ref: "#/components/schemas/CreateAgentContextRequestTitleString" + contextType: + $ref: "#/components/schemas/ContextType" + content: + $ref: "#/components/schemas/ContextContent" + required: + - title + - contextType + - content + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAgentContextResponse" + get: + operationId: ListAgentContexts + description: Lists contexts associated with a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile to list contexts for. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentContextsRequestMaxResultsInteger" + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentContextsRequestNextTokenString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentContextsResponse" + /api/v1/agent-profiles/{profile_arn}/goals: + post: + operationId: CreateAgentGoal + description: Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile to associate the goal with. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/CreateAgentGoalRequestClientTokenString" + pillars: + $ref: "#/components/schemas/Pillars" + title: + $ref: "#/components/schemas/CreateAgentGoalRequestTitleString" + description: + $ref: "#/components/schemas/CreateAgentGoalRequestDescriptionString" + required: + - pillars + - title + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAgentGoalResponse" + get: + operationId: ListAgentGoals + description: Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile to list goals for. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentGoalsRequestMaxResultsInteger" + description: The maximum number of goals to return in a single response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentGoalsRequestNextTokenString" + description: A pagination token returned from a previous call to continue retrieving results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentGoalsResponse" + /api/v1/agent-profiles: + post: + operationId: CreateAgentProfile + description: Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources. + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: "#/components/schemas/CreateAgentProfileRequestNameString" + displayName: + $ref: "#/components/schemas/CreateAgentProfileRequestDisplayNameString" + description: + $ref: "#/components/schemas/CreateAgentProfileRequestDescriptionString" + businessOverview: + $ref: "#/components/schemas/CreateAgentProfileRequestBusinessOverviewString" + pillars: + $ref: "#/components/schemas/Pillars" + deletionProtection: + $ref: "#/components/schemas/Boolean" + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + clientToken: + $ref: "#/components/schemas/CreateAgentProfileRequestClientTokenString" + tags: + $ref: "#/components/schemas/Tags" + required: + - name + - pillars + - executionRoleArn + - aggregationConfiguration + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CreateAgentProfileResponse" + get: + operationId: ListAgentProfiles + description: Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations. + parameters: + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentProfilesRequestMaxResultsInteger" + description: The maximum number of profiles to return in a single call. Default is 100. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentProfilesRequestNextTokenString" + description: A pagination token returned from a previous call to continue retrieving results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentProfilesResponse" /lenses/{lens_alias}/shares: post: operationId: CreateLensShare @@ -120,7 +315,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListWorkloadSharesMaxResults" + $ref: "#/components/schemas/ListLensSharesInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: Status in: query @@ -289,7 +484,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListProfileSharesMaxResults" + $ref: "#/components/schemas/ListProfileSharesInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: Status in: query @@ -352,7 +547,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListReviewTemplatesInputMaxResultsInteger" responses: "200": description: Success @@ -417,7 +612,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListTemplateSharesMaxResults" + $ref: "#/components/schemas/ListTemplateSharesInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: Status in: query @@ -554,7 +749,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListWorkloadSharesMaxResults" + $ref: "#/components/schemas/ListWorkloadSharesInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: Status in: query @@ -568,6 +763,249 @@ paths: application/json: schema: $ref: "#/components/schemas/ListWorkloadSharesOutput" + /api/v1/agent-profiles/{profile_arn}/contexts/{id}: + delete: + operationId: DeleteAgentContext + description: Deletes a context associated with a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the context. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the context to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAgentContextResponse" + get: + operationId: GetAgentContext + description: Retrieves detailed information about a specific context associated with a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the context. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the context to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAgentContextResponse" + put: + operationId: UpdateAgentContext + description: Updates an existing context associated with a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the context. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the context to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/UpdateAgentContextRequestClientTokenString" + title: + $ref: "#/components/schemas/UpdateAgentContextRequestTitleString" + content: + $ref: "#/components/schemas/ContextContent" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentContextResponse" + /api/v1/agent-profiles/{profile_arn}/goals/{id}: + delete: + operationId: DeleteAgentGoal + description: Deletes an optimization goal from a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the goal. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the goal to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAgentGoalResponse" + get: + operationId: GetAgentGoal + description: Retrieves detailed information about a specific optimization goal. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the goal. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the goal to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAgentGoalResponse" + put: + operationId: UpdateAgentGoal + description: Updates the pillars and title of an existing goal associated with a profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile containing the goal to update. + - name: id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the goal to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/UpdateAgentGoalRequestClientTokenString" + pillars: + $ref: "#/components/schemas/Pillars" + title: + $ref: "#/components/schemas/UpdateAgentGoalRequestTitleString" + description: + $ref: "#/components/schemas/UpdateAgentGoalRequestDescriptionString" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentGoalResponse" + /api/v1/agent-profiles/{profile_arn}: + delete: + operationId: DeleteAgentProfile + description: Deletes an optimization profile and its associated configuration. This action cannot be undone. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile to delete. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAgentProfileResponse" + get: + operationId: GetAgentProfile + description: Retrieves detailed information about an optimization profile, including its configuration and metadata. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAgentProfileResponse" + put: + operationId: UpdateAgentProfile + description: Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile to update. + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + clientToken: + $ref: "#/components/schemas/UpdateAgentProfileRequestClientTokenString" + displayName: + $ref: "#/components/schemas/UpdateAgentProfileRequestDisplayNameString" + description: + $ref: "#/components/schemas/UpdateAgentProfileRequestDescriptionString" + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + businessOverview: + $ref: "#/components/schemas/UpdateAgentProfileRequestBusinessOverviewString" + pillars: + $ref: "#/components/schemas/Pillars" + deletionProtection: + $ref: "#/components/schemas/Boolean" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentProfileResponse" /lenses/{lens_alias}: delete: operationId: DeleteLens @@ -1042,10 +1480,58 @@ paths: application/json: schema: $ref: "#/components/schemas/ExportLensOutput" - /workloads/{workload_id}/lensReviews/{lens_alias}/answers/{question_id}: + /api/v1/agent-recommendations/{recommendation_arn}: get: - operationId: GetAnswer - description: Get the answer to a specific question in a workload review. + operationId: GetAgentRecommendation + description: Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance. + parameters: + - name: recommendation_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentRecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation to retrieve. + - name: remediationType + in: query + required: false + schema: + $ref: "#/components/schemas/RemediationType" + description: Optional filter on remediation type. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAgentRecommendationResponse" + /api/v1/agent-profiles/{profile_arn}/generations/{generation_id}: + get: + operationId: GetAgentRecommendationGeneration + description: "Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS." + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The ARN of the optimization profile associated with this generation. + - name: generation_id + in: path + required: true + schema: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the recommendation generation to retrieve. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/GetAgentRecommendationGenerationResponse" + /workloads/{workload_id}/lensReviews/{lens_alias}/answers/{question_id}: + get: + operationId: GetAnswer + description: Get the answer to a specific question in a workload review. parameters: - name: workload_id in: path @@ -1143,7 +1629,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/GetConsolidatedReportMaxResults" + $ref: "#/components/schemas/GetConsolidatedReportInputMaxResultsInteger" description: The maximum number of results to return for this request. responses: "200": @@ -1493,6 +1979,155 @@ paths: application/json: schema: $ref: "#/components/schemas/ImportLensOutput" + /api/v1/agent-profiles/{profile_arn}/generations: + get: + operationId: ListAgentRecommendationGenerations + description: Lists recommendation generation processes for a specified profile. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile to list generation processes for. + - name: RecommendationType + in: query + required: false + schema: + $ref: "#/components/schemas/RecommendationType" + description: Optional filter by recommendation type. + - name: MaxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationGenerationsRequestMaxResultsInteger" + description: The maximum number of generation processes to return in a single response. + - name: NextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationGenerationsRequestNextTokenString" + description: A pagination token returned from a previous call to continue retrieving results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentRecommendationGenerationsResponse" + post: + operationId: StartAgentRecommendationGeneration + description: Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + types: + $ref: "#/components/schemas/RecommendationTypes" + name: + $ref: "#/components/schemas/StartAgentRecommendationGenerationRequestNameString" + additionalContext: + $ref: "#/components/schemas/Document" + scope: + $ref: "#/components/schemas/Scope" + required: + - types + - scope + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/StartAgentRecommendationGenerationResponse" + /api/v1/agent-recommendations/{recommendation_arn}/items: + get: + operationId: ListAgentRecommendationItems + description: Lists recommendation items for a specific recommendation. Recommendation items provide detailed information about individual optimization opportunities. + parameters: + - name: recommendation_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentRecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation to list items for. + - name: type + in: query + required: false + schema: + $ref: "#/components/schemas/RecommendationItemType" + description: Optional filter to return only recommendation items of the specified type. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationItemsRequestMaxResultsInteger" + description: The maximum number of recommendation items to return in a single response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationItemsRequestNextTokenString" + description: A pagination token returned from a previous call to continue retrieving results. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentRecommendationItemsResponse" + /api/v1/agent-profiles/{profile_arn}/recommendations: + get: + operationId: ListAgentRecommendations + description: Lists active optimization recommendations for a specified profile with optional filtering by state. + parameters: + - name: profile_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile to list recommendations for. + - name: maxResults + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationsRequestMaxResultsInteger" + description: The maximum number of recommendations to return in a single response. + - name: nextToken + in: query + required: false + schema: + $ref: "#/components/schemas/ListAgentRecommendationsRequestNextTokenString" + description: A pagination token returned from a previous call to continue retrieving results. + - name: state + in: query + required: false + schema: + $ref: "#/components/schemas/RecommendationState" + description: Optional filter to return only recommendations with the specified state (OPEN or CLOSED). + - name: pillar + in: query + required: false + schema: + $ref: "#/components/schemas/Pillar" + description: Optional filter to return only recommendations for the specified pillar. + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ListAgentRecommendationsResponse" /workloads/{workload_id}/lensReviews/{lens_alias}/answers: get: operationId: ListAnswers @@ -1527,7 +2162,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListAnswersMaxResults" + $ref: "#/components/schemas/ListAnswersInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: QuestionPriority in: query @@ -1562,7 +2197,7 @@ paths: NextToken: $ref: "#/components/schemas/NextToken" MaxResults: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListCheckDetailsInputMaxResultsInteger" LensArn: $ref: "#/components/schemas/LensArn" PillarId: @@ -1603,7 +2238,7 @@ paths: NextToken: $ref: "#/components/schemas/NextToken" MaxResults: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListCheckSummariesInputMaxResultsInteger" LensArn: $ref: "#/components/schemas/LensArn" PillarId: @@ -1658,7 +2293,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListLensReviewImprovementsMaxResults" + $ref: "#/components/schemas/ListLensReviewImprovementsInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: QuestionPriority in: query @@ -1697,7 +2332,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListLensReviewsInputMaxResultsInteger" responses: "200": description: Success @@ -1719,7 +2354,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListLensesInputMaxResultsInteger" - name: LensType in: query required: false @@ -1764,7 +2399,7 @@ paths: NextToken: $ref: "#/components/schemas/NextToken" MaxResults: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListMilestonesInputMaxResultsInteger" responses: "200": description: Success @@ -1789,7 +2424,7 @@ paths: NextToken: $ref: "#/components/schemas/NextToken" MaxResults: - $ref: "#/components/schemas/ListNotificationsMaxResults" + $ref: "#/components/schemas/ListNotificationsInputMaxResultsInteger" ResourceArn: $ref: "#/components/schemas/ResourceArn" responses: @@ -1799,7 +2434,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ListNotificationsOutput" - /profileNotifications/: + /profileNotifications: get: operationId: ListProfileNotifications description: List profile notifications. @@ -1818,7 +2453,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListProfileNotificationsInputMaxResultsInteger" responses: "200": description: Success @@ -1852,7 +2487,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/MaxResults" + $ref: "#/components/schemas/ListProfilesInputMaxResultsInteger" responses: "200": description: Success @@ -1890,7 +2525,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListReviewTemplateAnswersMaxResults" + $ref: "#/components/schemas/ListReviewTemplateAnswersInputMaxResultsInteger" description: The maximum number of results to return for this request. responses: "200": @@ -1930,7 +2565,7 @@ paths: in: query required: false schema: - $ref: "#/components/schemas/ListShareInvitationsMaxResults" + $ref: "#/components/schemas/ListShareInvitationsInputMaxResultsInteger" description: The maximum number of results to return for this request. - name: ProfileNamePrefix in: query @@ -2032,7 +2667,7 @@ paths: NextToken: $ref: "#/components/schemas/NextToken" MaxResults: - $ref: "#/components/schemas/ListWorkloadsMaxResults" + $ref: "#/components/schemas/ListWorkloadsInputMaxResultsInteger" responses: "200": description: Success @@ -2040,6 +2675,70 @@ paths: application/json: schema: $ref: "#/components/schemas/ListWorkloadsOutput" + /api/v1/agent-recommendations/{recommendation_arn}/feedback: + put: + operationId: PutAgentRecommendationFeedback + description: Submits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes. + parameters: + - name: recommendation_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentRecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation to provide feedback for. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + type: + $ref: "#/components/schemas/RecommendationFeedbackType" + feedbackCategory: + $ref: "#/components/schemas/FeedbackCategory" + comments: + $ref: "#/components/schemas/PutAgentRecommendationFeedbackRequestCommentsString" + required: + - type + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PutAgentRecommendationFeedbackResponse" + /api/v1/agent-recommendations/{recommendation_arn}/status: + patch: + operationId: UpdateAgentRecommendationStatus + description: Updates the status of a recommendation to track its progress through the implementation lifecycle. + parameters: + - name: recommendation_arn + in: path + required: true + schema: + $ref: "#/components/schemas/AgentRecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation to update. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + $ref: "#/components/schemas/RecommendationStatus" + updateReason: + $ref: "#/components/schemas/UpdateAgentRecommendationStatusRequestUpdateReasonString" + required: + - status + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateAgentRecommendationStatusResponse" /workloads/{workload_id}/updateIntegration: post: operationId: UpdateIntegration @@ -2252,119 +2951,619 @@ components: $ref: "#/components/schemas/ProfileArn" ProfileArn: type: string + minLength: 0 maxLength: 2084 pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+ - SharedWith: - description: The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. + AgentProfileArn: type: string - minLength: 12 + minLength: 0 maxLength: 2048 - ClientRequestToken: - description: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. + pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+) + CreateAgentContextRequestClientTokenString: type: string minLength: 1 - maxLength: 2048 - CreateLensShareOutput: - type: object - properties: - ShareId: - $ref: "#/components/schemas/ShareId" - ShareId: - description: The ID associated with the share. - type: string - pattern: "[0-9a-f]{32}" - LensVersion: + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + CreateAgentContextRequestTitleString: type: string minLength: 1 - maxLength: 32 - IsMajorVersion: - type: boolean - CreateLensVersionOutput: - type: object - properties: - LensArn: - $ref: "#/components/schemas/LensArn" - description: The ARN for the lens. - LensVersion: - $ref: "#/components/schemas/LensVersion" - description: The version of the lens. - LensArn: - type: string - MilestoneName: - description: The name of the milestone in a workload. Milestone names must be unique within a workload. + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + ContextType: type: string - minLength: 3 - maxLength: 100 - CreateMilestoneOutput: - description: Output of a create milestone call. + enum: + - APPLICATION + ContextContent: + description: Typed content structure for a context. Contains application-specific fields that describe the environment used during recommendation generation. type: object properties: - WorkloadId: - $ref: "#/components/schemas/WorkloadId" - MilestoneNumber: - $ref: "#/components/schemas/MilestoneNumber" - MilestoneNumber: - description: The milestone number. A workload can have a maximum of 100 milestones. - type: integer - minimum: 1 - maximum: 100 - ProfileName: + accountIds: + $ref: "#/components/schemas/ContextContentAccountIdsList" + description: The Amazon Web Services account IDs associated with this application context. + regions: + $ref: "#/components/schemas/ContextContentRegionsList" + description: The Amazon Web Services Regions where this application operates. + awsServices: + $ref: "#/components/schemas/ContextContentAwsServicesList" + description: The Amazon Web Services services used by this application. + resourceTypes: + $ref: "#/components/schemas/ContextContentResourceTypesList" + description: The Amazon Web Services resource types relevant to this application. + resourceTags: + $ref: "#/components/schemas/ContextContentResourceTagsList" + description: Resource tags used to scope this application context. + applicationOverview: + $ref: "#/components/schemas/ContextContentApplicationOverviewString" + description: A free-form overview of the application. + industry: + $ref: "#/components/schemas/ContextContentIndustryString" + description: The industry vertical for this application. + applicationType: + $ref: "#/components/schemas/ApplicationType" + description: The type of the application. + criticality: + $ref: "#/components/schemas/Criticality" + description: The business criticality of the application. + architectureOverview: + $ref: "#/components/schemas/ContextContentArchitectureOverviewString" + description: A free-form description of the application architecture. + additionalContext: + $ref: "#/components/schemas/ContextContentAdditionalContextString" + description: Additional context not captured by other fields. + ContextContentAccountIdsList: + type: array + items: + $ref: "#/components/schemas/ContextContentAccountIdsListMemberString" + ContextContentAccountIdsListMemberString: type: string - minLength: 3 - maxLength: 100 - ProfileDescription: + minLength: 12 + maxLength: 12 + pattern: \d{12} + ContextContentRegionsList: + type: array + items: + $ref: "#/components/schemas/ContextContentRegionsListMemberString" + ContextContentRegionsListMemberString: type: string - minLength: 3 - maxLength: 100 - ProfileQuestionUpdates: + minLength: 1 + maxLength: 64 + pattern: "[a-z]{2}(-gov)?-[a-z]+-\\d+" + ContextContentAwsServicesList: type: array items: - $ref: "#/components/schemas/ProfileQuestionUpdate" - ProfileQuestionUpdate: - description: An update to a profile question. - type: object - properties: - QuestionId: - $ref: "#/components/schemas/QuestionId" - SelectedChoiceIds: - $ref: "#/components/schemas/SelectedProfileChoiceIds" - description: The selected choices. - QuestionId: - description: The ID of the question. + $ref: "#/components/schemas/ContextContentAwsServicesListMemberString" + ContextContentAwsServicesListMemberString: type: string minLength: 1 - maxLength: 128 - SelectedProfileChoiceIds: + maxLength: 256 + pattern: "[\\P{C}]+" + ContextContentResourceTypesList: type: array items: - $ref: "#/components/schemas/ChoiceId" - ChoiceId: - description: The ID of a choice. + $ref: "#/components/schemas/ContextContentResourceTypesListMemberString" + ContextContentResourceTypesListMemberString: type: string minLength: 1 - maxLength: 64 - TagMap: - type: object - properties: {} - CreateProfileOutput: + maxLength: 256 + pattern: "[\\P{C}]+" + ContextContentResourceTagsList: + type: array + items: + $ref: "#/components/schemas/ContextResourceTag" + ContextResourceTag: + description: A key-value pair representing a resource tag used to scope context content. type: object properties: - ProfileArn: - $ref: "#/components/schemas/ProfileArn" - description: The profile ARN. - ProfileVersion: - $ref: "#/components/schemas/ProfileVersion" - description: Version of the profile. - ProfileVersion: + key: + $ref: "#/components/schemas/ContextResourceTagKeyString" + description: The tag key. + value: + $ref: "#/components/schemas/ContextResourceTagValueString" + description: The tag value. + required: + - key + - value + ContextResourceTagKeyString: type: string minLength: 1 - maxLength: 32 - pattern: ^[A-Za-z0-9-]+$ - CreateProfileShareOutput: - type: object - properties: - ShareId: - $ref: "#/components/schemas/ShareId" + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + ContextResourceTagValueString: + type: string + minLength: 0 + maxLength: 256 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + ContextContentApplicationOverviewString: + type: string + minLength: 0 + maxLength: 10000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])* + ContextContentIndustryString: + type: string + minLength: 0 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])* + ApplicationType: + type: string + enum: + - SAS + - DESKTOP_APPLICATION + - OTHER + Criticality: + type: string + enum: + - MISSION_CRITICAL + - BUSINESS_CRITICAL + - NON_CRITICAL + - TEST_DEVELOPMENT + ContextContentArchitectureOverviewString: + type: string + minLength: 0 + maxLength: 10000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])* + ContextContentAdditionalContextString: + type: string + minLength: 0 + maxLength: 10000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])* + CreateAgentContextResponse: + type: object + properties: + context: + $ref: "#/components/schemas/ContextSummary" + description: The created context summary. + required: + - context + ContextSummary: + description: Summary of a context associated with a profile, representing application or environment information used during recommendation generation. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the context. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the associated profile. + title_: + $ref: "#/components/schemas/ContextSummaryTitleString" + description: The title of the context. + contextType: + $ref: "#/components/schemas/ContextType" + description: The type of the context. + content: + $ref: "#/components/schemas/ContextContent" + description: The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types. + applicationType: + $ref: "#/components/schemas/ApplicationType" + description: The type of application described by this context. + criticality: + $ref: "#/components/schemas/Criticality" + description: The business criticality of the application described by this context. + createdBy: + $ref: "#/components/schemas/ContextSummaryCreatedByString" + description: The identifier of the user or system that created this context. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the context was created. + lastModifiedBy: + $ref: "#/components/schemas/ContextSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this context. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the context was last modified. + required: + - id + - profileArn + - title_ + - contextType + - content + - createdBy + - createdAt + UUID: + type: string + pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + ContextSummaryTitleString: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + ContextSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + SyntheticTimestamp_date_time: + type: string + format: date-time + ContextSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + CreateAgentGoalRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + Pillars: + type: array + items: + $ref: "#/components/schemas/Pillar" + Pillar: + type: string + enum: + - COST_OPTIMIZATION + - SECURITY + - RESILIENCE + - PERFORMANCE + - OPERATIONAL_EXCELLENCE + CreateAgentGoalRequestTitleString: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + CreateAgentGoalRequestDescriptionString: + type: string + minLength: 1 + maxLength: 4000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + CreateAgentGoalResponse: + type: object + properties: + goal: + $ref: "#/components/schemas/GoalSummary" + description: The created goal summary. + required: + - goal + GoalSummary: + description: Summary of an optimization goal associated with a profile. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the goal. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the associated profile. + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars associated with this goal. + title_: + $ref: "#/components/schemas/GoalSummaryTitleString" + description: The title of the goal. + description: + $ref: "#/components/schemas/GoalSummaryDescriptionString" + description: A description of the goal. + createdBy: + $ref: "#/components/schemas/GoalSummaryCreatedByString" + description: The identifier of the user or system that created this goal. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the goal was created. + lastModifiedBy: + $ref: "#/components/schemas/GoalSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this goal. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the goal was last modified. + required: + - id + - profileArn + - pillars + - title_ + - createdBy + - createdAt + GoalSummaryTitleString: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + GoalSummaryDescriptionString: + type: string + minLength: 1 + maxLength: 4000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + GoalSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + GoalSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + CreateAgentProfileRequestNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + CreateAgentProfileRequestDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + CreateAgentProfileRequestDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + CreateAgentProfileRequestBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + Boolean: + type: boolean + RoleArn: + type: string + minLength: 0 + maxLength: 2048 + pattern: arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+ + AggregationConfigurations: + type: array + items: + $ref: "#/components/schemas/AggregationConfiguration" + AggregationConfiguration: + description: Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations. + type: object + properties: + accountId: + $ref: "#/components/schemas/AccountId" + description: The Amazon Web Services account ID to analyze. + regions: + $ref: "#/components/schemas/Regions" + description: A list of Amazon Web Services Regions to include in the analysis. + accessRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of an IAM role to assume for resource analysis in this account. + required: + - accountId + - regions + - accessRoleArn + AccountId: + type: string + pattern: \d{12} + Regions: + type: array + items: + $ref: "#/components/schemas/Region" + Region: + type: string + minLength: 0 + maxLength: 64 + pattern: "[a-z]{2}-[a-z]+-\\d{1}" + CreateAgentProfileRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + Tags: + type: array + items: + $ref: "#/components/schemas/Tag" + Tag: + description: A key-value pair associated with a resource for cost allocation and access control. + type: object + properties: + key: + $ref: "#/components/schemas/TagKeyString" + description: The key of the tag. + value: + $ref: "#/components/schemas/TagValueString" + description: The value of the tag. + required: + - key + - value + TagKeyString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" + TagValueString: + type: string + minLength: 1 + maxLength: 256 + pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" + CreateAgentProfileResponse: + type: object + properties: + name: + $ref: "#/components/schemas/CreateAgentProfileResponseNameString" + description: The system name of the created profile. + displayName: + $ref: "#/components/schemas/CreateAgentProfileResponseDisplayNameString" + description: The display name of the created profile. + description: + $ref: "#/components/schemas/CreateAgentProfileResponseDescriptionString" + description: A description of the created profile. + businessOverview: + $ref: "#/components/schemas/CreateAgentProfileResponseBusinessOverviewString" + description: The business overview of the created profile. + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars associated with the created profile. + deletionProtection: + $ref: "#/components/schemas/Boolean" + description: Indicates whether deletion protection is enabled. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role. + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + description: The aggregation configuration. + arn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the created profile. + eligibleForScheduledGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for scheduled recommendation generation. + eligibleForArchitectureGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for manual architecture generation. + fieldErrors: + type: object + properties: {} + description: A map of field paths to error messages for invalid or missing input fields. + tags: + $ref: "#/components/schemas/Tags" + description: The tags associated with the created profile. + createdBy: + $ref: "#/components/schemas/CreateAgentProfileResponseCreatedByString" + description: The identifier of the user or system that created this profile. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was created. + lastModifiedBy: + $ref: "#/components/schemas/CreateAgentProfileResponseLastModifiedByString" + description: The identifier of the user or system that last modified this profile. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was last modified. + required: + - name + - pillars + - executionRoleArn + - aggregationConfiguration + - arn + - createdBy + - createdAt + CreateAgentProfileResponseNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + CreateAgentProfileResponseDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + CreateAgentProfileResponseDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + CreateAgentProfileResponseBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + CreateAgentProfileResponseCreatedByString: + type: string + minLength: 1 + maxLength: 128 + CreateAgentProfileResponseLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + SharedWith: + description: The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. + type: string + minLength: 12 + maxLength: 2048 + ClientRequestToken: + description: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. + type: string + minLength: 1 + maxLength: 2048 + pattern: "[\\x00-\\x7F]*" + CreateLensShareOutput: + type: object + properties: + ShareId: + $ref: "#/components/schemas/ShareId" + ShareId: + description: The ID associated with the share. + type: string + pattern: "[0-9a-f]{32}" + LensVersion: + type: string + minLength: 1 + maxLength: 32 + IsMajorVersion: + type: boolean + CreateLensVersionOutput: + type: object + properties: + LensArn: + $ref: "#/components/schemas/LensArn" + description: The ARN for the lens. + LensVersion: + $ref: "#/components/schemas/LensVersion" + description: The version of the lens. + LensArn: + type: string + MilestoneName: + description: The name of the milestone in a workload. Milestone names must be unique within a workload. + type: string + minLength: 3 + maxLength: 100 + CreateMilestoneOutput: + description: Output of a create milestone call. + type: object + properties: + WorkloadId: + $ref: "#/components/schemas/WorkloadId" + MilestoneNumber: + $ref: "#/components/schemas/MilestoneNumber" + MilestoneNumber: + description: The milestone number. A workload can have a maximum of 100 milestones. + type: integer + minimum: 1 + maximum: 100 + ProfileName: + type: string + minLength: 3 + maxLength: 100 + ProfileDescription: + type: string + minLength: 3 + maxLength: 100 + ProfileQuestionUpdates: + type: array + items: + $ref: "#/components/schemas/ProfileQuestionUpdate" + ProfileQuestionUpdate: + description: An update to a profile question. + type: object + properties: + QuestionId: + $ref: "#/components/schemas/QuestionId" + SelectedChoiceIds: + $ref: "#/components/schemas/SelectedProfileChoiceIds" + description: The selected choices. + QuestionId: + description: The ID of the question. + type: string + minLength: 1 + maxLength: 128 + SelectedProfileChoiceIds: + type: array + items: + $ref: "#/components/schemas/ChoiceId" + ChoiceId: + description: The ID of a choice. + type: string + minLength: 1 + maxLength: 64 + TagMap: + type: object + properties: {} + CreateProfileOutput: + type: object + properties: + ProfileArn: + $ref: "#/components/schemas/ProfileArn" + description: The profile ARN. + ProfileVersion: + $ref: "#/components/schemas/ProfileVersion" + description: Version of the profile. + ProfileVersion: + type: string + minLength: 1 + maxLength: 32 + pattern: "[A-Za-z0-9-]+" + CreateProfileShareOutput: + type: object + properties: + ShareId: + $ref: "#/components/schemas/ShareId" ProfileArn: $ref: "#/components/schemas/ProfileArn" description: The profile ARN. @@ -2372,12 +3571,12 @@ components: type: string minLength: 3 maxLength: 100 - pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ + pattern: "[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+" TemplateDescription: type: string minLength: 3 maxLength: 250 - pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ + pattern: "[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+" ReviewTemplateLenses: type: array items: @@ -2385,6 +3584,7 @@ components: Notes: description: The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. type: string + minLength: 0 maxLength: 2084 CreateReviewTemplateOutput: type: object @@ -2440,6 +3640,7 @@ components: AwsRegion: description: An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1. type: string + minLength: 0 maxLength: 100 WorkloadNonAwsRegions: description: The list of non-Amazon Web Services Regions associated with the workload. @@ -2463,8 +3664,9 @@ components: WorkloadArchitecturalDesign: description: The URL of the architectural design for the workload. type: string + minLength: 0 maxLength: 2048 - pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$ + pattern: (|(https?|ftp):\/\/[^\s/$.?#].[^\s]*) WorkloadReviewOwner: description: The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process. type: string @@ -2473,10 +3675,12 @@ components: WorkloadIndustryType: description: "The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Education Environmental Protection Financial Services Gaming General Public Services Healthcare Hospitality InfoTech Justice and Public Safety Life Sciences Manufacturing Media & Entertainment Mining & Resources Oil & Gas Power & Utilities Professional Services Real Estate & Construction Retail & Wholesale Social Protection Telecommunications Travel, Transportation & Logistics Other" type: string + minLength: 0 maxLength: 100 WorkloadIndustry: description: The industry for the workload. type: string + minLength: 0 maxLength: 100 WorkloadLenses: description: The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. @@ -2513,6 +3717,7 @@ components: $ref: "#/components/schemas/ApplicationArn" ApplicationArn: type: string + minLength: 0 maxLength: 2084 pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+ WorkloadProfileArns: @@ -2527,72 +3732,822 @@ components: description: "Workload-level: Input for the Jira configuration." type: object properties: - IssueManagementStatus: - $ref: "#/components/schemas/WorkloadIssueManagementStatus" - description: "Workload-level: Jira issue management status." - IssueManagementType: - $ref: "#/components/schemas/IssueManagementType" - description: "Workload-level: Jira issue management type." - JiraProjectKey: - $ref: "#/components/schemas/JiraProjectKey" - description: "Workload-level: Jira project key to sync workloads to." - WorkloadIssueManagementStatus: + IssueManagementStatus: + $ref: "#/components/schemas/WorkloadIssueManagementStatus" + description: "Workload-level: Jira issue management status." + IssueManagementType: + $ref: "#/components/schemas/IssueManagementType" + description: "Workload-level: Jira issue management type." + JiraProjectKey: + $ref: "#/components/schemas/JiraProjectKey" + description: "Workload-level: Jira project key to sync workloads to." + WorkloadIssueManagementStatus: + type: string + enum: + - ENABLED + - DISABLED + - INHERIT + IssueManagementType: + type: string + enum: + - AUTO + - MANUAL + JiraProjectKey: + type: string + minLength: 1 + maxLength: 100 + pattern: "[A-Z][A-Z0-9_]*" + CreateWorkloadOutput: + description: Output of a create workload call. + type: object + properties: + WorkloadId: + $ref: "#/components/schemas/WorkloadId" + WorkloadArn: + $ref: "#/components/schemas/WorkloadArn" + WorkloadArn: + description: The ARN for the workload. + type: string + PermissionType: + description: Permission granted on a share request. + type: string + enum: + - READONLY + - CONTRIBUTOR + CreateWorkloadShareOutput: + description: Input for Create Workload Share + type: object + properties: + WorkloadId: + $ref: "#/components/schemas/WorkloadId" + ShareId: + $ref: "#/components/schemas/ShareId" + DeleteAgentContextResponse: + type: object + DeleteAgentGoalResponse: + type: object + DeleteAgentProfileResponse: + type: object + LensStatusType: + type: string + enum: + - ALL + - DRAFT + - PUBLISHED + ExportLensOutput: + type: object + properties: + LensJSON: + $ref: "#/components/schemas/LensJSON" + description: The JSON representation of a lens. + LensJSON: + type: string + minLength: 2 + maxLength: 500000 + GetAgentContextResponse: + type: object + properties: + context: + $ref: "#/components/schemas/ContextSummary" + description: The retrieved context summary. + required: + - context + GetAgentGoalResponse: + type: object + properties: + goal: + $ref: "#/components/schemas/GoalSummary" + description: The retrieved goal summary. + required: + - goal + GetAgentProfileResponse: + type: object + properties: + name: + $ref: "#/components/schemas/GetAgentProfileResponseNameString" + description: The system name of the profile. + displayName: + $ref: "#/components/schemas/GetAgentProfileResponseDisplayNameString" + description: The display name of the profile. + description: + $ref: "#/components/schemas/GetAgentProfileResponseDescriptionString" + description: A description of the profile. + businessOverview: + $ref: "#/components/schemas/GetAgentProfileResponseBusinessOverviewString" + description: The business overview of the profile. + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars associated with the profile. + deletionProtection: + $ref: "#/components/schemas/Boolean" + description: Indicates whether deletion protection is enabled. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role. + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + description: The aggregation configuration. + arn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile. + eligibleForScheduledGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for scheduled recommendation generation. + eligibleForArchitectureGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for manual architecture generation. + fieldErrors: + type: object + properties: {} + description: A map of field paths to error messages for invalid or missing input fields. + tags: + $ref: "#/components/schemas/Tags" + description: The tags associated with the profile. + createdBy: + $ref: "#/components/schemas/GetAgentProfileResponseCreatedByString" + description: The identifier of the user or system that created this profile. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was created. + lastModifiedBy: + $ref: "#/components/schemas/GetAgentProfileResponseLastModifiedByString" + description: The identifier of the user or system that last modified this profile. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was last modified. + required: + - name + - pillars + - executionRoleArn + - aggregationConfiguration + - arn + - createdBy + - createdAt + GetAgentProfileResponseNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + GetAgentProfileResponseDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + GetAgentProfileResponseDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + GetAgentProfileResponseBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + GetAgentProfileResponseCreatedByString: + type: string + minLength: 1 + maxLength: 128 + GetAgentProfileResponseLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationArn: + type: string + minLength: 0 + maxLength: 2048 + pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} + RemediationType: + type: string + enum: + - AUTO_REMEDIATION + - CONSOLE + - CLI + - SDK + - IAC + - MCP + GetAgentRecommendationResponse: + type: object + properties: + recommendationArn: + $ref: "#/components/schemas/RecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the associated profile. + title_: + $ref: "#/components/schemas/GetAgentRecommendationResponseTitleString" + description: The title of the recommendation. + description: + $ref: "#/components/schemas/GetAgentRecommendationResponseDescriptionString" + description: A description of the recommendation. + type_: + $ref: "#/components/schemas/RecommendationType" + description: The type of the recommendation. + pillar: + $ref: "#/components/schemas/Pillar" + description: The Well-Architected Tool Framework pillar that the recommendation addresses. + priority: + $ref: "#/components/schemas/Priority" + description: The priority of the recommendation. + effort: + $ref: "#/components/schemas/Effort" + description: The effort required to implement the recommendation. + status: + $ref: "#/components/schemas/RecommendationStatus" + description: The current status of the recommendation. + state: + $ref: "#/components/schemas/RecommendationState" + description: The current state of the recommendation. + updateReason: + $ref: "#/components/schemas/GetAgentRecommendationResponseUpdateReasonString" + description: The free-text reason associated with the recommendation's most recent status update. + impact: + $ref: "#/components/schemas/ImpactCategory" + description: The severity of the recommendation's impact. + roi: + $ref: "#/components/schemas/Roi" + description: The return on investment estimate for the recommendation. + numberOfResources: + $ref: "#/components/schemas/Integer" + description: The number of Amazon Web Services resources this recommendation affects. + awsServices: + $ref: "#/components/schemas/StringList" + description: The Amazon Web Services services that the recommendation applies to. + businessUnits: + $ref: "#/components/schemas/StringList" + description: The business units that own the affected resources. + applications: + $ref: "#/components/schemas/StringList" + description: The applications that the recommendation targets. + impactDetails: + $ref: "#/components/schemas/ImpactDetails" + description: Detailed impact information for the recommendation. + insights: + $ref: "#/components/schemas/InsightList" + description: A list of insights about the recommendation. + highlights: + $ref: "#/components/schemas/Highlights" + description: Highlights describing what was detected. + remediationSummary: + $ref: "#/components/schemas/RemediationSummary" + description: A high-level summary of the recommended remediation. + crossPillarBenefits: + $ref: "#/components/schemas/CrossPillarBenefits" + description: Cross-pillar benefits of acting on the recommendation. + tradeOffs: + $ref: "#/components/schemas/TradeOffs" + description: Trade-offs of acting on the recommendation. + sources: + $ref: "#/components/schemas/RecommendationSourceList" + description: Sources that generated this recommendation. + goals: + $ref: "#/components/schemas/RecommendationGoals" + description: Goals that this recommendation targets. + tags: + $ref: "#/components/schemas/Tags" + description: A set of key-value pairs associated with the recommendation, used for cost allocation and access control. + createdBy: + $ref: "#/components/schemas/GetAgentRecommendationResponseCreatedByString" + description: The identifier of the user or system that created this recommendation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation was created. + lastModifiedBy: + $ref: "#/components/schemas/GetAgentRecommendationResponseLastModifiedByString" + description: The identifier of the user or system that last modified this recommendation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation was last modified. + remediations: + $ref: "#/components/schemas/AgentRecommendationRemediations" + description: A list of remediations for the recommendation. + required: + - recommendationArn + - profileArn + - title_ + - description + - type_ + - pillar + - priority + - effort + - status + - state + - impact + - roi + - impactDetails + - insights + - highlights + - remediationSummary + - createdBy + - createdAt + RecommendationArn: + type: string + minLength: 0 + maxLength: 2048 + pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} + GetAgentRecommendationResponseTitleString: + type: string + minLength: 3 + maxLength: 120 + GetAgentRecommendationResponseDescriptionString: + type: string + minLength: 80 + maxLength: 500 + RecommendationType: + type: string + enum: + - RESOURCE + - ARCHITECTURE + - APPLICATION + Priority: + type: string + enum: + - HIGH + - MEDIUM + - LOW + Effort: + type: string + enum: + - LARGE + - MEDIUM + - SMALL + RecommendationStatus: + type: string + enum: + - ACTIVE + - SUPPRESSED + - COMPLETED + RecommendationState: + type: string + enum: + - OPEN + - CLOSED + GetAgentRecommendationResponseUpdateReasonString: + type: string + minLength: 1 + maxLength: 4096 + ImpactCategory: + type: string + enum: + - HIGH + - MEDIUM + - LOW + Roi: + description: A return-on-investment estimate with context. + type: object + properties: + estimate: + $ref: "#/components/schemas/RoiEstimateString" + description: A short statistic or key metric. Optional when there is no quantifiable figure. + detail: + $ref: "#/components/schemas/RoiDetailString" + description: A sentence providing context for the estimate. + required: + - detail + RoiEstimateString: + type: string + minLength: 2 + maxLength: 40 + RoiDetailString: + type: string + minLength: 30 + maxLength: 300 + Integer: + type: integer + StringList: + type: array + items: + $ref: "#/components/schemas/String" + String: + type: string + ImpactDetails: + type: array + items: + $ref: "#/components/schemas/ImpactDetail" + ImpactDetail: + type: string + minLength: 10 + maxLength: 100 + InsightList: + type: array + items: + $ref: "#/components/schemas/Insight" + Insight: + description: An insight describing a usage pattern and the signals detected. + type: object + properties: + usagePattern: + $ref: "#/components/schemas/InsightUsagePatternString" + description: A description of the usage pattern. + signalsDetected: + $ref: "#/components/schemas/InsightSignalsDetectedString" + description: A description of the signals detected. + required: + - usagePattern + InsightUsagePatternString: + type: string + minLength: 100 + maxLength: 2000 + InsightSignalsDetectedString: + type: string + minLength: 30 + maxLength: 1500 + Highlights: + type: array + items: + $ref: "#/components/schemas/Highlight" + Highlight: + type: string + minLength: 20 + maxLength: 250 + RemediationSummary: + description: A high-level remediation summary returned in the detail response. + type: object + properties: + recommendation: + $ref: "#/components/schemas/RemediationSummaryRecommendationString" + description: A short imperative statement of the recommended action. + steps: + $ref: "#/components/schemas/RecommendedFixSteps" + description: High-level steps to implement the fix. + required: + - recommendation + - steps + RemediationSummaryRecommendationString: + type: string + minLength: 80 + maxLength: 240 + RecommendedFixSteps: + type: array + items: + $ref: "#/components/schemas/RecommendedFixStep" + RecommendedFixStep: + type: string + minLength: 20 + maxLength: 200 + CrossPillarBenefits: + type: array + items: + $ref: "#/components/schemas/CrossPillarBenefit" + CrossPillarBenefit: + description: A benefit on a different pillar from acting on the recommendation. + type: object + properties: + pillar: + $ref: "#/components/schemas/Pillar" + description: The pillar that would be positively impacted. + title_: + $ref: "#/components/schemas/CrossPillarBenefitTitleString" + description: A short phrase describing the outcome. + description: + $ref: "#/components/schemas/CrossPillarBenefitDescriptionString" + description: A description of what changes and why it matters. + impact: + $ref: "#/components/schemas/ImpactCategory" + description: The severity of the benefit. + required: + - pillar + - title_ + - description + - impact + CrossPillarBenefitTitleString: + type: string + minLength: 3 + maxLength: 80 + CrossPillarBenefitDescriptionString: + type: string + minLength: 30 + maxLength: 300 + TradeOffs: + type: array + items: + $ref: "#/components/schemas/TradeOff" + TradeOff: + description: A negative trade-off from acting on the recommendation. + type: object + properties: + pillar: + $ref: "#/components/schemas/Pillar" + description: The pillar that could be negatively impacted. + title_: + $ref: "#/components/schemas/TradeOffTitleString" + description: A short phrase describing what is lost or degraded. + description: + $ref: "#/components/schemas/TradeOffDescriptionString" + description: A description of the specific risk and the condition that triggers it. + risk: + $ref: "#/components/schemas/RiskRating" + description: The risk rating for the trade-off. + mitigation: + $ref: "#/components/schemas/TradeOffMitigationString" + description: A specific action to mitigate the trade-off and when to take it. + riskExplanation: + $ref: "#/components/schemas/TradeOffRiskExplanationString" + description: An optional explanation providing additional context for the risk rating. + required: + - pillar + - title_ + - description + - risk + - mitigation + TradeOffTitleString: + type: string + minLength: 3 + maxLength: 80 + TradeOffDescriptionString: + type: string + minLength: 30 + maxLength: 450 + RiskRating: + type: string + enum: + - LOW + - MEDIUM + - HIGH + TradeOffMitigationString: + type: string + minLength: 30 + maxLength: 450 + TradeOffRiskExplanationString: + type: string + minLength: 1 + maxLength: 160 + RecommendationSourceList: + type: array + items: + $ref: "#/components/schemas/RecommendationSource" + RecommendationSource: + type: string + enum: + - TRUSTED_ADVISOR + - COST_EXPLORER + - CLOUDWATCH + - WELL_ARCHITECTED_TOOL + - WELL_ARCHITECTED_AGENT + - CUSTOMER_IAC + RecommendationGoals: + type: array + items: + $ref: "#/components/schemas/RecommendationGoal" + RecommendationGoal: + description: Contains information about a goal associated with a recommendation. + type: object + properties: + title_: + $ref: "#/components/schemas/String" + description: The title of the goal associated with the recommendation. + required: + - title_ + GetAgentRecommendationResponseCreatedByString: + type: string + minLength: 1 + maxLength: 128 + GetAgentRecommendationResponseLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationRemediations: + type: array + items: + $ref: "#/components/schemas/AgentRecommendationRemediation" + AgentRecommendationRemediation: + description: The core fields for a remediation. + type: object + properties: + recommendationArn: + $ref: "#/components/schemas/RecommendationArn" + description: The ARN of the recommendation that this remediation belongs to. + type_: + $ref: "#/components/schemas/RemediationType" + description: The remediation method. + steps: + $ref: "#/components/schemas/RemediationSteps" + description: The procedural steps to perform the remediation. + resourceLinks: + $ref: "#/components/schemas/ResourceLinks" + description: External references associated with the steps. + createdBy: + $ref: "#/components/schemas/AgentRecommendationRemediationCreatedByString" + description: The identifier of the user or system that created this remediation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the remediation was created. + lastModifiedBy: + $ref: "#/components/schemas/AgentRecommendationRemediationLastModifiedByString" + description: The identifier of the user or system that last modified this remediation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the remediation was last modified. + required: + - recommendationArn + - type_ + - steps + - createdBy + - createdAt + RemediationSteps: + type: array + items: + $ref: "#/components/schemas/RemediationStep" + RemediationStep: + description: One step within a remediation procedure. + type: object + properties: + title_: + $ref: "#/components/schemas/RemediationStepTitleString" + description: An optional short label for the step. + content: + $ref: "#/components/schemas/RemediationStepContentString" + description: The content describing the step, which can include code examples and verification checklists. + required: + - content + RemediationStepTitleString: + type: string + minLength: 3 + maxLength: 80 + RemediationStepContentString: + type: string + minLength: 80 + maxLength: 8000 + ResourceLinks: + type: array + items: + $ref: "#/components/schemas/ResourceLink" + ResourceLink: + description: An external reference associated with remediation steps. + type: object + properties: + url: + $ref: "#/components/schemas/ResourceLinkUrlString" + description: The URL of the external reference. + title_: + $ref: "#/components/schemas/ResourceLinkTitleString" + description: An optional human-readable title for the link. + required: + - url + ResourceLinkUrlString: + type: string + minLength: 10 + maxLength: 500 + ResourceLinkTitleString: + type: string + minLength: 3 + maxLength: 100 + AgentRecommendationRemediationCreatedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationRemediationLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + GetAgentRecommendationGenerationResponse: + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the recommendation generation. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile used for this generation. + name: + $ref: "#/components/schemas/String" + description: The name of the recommendation generation. + status: + $ref: "#/components/schemas/GenerationStatus" + description: The current status of the recommendation generation. + estimatedCompletionTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The estimated time for the generation to complete. + createdBy: + $ref: "#/components/schemas/GetAgentRecommendationGenerationResponseCreatedByString" + description: The identifier of the user or system that started this generation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was started. + lastModifiedBy: + $ref: "#/components/schemas/GetAgentRecommendationGenerationResponseLastModifiedByString" + description: The identifier of the user or system that last modified this generation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was last modified. + additionalContext: + $ref: "#/components/schemas/Document" + description: Additional context information provided to guide the recommendation generation process. + scope: + $ref: "#/components/schemas/Scope" + description: The scope configuration that defines which pillars and goals to focus on during generation. + startedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation generation process started. + endedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation generation process completed. + progress: + $ref: "#/components/schemas/Progress" + description: Current progress information including steps completed and completion percentage. + errorDetails: + $ref: "#/components/schemas/ErrorDetails" + description: Details about the error if the generation status is ERROR. + required: + - id + - profileArn + - status + - createdBy + - createdAt + GenerationStatus: type: string enum: - - ENABLED - - DISABLED - - INHERIT - IssueManagementType: + - QUEUED + - IN_PROGRESS + - COMPLETED + - ERROR + GetAgentRecommendationGenerationResponseCreatedByString: type: string - enum: - - AUTO - - MANUAL - JiraProjectKey: + minLength: 1 + maxLength: 128 + GetAgentRecommendationGenerationResponseLastModifiedByString: type: string minLength: 1 - maxLength: 100 - pattern: ^[A-Z][A-Z0-9_]*$ - CreateWorkloadOutput: - description: Output of a create workload call. + maxLength: 128 + Document: + type: object + Scope: + description: Defines the scope for recommendation generation, specifying which pillars and goals to focus on. type: object properties: - WorkloadId: - $ref: "#/components/schemas/WorkloadId" - WorkloadArn: - $ref: "#/components/schemas/WorkloadArn" - WorkloadArn: - description: The ARN for the workload. - type: string - PermissionType: - description: Permission granted on a share request. - type: string - enum: - - READONLY - - CONTRIBUTOR - CreateWorkloadShareOutput: - description: Input for Create Workload Share + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars to include in the generation scope. + goalIds: + $ref: "#/components/schemas/GoalIdList" + description: Specific goal IDs to focus on during recommendation generation. + items_: + $ref: "#/components/schemas/PillarItems" + description: Optional per-pillar item filtering configuration. + required: + - pillars + GoalIdList: + type: array + items: + $ref: "#/components/schemas/UUID" + PillarItems: + type: array + items: + $ref: "#/components/schemas/PillarItem" + PillarItem: + description: Item configuration for a specific Well-Architected Tool Framework pillar. type: object properties: - WorkloadId: - $ref: "#/components/schemas/WorkloadId" - ShareId: - $ref: "#/components/schemas/ShareId" - LensStatusType: + pillar: + $ref: "#/components/schemas/Pillar" + description: The pillar this item configuration applies to. + ids: + $ref: "#/components/schemas/ItemIds" + description: A list of item IDs to process for this pillar, such as best practice IDs, Amazon Web Services service names, or resource ARNs. + required: + - pillar + - ids + ItemIds: + type: array + items: + $ref: "#/components/schemas/ItemId" + ItemId: type: string - enum: - - ALL - - DRAFT - - PUBLISHED - ExportLensOutput: + minLength: 1 + maxLength: 2048 + Progress: + description: Progress information for a recommendation generation process. type: object properties: - LensJSON: - $ref: "#/components/schemas/LensJSON" - description: The JSON representation of a lens. - LensJSON: - type: string - minLength: 2 - maxLength: 500000 + stepsCompleted: + $ref: "#/components/schemas/Integer" + description: The number of generation steps that have been completed. + totalSteps: + $ref: "#/components/schemas/Integer" + description: The total number of steps in the generation process. + completionPercentage: + $ref: "#/components/schemas/Double" + description: The completion percentage of the generation process (0-100). + required: + - stepsCompleted + - totalSteps + - completionPercentage + Double: + type: number + format: double + ErrorDetails: + description: Details about an error that occurred during recommendation generation. + type: object + properties: + code: + $ref: "#/components/schemas/String" + description: The status code identifying the type of error. + message: + $ref: "#/components/schemas/String" + description: A human-readable description of the error. + required: + - code + - message GetAnswerOutput: description: Output of a get answer call. type: object @@ -2657,7 +4612,7 @@ components: minLength: 1 maxLength: 1024 ImprovementPlanUrl: - description: The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. + description: The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. type: string minLength: 1 maxLength: 2048 @@ -2785,6 +4740,7 @@ components: - NONE ChoiceNotes: type: string + minLength: 0 maxLength: 250 IsApplicable: description: Defines whether this question is applicable to a lens review. @@ -2815,12 +4771,12 @@ components: description: The URL of the associated Jira issue. LastSyncedTime: $ref: "#/components/schemas/Timestamp" + description: The date and time when the Jira configuration was last synced. JiraIssueUrl: type: string minLength: 1 maxLength: 2048 Timestamp: - description: The date and time recorded. type: string format: date-time ReportFormat: @@ -2833,7 +4789,9 @@ components: NextToken: description: The token to use to retrieve the next set of results. type: string - GetConsolidatedReportMaxResults: + pattern: "[A-Za-z0-9+\\/=_-]+" + GetConsolidatedReportInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 15 @@ -2869,6 +4827,7 @@ components: $ref: "#/components/schemas/WorkloadArn" UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the consolidated report metric was last updated. Lenses: $ref: "#/components/schemas/LensMetrics" description: The metrics for the lenses in the workload. @@ -3086,6 +5045,7 @@ components: description: Jira configuration status of the Lens review. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the lens review was last updated. Notes: $ref: "#/components/schemas/Notes" RiskCounts: @@ -3277,6 +5237,7 @@ components: $ref: "#/components/schemas/MilestoneName" RecordedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the milestone was recorded. Workload: $ref: "#/components/schemas/Workload" Workload: @@ -3295,6 +5256,7 @@ components: $ref: "#/components/schemas/WorkloadEnvironment" UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the workload was last updated. AccountIds: $ref: "#/components/schemas/WorkloadAccountIds" AwsRegions: @@ -3307,6 +5269,7 @@ components: $ref: "#/components/schemas/WorkloadReviewOwner" ReviewRestrictionDate: $ref: "#/components/schemas/Timestamp" + description: The review restriction date for the workload. IsReviewOwnerUpdateAcknowledged: $ref: "#/components/schemas/IsReviewOwnerUpdateAcknowledged" description: Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. @@ -3405,8 +5368,10 @@ components: $ref: "#/components/schemas/AwsAccountId" CreatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the profile was created. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the profile was last updated. ShareInvitationId: $ref: "#/components/schemas/ShareInvitationId" description: The ID assigned to the share invitation. @@ -3482,8 +5447,10 @@ components: description: Profile template questions. CreatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the profile template was created. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the profile template was last updated. TemplateQuestions: type: array items: @@ -3547,6 +5514,7 @@ components: $ref: "#/components/schemas/AwsAccountId" UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the review template was last updated. TemplateArn: $ref: "#/components/schemas/TemplateArn" description: The review template ARN. @@ -3651,6 +5619,7 @@ components: description: Pillar review summaries of a lens review. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the review template lens review was last updated. Notes: $ref: "#/components/schemas/Notes" QuestionCounts: @@ -3698,7 +5667,474 @@ components: - IN_PROGRESS - COMPLETE - ERROR - ListAnswersMaxResults: + ListAgentContextsRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentContextsRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentContextsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/ContextSummaries" + description: A list of context summaries associated with the profile. + nextToken: + $ref: "#/components/schemas/ListAgentContextsResponseNextTokenString" + required: + - items_ + ContextSummaries: + type: array + items: + $ref: "#/components/schemas/ContextSummary" + ListAgentContextsResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentGoalsRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentGoalsRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentGoalsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/GoalSummaries" + description: A list of goal summaries associated with the profile. + nextToken: + $ref: "#/components/schemas/ListAgentGoalsResponseNextTokenString" + description: A pagination token to retrieve the next set of results, if available. + required: + - items_ + GoalSummaries: + type: array + items: + $ref: "#/components/schemas/GoalSummary" + ListAgentGoalsResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentProfilesRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentProfilesRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentProfilesResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/AgentProfileSummaries" + description: A list of profile summaries. + nextToken: + $ref: "#/components/schemas/ListAgentProfilesResponseNextTokenString" + description: A pagination token to retrieve the next set of results, if available. + required: + - items_ + AgentProfileSummaries: + type: array + items: + $ref: "#/components/schemas/AgentProfileSummary" + AgentProfileSummary: + description: Summary of an optimization profile, including its configuration, metadata, and audit information. + type: object + properties: + name: + $ref: "#/components/schemas/AgentProfileSummaryNameString" + description: The system name of the profile. + displayName: + $ref: "#/components/schemas/AgentProfileSummaryDisplayNameString" + description: The display name of the profile shown to users. + description: + $ref: "#/components/schemas/AgentProfileSummaryDescriptionString" + description: A description of the profile. + businessOverview: + $ref: "#/components/schemas/AgentProfileSummaryBusinessOverviewString" + description: The business overview for this profile. + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars associated with this profile. + deletionProtection: + $ref: "#/components/schemas/Boolean" + description: Indicates whether deletion protection is enabled for the profile. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role used for recommendation actions. + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + description: The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze. + arn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the optimization profile. + eligibleForScheduledGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for scheduled recommendation generation. + eligibleForArchitectureGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for manual architecture generation. + fieldErrors: + type: object + properties: {} + description: A map of field paths to error messages for invalid or missing input fields. + tags: + $ref: "#/components/schemas/Tags" + description: The tags associated with the profile. + createdBy: + $ref: "#/components/schemas/AgentProfileSummaryCreatedByString" + description: The identifier of the user or system that created this profile. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was created. + lastModifiedBy: + $ref: "#/components/schemas/AgentProfileSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this profile. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was last modified. + required: + - name + - pillars + - executionRoleArn + - aggregationConfiguration + - arn + - createdBy + - createdAt + AgentProfileSummaryNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + AgentProfileSummaryDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + AgentProfileSummaryDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + AgentProfileSummaryBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + AgentProfileSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + AgentProfileSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + ListAgentProfilesResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentRecommendationGenerationsRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentRecommendationGenerationsRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentRecommendationGenerationsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/AgentRecommendationGenerationSummaries" + description: A list of recommendation generation summaries. + nextToken: + $ref: "#/components/schemas/ListAgentRecommendationGenerationsResponseNextTokenString" + description: A pagination token to retrieve the next set of results, if available. + required: + - items_ + AgentRecommendationGenerationSummaries: + type: array + items: + $ref: "#/components/schemas/AgentRecommendationGenerationSummary" + AgentRecommendationGenerationSummary: + description: Summary of a recommendation generation process initiated through the agent API. + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the recommendation generation. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile used for this generation. + name: + $ref: "#/components/schemas/String" + description: The name of the recommendation generation. + status: + $ref: "#/components/schemas/GenerationStatus" + description: The current status of the recommendation generation. + estimatedCompletionTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The estimated time for the generation to complete. + createdBy: + $ref: "#/components/schemas/AgentRecommendationGenerationSummaryCreatedByString" + description: The identifier of the user or system that started this generation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was started. + lastModifiedBy: + $ref: "#/components/schemas/AgentRecommendationGenerationSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this generation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was last modified. + required: + - id + - profileArn + - status + - createdBy + - createdAt + AgentRecommendationGenerationSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationGenerationSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + ListAgentRecommendationGenerationsResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + RecommendationItemType: + type: string + enum: + - AWS_RESOURCE + - RECOMMENDATION + ListAgentRecommendationItemsRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentRecommendationItemsRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentRecommendationItemsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/AgentRecommendationItemSummaries" + description: A list of recommendation items with their detailed metadata and configuration information. + nextToken: + $ref: "#/components/schemas/ListAgentRecommendationItemsResponseNextTokenString" + description: A pagination token to retrieve the next set of results, if available. + required: + - items_ + AgentRecommendationItemSummaries: + type: array + items: + $ref: "#/components/schemas/AgentRecommendationItemSummary" + AgentRecommendationItemSummary: + description: Summary of an agent recommendation item, representing an Amazon Web Services resource or recommendation affected by the optimization recommendation. + type: object + properties: + id: + $ref: "#/components/schemas/String" + description: The unique identifier of the recommendation item. + recommendationArn: + $ref: "#/components/schemas/RecommendationArn" + description: The Amazon Resource Name (ARN) of the associated recommendation. + type_: + $ref: "#/components/schemas/RecommendationItemType" + description: The type of the recommendation item. + metadata: + $ref: "#/components/schemas/Document" + description: Metadata containing a snapshot of the resource or recommendation at the time of generation. + createdBy: + $ref: "#/components/schemas/AgentRecommendationItemSummaryCreatedByString" + description: The identifier of the user or system that created this recommendation item. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation item was created. + lastModifiedBy: + $ref: "#/components/schemas/AgentRecommendationItemSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this recommendation item. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation item was last modified. + required: + - id + - recommendationArn + - type_ + - metadata + - createdBy + - createdAt + AgentRecommendationItemSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationItemSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + ListAgentRecommendationItemsResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentRecommendationsRequestMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 1000 + ListAgentRecommendationsRequestNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAgentRecommendationsResponse: + type: object + properties: + items_: + $ref: "#/components/schemas/AgentRecommendationSummaries" + description: A list of recommendation summaries. + nextToken: + $ref: "#/components/schemas/ListAgentRecommendationsResponseNextTokenString" + description: A pagination token to retrieve the next set of results, if available. + required: + - items_ + AgentRecommendationSummaries: + type: array + items: + $ref: "#/components/schemas/AgentRecommendationSummary" + AgentRecommendationSummary: + description: Summary of an agent optimization recommendation returned by list operations. + type: object + properties: + recommendationArn: + $ref: "#/components/schemas/RecommendationArn" + description: The Amazon Resource Name (ARN) of the recommendation. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the associated profile. + title_: + $ref: "#/components/schemas/AgentRecommendationSummaryTitleString" + description: The title of the recommendation. + description: + $ref: "#/components/schemas/AgentRecommendationSummaryDescriptionString" + description: A description of the recommendation. + type_: + $ref: "#/components/schemas/RecommendationType" + description: The type of the recommendation. + pillar: + $ref: "#/components/schemas/Pillar" + description: The Well-Architected Tool Framework pillar that the recommendation addresses. + priority: + $ref: "#/components/schemas/Priority" + description: The priority of the recommendation. + effort: + $ref: "#/components/schemas/Effort" + description: The effort required to implement the recommendation. + status: + $ref: "#/components/schemas/RecommendationStatus" + description: The current status of the recommendation. + state: + $ref: "#/components/schemas/RecommendationState" + description: The current state of the recommendation. + updateReason: + $ref: "#/components/schemas/AgentRecommendationSummaryUpdateReasonString" + description: The free-text reason associated with the recommendation's most recent status update. + impact: + $ref: "#/components/schemas/ImpactCategory" + description: The severity of the recommendation's impact. + roi: + $ref: "#/components/schemas/Roi" + description: The return on investment estimate for the recommendation. + numberOfResources: + $ref: "#/components/schemas/Integer" + description: The number of Amazon Web Services resources this recommendation affects. + awsServices: + $ref: "#/components/schemas/StringList" + description: The Amazon Web Services services that the recommendation applies to. + businessUnits: + $ref: "#/components/schemas/StringList" + description: The business units that own the affected resources. + applications: + $ref: "#/components/schemas/StringList" + description: The applications that the recommendation targets. + createdBy: + $ref: "#/components/schemas/AgentRecommendationSummaryCreatedByString" + description: The identifier of the user or system that created this recommendation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation was created. + lastModifiedBy: + $ref: "#/components/schemas/AgentRecommendationSummaryLastModifiedByString" + description: The identifier of the user or system that last modified this recommendation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the recommendation was last modified. + required: + - recommendationArn + - profileArn + - title_ + - description + - type_ + - pillar + - priority + - effort + - status + - state + - impact + - roi + - createdBy + - createdAt + AgentRecommendationSummaryTitleString: + type: string + minLength: 3 + maxLength: 120 + AgentRecommendationSummaryDescriptionString: + type: string + minLength: 80 + maxLength: 500 + AgentRecommendationSummaryUpdateReasonString: + type: string + minLength: 1 + maxLength: 4096 + AgentRecommendationSummaryCreatedByString: + type: string + minLength: 1 + maxLength: 128 + AgentRecommendationSummaryLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + ListAgentRecommendationsResponseNextTokenString: + description: The token to use to retrieve the next set of results. + type: string + minLength: 1 + pattern: "[A-Za-z0-9+\\/=_-]+" + ListAnswersInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -3780,7 +6216,7 @@ components: enum: - PRIORITIZED - NON_PRIORITIZED - MaxResults: + ListCheckDetailsInputMaxResultsInteger: description: The maximum number of results to return for this request. type: integer minimum: 1 @@ -3835,6 +6271,7 @@ components: description: Reason associated to the check. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the check was last updated. CheckId: type: string CheckName: @@ -3864,6 +6301,11 @@ components: - ACCESS_DENIED - UNKNOWN_ERROR - PREMIUM_SUPPORT_REQUIRED + ListCheckSummariesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListCheckSummariesOutput: type: object properties: @@ -3894,6 +6336,7 @@ components: description: Trusted Advisor check description. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the check summary was last updated. LensArn: $ref: "#/components/schemas/LensArn" description: Well-Architected Lens ARN associated to the check. @@ -3910,7 +6353,8 @@ components: type: object properties: {} description: Account summary associated to the check. - ListLensReviewImprovementsMaxResults: + ListLensReviewImprovementsInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 100 @@ -3952,7 +6396,7 @@ components: $ref: "#/components/schemas/ImprovementPlanUrl" ImprovementPlans: $ref: "#/components/schemas/ChoiceImprovementPlans" - description: The improvement plan details. + description: The improvement plan details. This value is only applicable to custom lenses. JiraConfiguration: $ref: "#/components/schemas/JiraConfiguration" description: Configuration of the Jira integration. @@ -3961,7 +6405,7 @@ components: items: $ref: "#/components/schemas/ChoiceImprovementPlan" ChoiceImprovementPlan: - description: The choice level improvement plan. + description: The choice level improvement plan. This value is only applicable to custom lenses. type: object properties: ChoiceId: @@ -3971,6 +6415,11 @@ components: description: The display text for the improvement plan. ImprovementPlanUrl: $ref: "#/components/schemas/ImprovementPlanUrl" + ListLensReviewsInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListLensReviewsOutput: description: Output of a list lens reviews call. type: object @@ -4007,6 +6456,7 @@ components: description: The status of the lens. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the lens review was last updated. RiskCounts: type: object properties: {} @@ -4018,8 +6468,10 @@ components: properties: {} SharedWithPrefix: type: string + minLength: 0 maxLength: 100 - ListWorkloadSharesMaxResults: + ListLensSharesInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4060,6 +6512,11 @@ components: StatusMessage: $ref: "#/components/schemas/StatusMessage" description: Optional message to compliment the Status field. + ListLensesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 LensType: type: string enum: @@ -4097,8 +6554,10 @@ components: $ref: "#/components/schemas/LensDescription" CreatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the lens was created. UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the lens was last updated. LensVersion: $ref: "#/components/schemas/LensVersion" description: The version of the lens. @@ -4107,6 +6566,11 @@ components: LensStatus: $ref: "#/components/schemas/LensStatus" description: The status of the lens. + ListMilestonesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListMilestonesOutput: description: Output of a list milestones call. type: object @@ -4132,6 +6596,7 @@ components: $ref: "#/components/schemas/MilestoneName" RecordedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the milestone was recorded. WorkloadSummary: $ref: "#/components/schemas/WorkloadSummary" WorkloadSummary: @@ -4148,6 +6613,7 @@ components: $ref: "#/components/schemas/AwsAccountId" UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the workload was last updated. Lenses: $ref: "#/components/schemas/WorkloadLenses" RiskCounts: @@ -4161,7 +6627,8 @@ components: PrioritizedRiskCounts: type: object properties: {} - ListNotificationsMaxResults: + ListNotificationsInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4221,6 +6688,11 @@ components: description: ResourceArn of the lens being upgraded ResourceName: $ref: "#/components/schemas/WorkloadName" + ListProfileNotificationsInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListProfileNotificationsOutput: type: object properties: @@ -4261,7 +6733,8 @@ components: enum: - PROFILE_ANSWERS_UPDATED - PROFILE_DELETED - ListProfileSharesMaxResults: + ListProfileSharesInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4292,12 +6765,18 @@ components: description: Profile share invitation status message. ProfileNamePrefix: type: string + minLength: 0 maxLength: 100 ProfileOwnerType: type: string enum: - SELF - SHARED + ListProfilesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListProfilesOutput: type: object properties: @@ -4330,9 +6809,12 @@ components: $ref: "#/components/schemas/AwsAccountId" CreatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the profile was created. UpdatedAt: $ref: "#/components/schemas/Timestamp" - ListReviewTemplateAnswersMaxResults: + description: The date and time when the profile was last updated. + ListReviewTemplateAnswersInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4381,6 +6863,11 @@ components: QuestionType: $ref: "#/components/schemas/QuestionType" description: The type of question. + ListReviewTemplatesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListReviewTemplatesOutput: type: object properties: @@ -4407,6 +6894,7 @@ components: $ref: "#/components/schemas/AwsAccountId" UpdatedAt: $ref: "#/components/schemas/Timestamp" + description: The date and time when the review template was last updated. TemplateArn: $ref: "#/components/schemas/TemplateArn" description: The review template ARN. @@ -4419,9 +6907,11 @@ components: WorkloadNamePrefix: description: An optional string added to the beginning of each workload name returned in the results. type: string + minLength: 0 maxLength: 100 LensNamePrefix: type: string + minLength: 0 maxLength: 100 ShareResourceType: type: string @@ -4430,14 +6920,16 @@ components: - LENS - PROFILE - TEMPLATE - ListShareInvitationsMaxResults: + ListShareInvitationsInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 TemplateNamePrefix: type: string + minLength: 0 maxLength: 100 - pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ + pattern: "[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+" ListShareInvitationsOutput: description: Input for List Share Invitations type: object @@ -4495,7 +6987,8 @@ components: type: object properties: {} description: The tags for the resource. - ListTemplateSharesMaxResults: + ListTemplateSharesInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4527,6 +7020,11 @@ components: StatusMessage: $ref: "#/components/schemas/StatusMessage" description: Review template share invitation status message. + ListWorkloadSharesInputMaxResultsInteger: + description: The maximum number of results to return for this request. + type: integer + minimum: 1 + maximum: 50 ListWorkloadSharesOutput: description: Input for List Workload Share type: object @@ -4557,7 +7055,8 @@ components: StatusMessage: $ref: "#/components/schemas/StatusMessage" description: Optional message to compliment the Status field. - ListWorkloadsMaxResults: + ListWorkloadsInputMaxResultsInteger: + description: The maximum number of results to return for this request. type: integer minimum: 1 maximum: 50 @@ -4573,7 +7072,80 @@ components: description: A list of workload summaries. type: array items: - $ref: "#/components/schemas/WorkloadSummary" + $ref: "#/components/schemas/WorkloadSummary" + RecommendationFeedbackType: + type: string + enum: + - USEFUL + - NOT_USEFUL + FeedbackCategory: + type: string + enum: + - OTHER + - RECOMMENDATION_NOT_RELEVANT + - RESOURCE_NOT_IMPORTANT + - RESOURCE_TYPE_NOT_IMPORTANT + - RECOMMENDATION_INCORRECT + PutAgentRecommendationFeedbackRequestCommentsString: + type: string + minLength: 1 + maxLength: 4096 + pattern: "[\\P{C}]+" + PutAgentRecommendationFeedbackResponse: + type: object + RecommendationTypes: + type: array + items: + $ref: "#/components/schemas/RecommendationType" + StartAgentRecommendationGenerationRequestNameString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[A-Za-z0-9_-]+" + StartAgentRecommendationGenerationResponse: + type: object + properties: + id: + $ref: "#/components/schemas/UUID" + description: The unique identifier of the recommendation generation. + profileArn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the profile used for this generation. + name: + $ref: "#/components/schemas/String" + description: The name of the recommendation generation. + status: + $ref: "#/components/schemas/GenerationStatus" + description: The current status of the recommendation generation. + estimatedCompletionTime: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The estimated time for the generation to complete. + createdBy: + $ref: "#/components/schemas/StartAgentRecommendationGenerationResponseCreatedByString" + description: The identifier of the user or system that started this generation. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was started. + lastModifiedBy: + $ref: "#/components/schemas/StartAgentRecommendationGenerationResponseLastModifiedByString" + description: The identifier of the user or system that last modified this generation. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the generation was last modified. + required: + - id + - profileArn + - status + - createdBy + - createdAt + StartAgentRecommendationGenerationResponseCreatedByString: + type: string + minLength: 1 + maxLength: 128 + StartAgentRecommendationGenerationResponseLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 TagResourceOutput: type: object TagKeyList: @@ -4584,8 +7156,167 @@ components: type: string minLength: 1 maxLength: 128 + pattern: (?!aws:)[\p{L}\p{N}\p{Z}_.:/=+@-]+ UntagResourceOutput: type: object + UpdateAgentContextRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + UpdateAgentContextRequestTitleString: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + UpdateAgentContextResponse: + type: object + properties: + context: + $ref: "#/components/schemas/ContextSummary" + description: The updated context summary. + required: + - context + UpdateAgentGoalRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + UpdateAgentGoalRequestTitleString: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + UpdateAgentGoalRequestDescriptionString: + type: string + minLength: 1 + maxLength: 4000 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + UpdateAgentGoalResponse: + type: object + properties: + goal: + $ref: "#/components/schemas/GoalSummary" + description: The updated goal summary. + required: + - goal + UpdateAgentProfileRequestClientTokenString: + type: string + minLength: 1 + maxLength: 128 + pattern: "[\\x21-\\x7E]+" + UpdateAgentProfileRequestDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + UpdateAgentProfileRequestDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + UpdateAgentProfileRequestBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + UpdateAgentProfileResponse: + type: object + properties: + name: + $ref: "#/components/schemas/UpdateAgentProfileResponseNameString" + description: The system name of the updated profile. + displayName: + $ref: "#/components/schemas/UpdateAgentProfileResponseDisplayNameString" + description: The display name of the updated profile. + description: + $ref: "#/components/schemas/UpdateAgentProfileResponseDescriptionString" + description: A description of the updated profile. + businessOverview: + $ref: "#/components/schemas/UpdateAgentProfileResponseBusinessOverviewString" + description: The business overview of the updated profile. + pillars: + $ref: "#/components/schemas/Pillars" + description: The Well-Architected Tool Framework pillars associated with the updated profile. + deletionProtection: + $ref: "#/components/schemas/Boolean" + description: Indicates whether deletion protection is enabled. + executionRoleArn: + $ref: "#/components/schemas/RoleArn" + description: The ARN of the IAM execution role. + aggregationConfiguration: + $ref: "#/components/schemas/AggregationConfigurations" + description: The aggregation configuration. + arn: + $ref: "#/components/schemas/AgentProfileArn" + description: The Amazon Resource Name (ARN) of the updated profile. + eligibleForScheduledGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for scheduled recommendation generation. + eligibleForArchitectureGeneration: + $ref: "#/components/schemas/Boolean" + description: Indicates whether the profile is valid for manual architecture generation. + fieldErrors: + type: object + properties: {} + description: A map of field paths to error messages for invalid or missing input fields. + tags: + $ref: "#/components/schemas/Tags" + description: The tags associated with the updated profile. + createdBy: + $ref: "#/components/schemas/UpdateAgentProfileResponseCreatedByString" + description: The identifier of the user or system that created this profile. + createdAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was created. + lastModifiedBy: + $ref: "#/components/schemas/UpdateAgentProfileResponseLastModifiedByString" + description: The identifier of the user or system that last modified this profile. + lastModifiedAt: + $ref: "#/components/schemas/SyntheticTimestamp_date_time" + description: The timestamp when the profile was last modified. + required: + - name + - pillars + - executionRoleArn + - aggregationConfiguration + - arn + - createdBy + - createdAt + UpdateAgentProfileResponseNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: "[a-zA-Z0-9_-]+" + UpdateAgentProfileResponseDisplayNameString: + type: string + minLength: 3 + maxLength: 128 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])+ + UpdateAgentProfileResponseDescriptionString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + UpdateAgentProfileResponseBusinessOverviewString: + type: string + minLength: 0 + maxLength: 512 + pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}])* + UpdateAgentProfileResponseCreatedByString: + type: string + minLength: 1 + maxLength: 128 + UpdateAgentProfileResponseLastModifiedByString: + type: string + minLength: 1 + maxLength: 128 + UpdateAgentRecommendationStatusRequestUpdateReasonString: + type: string + minLength: 1 + maxLength: 4096 + UpdateAgentRecommendationStatusResponse: + type: object ChoiceUpdates: type: object properties: {} @@ -4864,6 +7595,206 @@ components: - $ref: "#/components/x-stackQL-resources/profiles/methods/update_profile" delete: - $ref: "#/components/x-stackQL-resources/profiles/methods/delete_profile" + agent_contexts: + id: aws.wellarchitected.agent_contexts + name: agent_contexts + title: agent_contexts + methods: + create_agent_context: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1contexts/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_agent_contexts: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1contexts/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_agent_context: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1contexts~1{id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_agent_context: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1contexts~1{id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.context + update_agent_context: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1contexts~1{id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_contexts/methods/get_agent_context" + - $ref: "#/components/x-stackQL-resources/agent_contexts/methods/list_agent_contexts" + insert: + - $ref: "#/components/x-stackQL-resources/agent_contexts/methods/create_agent_context" + update: + - $ref: "#/components/x-stackQL-resources/agent_contexts/methods/update_agent_context" + delete: + - $ref: "#/components/x-stackQL-resources/agent_contexts/methods/delete_agent_context" + agent_goals: + id: aws.wellarchitected.agent_goals + name: agent_goals + title: agent_goals + methods: + create_agent_goal: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1goals/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_agent_goals: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1goals/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_agent_goal: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1goals~1{id}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_agent_goal: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1goals~1{id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.goal + update_agent_goal: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1goals~1{id}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_goals/methods/get_agent_goal" + - $ref: "#/components/x-stackQL-resources/agent_goals/methods/list_agent_goals" + insert: + - $ref: "#/components/x-stackQL-resources/agent_goals/methods/create_agent_goal" + update: + - $ref: "#/components/x-stackQL-resources/agent_goals/methods/update_agent_goal" + delete: + - $ref: "#/components/x-stackQL-resources/agent_goals/methods/delete_agent_goal" + agent_profiles: + id: aws.wellarchitected.agent_profiles + name: agent_profiles + title: agent_profiles + methods: + create_agent_profile: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_agent_profiles: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + delete_agent_profile: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}/delete" + response: + openAPIDocKey: "200" + mediaType: application/json + get_agent_profile: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + update_agent_profile: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_profiles/methods/get_agent_profile" + - $ref: "#/components/x-stackQL-resources/agent_profiles/methods/list_agent_profiles" + insert: + - $ref: "#/components/x-stackQL-resources/agent_profiles/methods/create_agent_profile" + update: + - $ref: "#/components/x-stackQL-resources/agent_profiles/methods/update_agent_profile" + delete: + - $ref: "#/components/x-stackQL-resources/agent_profiles/methods/delete_agent_profile" lens_shares: id: aws.wellarchitected.lens_shares name: lens_shares @@ -5282,6 +8213,114 @@ components: - $ref: "#/components/x-stackQL-resources/workload_shares/methods/update_workload_share" delete: - $ref: "#/components/x-stackQL-resources/workload_shares/methods/delete_workload_share" + agent_recommendations: + id: aws.wellarchitected.agent_recommendations + name: agent_recommendations + title: agent_recommendations + methods: + get_agent_recommendation: + operation: + $ref: "#/paths/~1api~1v1~1agent-recommendations~1{recommendation_arn}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + start_agent_recommendation_generation: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1generations/post" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + list_agent_recommendations: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1recommendations/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + put_agent_recommendation_feedback: + operation: + $ref: "#/paths/~1api~1v1~1agent-recommendations~1{recommendation_arn}~1feedback/put" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + update_agent_recommendation_status: + operation: + $ref: "#/paths/~1api~1v1~1agent-recommendations~1{recommendation_arn}~1status/patch" + response: + openAPIDocKey: "200" + mediaType: application/json + request: + nativeCasing: pascal + config: + requestBodyTranslate: + algorithm: naive + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_recommendations/methods/get_agent_recommendation" + - $ref: "#/components/x-stackQL-resources/agent_recommendations/methods/list_agent_recommendations" + insert: [] + update: + - $ref: "#/components/x-stackQL-resources/agent_recommendations/methods/update_agent_recommendation_status" + replace: + - $ref: "#/components/x-stackQL-resources/agent_recommendations/methods/put_agent_recommendation_feedback" + delete: [] + agent_recommendation_generations: + id: aws.wellarchitected.agent_recommendation_generations + name: agent_recommendation_generations + title: agent_recommendation_generations + methods: + get_agent_recommendation_generation: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1generations~1{generation_id}/get" + response: + openAPIDocKey: "200" + mediaType: application/json + list_agent_recommendation_generations: + operation: + $ref: "#/paths/~1api~1v1~1agent-profiles~1{profile_arn}~1generations/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: NextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_recommendation_generations/methods/get_agent_recommendation_generation" + - $ref: "#/components/x-stackQL-resources/agent_recommendation_generations/methods/list_agent_recommendation_generations" + insert: [] + update: [] + delete: [] answers: id: aws.wellarchitected.answers name: answers @@ -5532,6 +8571,34 @@ components: update: - $ref: "#/components/x-stackQL-resources/review_template_lens_reviews/methods/update_review_template_lens_review" delete: [] + agent_recommendation_items: + id: aws.wellarchitected.agent_recommendation_items + name: agent_recommendation_items + title: agent_recommendation_items + methods: + list_agent_recommendation_items: + operation: + $ref: "#/paths/~1api~1v1~1agent-recommendations~1{recommendation_arn}~1items/get" + response: + openAPIDocKey: "200" + mediaType: application/json + objectKey: $.items_ + request: + nativeCasing: pascal + config: + pagination: + requestToken: + key: nextToken + location: query + responseToken: + key: $.nextToken + location: body + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/agent_recommendation_items/methods/list_agent_recommendation_items" + insert: [] + update: [] + delete: [] check_details: id: aws.wellarchitected.check_details name: check_details @@ -5624,7 +8691,7 @@ components: methods: list_profile_notifications: operation: - $ref: "#/paths/~1profileNotifications~1/get" + $ref: "#/paths/~1profileNotifications/get" response: openAPIDocKey: "200" mediaType: application/json diff --git a/providers/src/aws/v00.00.00000/services/wickr.yaml b/providers/src/aws/v00.00.00000/services/wickr.yaml index 80e9df52..e4b45c2a 100644 --- a/providers/src/aws/v00.00.00000/services/wickr.yaml +++ b/providers/src/aws/v00.00.00000/services/wickr.yaml @@ -2131,6 +2131,9 @@ components: ssoMaxIdleMinutes: $ref: "#/components/schemas/Integer" description: The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network. + maxNonSsoSessionMinutes: + $ref: "#/components/schemas/SecurityGroupSettingsMaxNonSsoSessionMinutesInteger" + description: Maximum session duration in minutes for non-SSO users. Set to 0 to disable. Valid range is 60 to 525600 (1 hour to 365 days). federationMode: $ref: "#/components/schemas/Integer" description: "The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted)." @@ -2186,7 +2189,7 @@ components: $ref: "#/components/schemas/Integer" description: The minimum number of uppercase letters required in passwords. ShredderSettings: - description: Configuration for the message shredder feature, which securely deletes messages and files from devices to prevent data recovery. + description: Configuration for the Wickr shredder feature, which writes random data over free memory and disk space on client devices. You can configure your Wickr shredder intensity using the parameters below. Secure Shredder will not write over files that are permanently stored on the device or saved outside of the Wickr client. Wickr Network Administrators are able to disable file downloads within Security Group Settings. type: object properties: canProcessManually: @@ -2194,7 +2197,11 @@ components: description: Specifies whether users can manually trigger the shredder to delete content. intensity: $ref: "#/components/schemas/Integer" - description: "Prevents Wickr data from being recovered by overwriting deleted Wickr data. Valid Values: Must be one of [0, 20, 60, 100]" + description: "Controls the rate (MB/minute) at which the shredder function runs on clients. Valid Values: Must be one of [0, 20, 60, 100]. A higher intensity setting could lead to higher battery usage on mobile devices." + SecurityGroupSettingsMaxNonSsoSessionMinutesInteger: + type: integer + minimum: 0 + maximum: 525600 DeleteBotResponse: type: object properties: @@ -2973,6 +2980,9 @@ components: enableTrustedDataFormat: $ref: "#/components/schemas/Boolean" description: Configuration for OpenTDF integration at the network level, enforcing ABAC decision making when operating in TDF enabled rooms. + consentPopup: + $ref: "#/components/schemas/ConsentPopupConfig" + description: Consent popup configuration for the network, displayed to users on login. ReadReceiptConfig: description: Configuration for read receipts at the network level, controlling whether senders can see when their messages have been read. type: object @@ -2986,6 +2996,39 @@ components: - DISABLED - ENABLED - FORCE_ENABLED + ConsentPopupConfig: + description: Consent popup configuration displayed to users on login. + type: object + properties: + enabled: + $ref: "#/components/schemas/Boolean" + description: Whether the consent popup is enabled. When set to true, the popup is displayed to users on login. + header: + $ref: "#/components/schemas/ConsentPopupConfigHeaderString" + description: Header text displayed at the top of the consent popup. Maximum 100 characters. + content: + $ref: "#/components/schemas/ConsentPopupConfigContentString" + description: Body content of the consent popup in Markdown format. Maximum 5000 characters. + closeButtonLabel: + $ref: "#/components/schemas/ConsentPopupConfigCloseButtonLabelString" + description: Label for the close button on the consent popup. Maximum 20 characters. Defaults to "Acknowledge" if not provided. + required: + - enabled + ConsentPopupConfigHeaderString: + type: string + minLength: 0 + maxLength: 100 + pattern: "[\\S\\s]*" + ConsentPopupConfigContentString: + type: string + minLength: 0 + maxLength: 5000 + pattern: "[\\S\\s]*" + ConsentPopupConfigCloseButtonLabelString: + type: string + minLength: 0 + maxLength: 20 + pattern: "[\\S\\s]*" UpdateNetworkSettingsResponse: type: object properties: diff --git a/providers/src/aws/v00.00.00000/services/workdocs.yaml b/providers/src/aws/v00.00.00000/services/workdocs.yaml index a965fd08..e03d9a8f 100644 --- a/providers/src/aws/v00.00.00000/services/workdocs.yaml +++ b/providers/src/aws/v00.00.00000/services/workdocs.yaml @@ -1534,7 +1534,7 @@ paths: required: false schema: $ref: "#/components/schemas/AuthenticationHeaderType" - description: Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. + description: WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. requestBody: required: false content: diff --git a/providers/src/aws/v00.00.00000/services/workspaces.yaml b/providers/src/aws/v00.00.00000/services/workspaces.yaml index 9eec95ba..4f4b9c50 100644 --- a/providers/src/aws/v00.00.00000/services/workspaces.yaml +++ b/providers/src/aws/v00.00.00000/services/workspaces.yaml @@ -288,7 +288,7 @@ paths: /CreateConnectClientAddIn: post: operationId: CreateConnectClientAddIn - description: Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect. + description: Creates a client-add-in for Connect Customer within a directory. You can create only one Connect Customer client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Connect Customer. parameters: - name: X-Amz-Target in: header @@ -314,7 +314,7 @@ paths: description: The name of the client add-in. URL: $ref: "#/components/schemas/AddInUrl" - description: The endpoint URL of the Amazon Connect client add-in. + description: The endpoint URL of the Connect Customer client add-in. required: - ResourceId - Name @@ -650,7 +650,7 @@ paths: /CreateWorkspacesPool: post: operationId: CreateWorkspacesPool - description: Creates a pool of WorkSpaces. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Creates a pool of WorkSpaces." parameters: - name: X-Amz-Target in: header @@ -784,7 +784,7 @@ paths: /DeleteConnectClientAddIn: post: operationId: DeleteConnectClientAddIn - description: Deletes a client-add-in for Amazon Connect that is configured within a directory. + description: Deletes a client-add-in for Connect Customer that is configured within a directory. parameters: - name: X-Amz-Target in: header @@ -1310,7 +1310,7 @@ paths: /DescribeConnectClientAddIns: post: operationId: DescribeConnectClientAddIns - description: Retrieves a list of Amazon Connect client add-ins that have been created. + description: Retrieves a list of Connect Customer client add-ins that have been created. parameters: - name: X-Amz-Target in: header @@ -1880,7 +1880,7 @@ paths: /DescribeWorkspacesPoolSessions: post: operationId: DescribeWorkspacesPoolSessions - description: Retrieves a list that describes the streaming sessions for a specified pool. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Retrieves a list that describes the streaming sessions for a specified pool." parameters: - name: X-Amz-Target in: header @@ -1922,7 +1922,7 @@ paths: /DescribeWorkspacesPools: post: operationId: DescribeWorkspacesPools - description: Describes the specified WorkSpaces Pools. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Describes the specified WorkSpaces Pools." parameters: - name: X-Amz-Target in: header @@ -2345,7 +2345,7 @@ paths: /MigrateWorkspace: post: operationId: MigrateWorkspace - description: Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace. + description: Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace. If the source WorkSpace has nested virtualization enabled and the target bundle does not support nested virtualization, the migration fails. parameters: - name: X-Amz-Target in: header @@ -3060,7 +3060,7 @@ paths: /StartWorkspacesPool: post: operationId: StartWorkspacesPool - description: Starts the specified pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Starts the specified pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED." parameters: - name: X-Amz-Target in: header @@ -3126,7 +3126,7 @@ paths: /StopWorkspacesPool: post: operationId: StopWorkspacesPool - description: Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR." parameters: - name: X-Amz-Target in: header @@ -3192,7 +3192,7 @@ paths: /TerminateWorkspacesPool: post: operationId: TerminateWorkspacesPool - description: Terminates the specified pool. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Terminates the specified pool." parameters: - name: X-Amz-Target in: header @@ -3225,7 +3225,7 @@ paths: /TerminateWorkspacesPoolSession: post: operationId: TerminateWorkspacesPoolSession - description: Terminates the pool session. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Terminates the pool session." parameters: - name: X-Amz-Target in: header @@ -3258,7 +3258,7 @@ paths: /UpdateConnectClientAddIn: post: operationId: UpdateConnectClientAddIn - description: Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in. + description: Updates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in. parameters: - name: X-Amz-Target in: header @@ -3287,7 +3287,7 @@ paths: description: The name of the client add-in. URL: $ref: "#/components/schemas/AddInUrl" - description: The endpoint URL of the Amazon Connect client add-in. + description: The endpoint URL of the Connect Customer client add-in. required: - AddInId - ResourceId @@ -3450,7 +3450,7 @@ paths: /UpdateWorkspacesPool: post: operationId: UpdateWorkspacesPool - description: Updates the specified pool. + description: "End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Updates the specified pool." parameters: - name: X-Amz-Target in: header @@ -4164,13 +4164,16 @@ components: description: The compute type. For more information, see Amazon WorkSpaces Bundles. Protocols: $ref: "#/components/schemas/ProtocolList" - description: The protocol. For more information, see Protocols for Amazon WorkSpaces. Only available for WorkSpaces created with PCoIP bundles. The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP). Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn). + description: The protocol. For more information, see Protocols for Amazon WorkSpaces. Only available for WorkSpaces created with PCoIP bundles. The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP). Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn, and Graphics.g6). OperatingSystemName: $ref: "#/components/schemas/OperatingSystemName" description: The name of the operating system. GlobalAccelerator: $ref: "#/components/schemas/GlobalAcceleratorForWorkSpace" description: Indicates the Global Accelerator properties. + NestedVirtualizationEnabled: + $ref: "#/components/schemas/BooleanObject" + description: Specifies whether nested virtualization is enabled for the WorkSpace. For more information, see Nested virtualization for Amazon WorkSpaces. RunningMode: type: string enum: @@ -4354,7 +4357,7 @@ components: properties: Resource: $ref: "#/components/schemas/ModificationResourceEnum" - description: The resource. + description: The WorkSpace property being modified. State: $ref: "#/components/schemas/ModificationStateEnum" description: The modification state. @@ -4365,6 +4368,7 @@ components: - USER_VOLUME - COMPUTE_TYPE - PROTOCOL + - NESTED_VIRTUALIZATION ModificationStateEnum: type: string enum: @@ -5086,6 +5090,9 @@ components: LogUploadEnabled: $ref: "#/components/schemas/LogUploadEnum" description: Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory. + ClientExperiencePolicy: + $ref: "#/components/schemas/ClientExperiencePolicy" + description: The client experience policy that determines which client experience the user sees. Administrators can set this policy to control the client experience for users in a directory. Valid values include FORCE_CLASSIC, FORCE_UI_2026, and USER_CHOICE. ReconnectEnum: type: string enum: @@ -5096,6 +5103,10 @@ components: enum: - ENABLED - DISABLED + ClientExperiencePolicy: + type: string + maxLength: 64 + pattern: ^[A-Z_0-9]+$ DescribeConnectClientAddInsResult: type: object properties: @@ -5110,7 +5121,7 @@ components: items: $ref: "#/components/schemas/ConnectClientAddIn" ConnectClientAddIn: - description: Describes an Amazon Connect client add-in. + description: Describes an Connect Customer client add-in. type: object properties: AddInId: diff --git a/providers/src/aws/v00.00.00000/services/workspaces_instances.yaml b/providers/src/aws/v00.00.00000/services/workspaces_instances.yaml index e8429179..08b8559b 100644 --- a/providers/src/aws/v00.00.00000/services/workspaces_instances.yaml +++ b/providers/src/aws/v00.00.00000/services/workspaces_instances.yaml @@ -585,6 +585,7 @@ components: type: string minLength: 1 maxLength: 64 + pattern: "[\\x20-\\x7E]+" Boolean: type: boolean NonNegativeInteger: @@ -945,6 +946,8 @@ components: format: date-time InstanceType: type: string + minLength: 1 + maxLength: 64 pattern: ([a-z0-9-]+)\.([a-z0-9]+) Ipv6Addresses: type: array